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

Merge 5ee0991279 into b8cd58ca14

Browse source
This commit is contained in:
Sujin/Sushi 2013-07-22 15:59:48 -07:00
commit 83520f288f
3 changed files with 37 additions and 8 deletions
Download patch file Download diff file Expand all files Collapse all files

4
README.md
View file

@ -1,6 +1,6 @@
Documentation Documentation
============= =============
This repository contains the documentation for the various Photo Project repositories. You can contribute to it by forking this repository, writing, and submitting a pull request. More info is in the contribute/documentation.markdown file. You can also file documentation-related issues in our issue tracker. This repository contains the documentation for the various Photo Project repositories. You can contribute to it by forking this repository, writing, and submitting a pull request. More info is in the docs/contribute/documentation.markdown file. You can also file documentation-related issues in our issue tracker.
All the documentation is organized by area within subfolders of the /docs/ folder. A lot of this is (or will be) mirrored on http://www.theopenphotoproject.org. All the documentation is organized by area within subfolders of the /docs/ folder. A lot of this is (or will be) mirrored on http://www.theopenphotoproject.org.
@ -10,3 +10,5 @@ Big picture TODO
* Checking the guides for correctness and finishing the Shared Hosting guide * Checking the guides for correctness and finishing the Shared Hosting guide
* Documenting other repositories that aren't well-documented such as the mobile apps * Documenting other repositories that aren't well-documented such as the mobile apps
* Manual of Style? * Manual of Style?
Questions? Email the mailing list at openphoto@googlegroups.com or ask in #openphoto on Freenode's IRC server.

34
docs/Readme.markdown
View file

@ -1,8 +1,34 @@
OpenPhoto / Documentation Trovebox / Documentation
======================= =======================
You can find the documentation at http://theopenphotoproject.org/documentation. It's a mirror of what is here but easier to follow. Whether you’re looking to install Trovebox yourself or build something with our API, you’re in the right place.
If you'd like to contribute to the documentation, please do! We welcome any and all contributions. Fork this repository (documentation) and add your contribution, then send a pull request. The docs/contribute/documentation.markdown in this repository explains everything you need to more. ### What you’ll find here
Questions? We're here to help. Email our mailing list at openphoto@googlegroups.com or ask in #openphoto on Freenode. #### Guides
Our guides walk you through installing Trovebox Community Edition.
#### API
The Trovebox API makes it easy for you to read and write data from your Trovebox site as well as creating Trovebox clients.
#### Libraries
Trovebox’s language libraries make getting started with our API even easier. Download one of our language libraries, get to know it by reading its documentation, and start hacking.
#### Plugins
Trovebox comes with a set of plugins you can enable. The plugins section will eventually provide documentation for these plugins as well as how to write your own. Bug someone to write this.
### Contributing
The main Trovebox code is released under an open source license, so you can fork the code, install it yourself, and modify the code. If you’re interested in contributing your modified code back to our codebase, our contributors section tells you everything you need to know.
### Found a bug?
We track our bugs in Github, and we welcome all bug reports, no matter how small.
### Questions?
If you have any questions, we’re here to help. Email our mailing list at openphoto@googlegroups.com or ask in #openphoto on Freenode.

7
docs/faq/PhotoSharing.markdown
View file

@ -5,7 +5,10 @@ Photo Sharing
You can share a photo by clicking the arrow button at the photo's page or in the gallery. You'll then see the options to share the photo. You can share a photo by clicking the arrow button at the photo's page or in the gallery. You'll then see the options to share the photo.
## Where can I share a photo to? ## Where can I share a photo to?
Right now we support sharing via email, Facebook, or Twitter. We want to add more sites, so let us know where you want to share your photos. Right now we support sharing via HTML embeds, email, Facebook, or Twitter. We want to add more sites, so let us know where you want to share your photos.
## How do I share a photo's link via HTML?
Yes. When viewing a photo, click the Share arrow and select the 'Embed in Blog' button. A box will appear with the HTML you can use to embed the photo in your blog, forums, or anywhere else. Copy this HTML, then paste it to wherever you'd like.
## How do I share a private photo? ## How do I share a private photo?
You can share a private photo in the same way that you'd share a public photo. When you share a private item, a sharing token gets added to the photo URL. The recipient can then use the full URL to view the photo without You can share a private photo in the same way that you'd share a public photo. When you share a private item, a sharing token gets added to the photo URL. The recipient can then use the full URL to view the photo without
@ -28,5 +31,3 @@ In the Sharing Tokens section of your settings, find the photo ID of the photo w
Don't know where the photo ID is? Look at the photo's URL. The URL looks like yourusername.trovebox.com/p/PhotoID, where PhotoID is the photo ID. The Photo ID does not include the sharing token in the URL. Don't know where the photo ID is? Look at the photo's URL. The URL looks like yourusername.trovebox.com/p/PhotoID, where PhotoID is the photo ID. The Photo ID does not include the sharing token in the URL.
## Can I share a photo's link via HTML?
Not yet, but this is a very popular request. We're working on this.