yetangitu/photo-front
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity

Updating docs to point to theopenphotoproject.org

Browse source
This commit is contained in:
Jaisen Mathai 2011-12-03 20:03:07 -08:00
parent e2a95a4989
commit dedfe920b1
6 changed files with 86 additions and 129 deletions
Download patch file Download diff file Expand all files Collapse all files

9
documentation/faq/Faq.markdown
View file

@ -1,6 +1,6 @@
Documentation
Frequently asked questions
=======================
#### OpenPhoto, a photo service for the masses
This is a list of common questions that people have about OpenPhoto.
If you have one which is not on this list send us a message via <a href="http://twitter.com/openphoto">Twitter</a> or <a href="mailto:hello@openphoto.me">email</a>.
@ -55,13 +55,10 @@ It depends on who you use but here are some guidelines.
### When will the OpenPhoto software be completed?
You can set up the OpenPhoto software using [any of the guides][guides].
You can set up the OpenPhoto software using guides.
----------------------------------------
### When will the hosted version of OpenPhoto be available?
We are aiming to have it ready by the end of November (2011).
[guides]: ../guides/Guides.markdown

13
documentation/faq/PhotoGeneration.markdown
View file

@ -1,14 +1,11 @@
Open Photo API / Photo Upload
How photos are generated
=======================
#### OpenPhoto, a photo service for the masses
----------------------------------------
### Overview of how and when versions of photos are generated
By default, when a photo is uploaded there are two versions of that photo which are stored. The original version (`pathOriginal`) and a slightly lower resolution version (`pathBase`).
The API is capable of returning URLs for any size version of every photo. This is acheived by passing in a parameter named `returnSizes` to the [GET Photos][GetPhotos] and [GET Photo][GetPhoto] APIs. This ensures that the response for the photo(s) will include a URL for the size(s) you specify. Here is an example.
The API is capable of returning URLs for any size version of every photo. This is acheived by passing in a parameter named `returnSizes` to the [GET Photos](http://theopenphotoproject.org/documentation/api/GetPhotos) and [GET Photo](http://theopenphotoproject.org/documentation/api/GetPhoto) APIs. This ensures that the response for the photo(s) will include a URL for the size(s) you specify. Here is an example.
curl "http://current.openphoto.me/photo/63.json?returnSizes=123x123"
@ -106,8 +103,4 @@ The `returnSizes` parameter takes values in the form of _WxH[[xA]xB]_ which mean
Additional options include `CR` and `BW`. `CR` tells the API to crop the photo to be exactly _width_ by _height_. It does a center crop and minimizes the portion of the photo that is cropped. `BW` applies a greyscale filter to the photo. `100x100xCRxBW` means the photo will have a key of `path100x100xCRxBW` and will be exactly _100_ by _100_, cropped and greyscale.
For more information on the `returnSizes` parameter see our [documentation on returnSizes][ReturnSizes].
[GetPhotos]: ../api/GetPhotos.markdown
[GetPhoto]: ../api/GetPhoto.markdown
[ReturnSizes]: ../faq/ReturnSizes.markdown
For more information on the `returnSizes` parameter see our [documentation on returnSizes](http://theopenphotoproject.org/documentation/faq/ReturnSizes).

13
documentation/faq/ReturnSizes.markdown
View file

@ -1,14 +1,11 @@
Open Photo API / Photo Upload
Getting specific sizes of a photo
=======================
#### OpenPhoto, a photo service for the masses
----------------------------------------
### Understanding the `returnSizes` parameter and how to use it
For the [GET /photo/view.json][GetPhoto] and [GET /photos/list.json][GetPhotos] you can pass in an optional `returnSizes` parameter.
For the [GET /photo/view.json](http://theopenphotoproject.org/documentation/api/GetPhoto) and [GET /photos/list.json](http://theopenphotoproject.org/documentation/api/GetPhotos) you can pass in an optional `returnSizes` parameter.
If you need a path to a photo then you'll want to make sure you pass this parameter in else your response won't contain any URLs.
We also have a more detailed look at how [photos are generated][photogeneration].
We also have a more detailed look at how [photos are generated](http://theopenphotoproject.org/documentation/faq/PhotoGeneration).
### Specifying the width and height of photos you want
The first decision you need to make is the size or sizes of photos you want in the response.
@ -35,7 +32,3 @@ Adding `xCR` means that the photo will be exactly _200px_ by _200px_ and cropped
### Accessing the paths in the response
The name of the URL attribute in the response is, by convention, `pathWxH` where `WxH` is the value passed in to returnSizes.
[GetPhoto]: ../api/GetPhoto.markdown
[GetPhotos]: ../api/GetPhotos.markdown
[photogeneration]: ../faq/PhotoGeneration.markdown