Prose Documentation

How to Add

The process for adding content to the  http://docs.openlayers.org page is very simple. You need only to have svn trunk commit access, and to add a few files. The page itself is updated every ~10 minutes automatically, so add a little patience into the mix and you're ready to roll.

Original Work

To add a new tutorial, presentation, workshop, etc. to the docs page, you must follow these steps:

  • Create a new directory here: http://svn.openlayers.org/trunk/doc/ . For the purpose of illustration, let's call this 'my_project'.
  • Inside http://svn.openlayers.org/trunk/doc/my_project, add an about.rst file with a brief description of the presentation, workshop, etc.
  • Also inside the new directory, add a file named my_project.rst, which will contain the actual rst content of your project.

To add a link to a presentation that is hosted elsewhere, you need only to add two files to http://svn.openlayers.org/trunk/doc/links/ :

  • mynewlink.url: the url link to the documentation (and nothing else)
  • mynewlink.rst: the rst for the description of the link. The file should consist of a title, followed by a line of +'s (one for each character in the title), followed by a blank line and then a description. Example: 
    My Exciting Tutorial
++++++++++++++++++++++++++++++++++++++++++++

In this tutorial you will find out how to blah blah blah 
blah blah blah.

How to translate a file?

For anything that's already in SVN, you have to create a copy of the doc, and put '.lang-code.rst' as the extension. (So, spherical_mercator.fr.rst.) If you don't have trunk SVN access, you can add these as patches, or put them into a sandbox and someone have to merge in from there.