Talk:Tutorials

From MapbenderWiki

Contents 1 Concept for the documentation 1.1 mandatory 1.2 nice to have 1.3 status 1.4 which are the possible solutions 1.5 documentation roadmap 1.6 todos

Concept for the documentation

mandatory

• versioned JavaScript/PHP documentation.
• CB suggests focusing on documenting application elements of potentially new template applications (layout, openlayers)
• documentation shall be autogenerated by CI-server and shall be included in every release
• english language only

nice to have

• user documentation pdf / html
• technical documentation pdf/html
• modul documentation
• possiblity to add new languages easily - like es
• translation of the applications (map/administration)
• still provide wiki editing for normal mapbender user which have no svn commit rights

status

• module description in the wiki (not complete, not actual) en (de)
  • http://www.mapbender.org/Category:Modules

• module tech. doc in the NatualDoc documentation en
  • this documentation is compiled from the comments in the code
  • is there a way to export this doc to pdf? --> see http://www.naturaldocs.org/documentation/html/files/Modules/NaturalDocs/Builder/Base-pm.html
  • https://svn.osgeo.org/mapbender/trunk/mapbender/documents/api_js/index.html

• Mapbender User Documenation 2.6 only de
  • http://trac.osgeo.org/mapbender/browser/trunk/documents/documentation/Dokumentation_mapbender26_de.pdf?format=raw

• Mapbender User documentation in the wiki (tutorial and links) not complete and not actual en/de
  • http://www.mapbender.org/Mapbender_Tutorial_en
  • http://www.mapbender.org/Mapbender_Tutorial_de

• Quickstart for OSGeoLive DVD 4.0 rst. (export to pdf or html) en
  • translation to other languages is planned from the OSGeoLive DVD project - next version March 2011
  • http://live.osgeo.org/quickstart/mapbender_quickstart.html
  • sources: https://svn.osgeo.org/osgeo/livedvd/gisvm/trunk/doc/en/quickstart/mapbender_quickstart.rst

• Workshop material from FOSS4G rst. (export to pdf or html) en
  • extended version of the LiveDVD Quickstart. Could be a good basis for a documentation with rst
  • http://live.osgeo.org/quickstart/mapbender_quickstart.html
  • sources: https://svn.osgeo.org/mapbender/trunk/documents/presentations/FOSS4G2010/hands_on/mapbender_quickstart.rst

translation of the template applications

1. the map applications use i18n and most of them are in english with the possibility to use them in other languages via Mapbender.po/ table translations
2. the administration templates are in english/german (admin2_en, admin2_de)
   1. the content of the administration modules is in english and not translated yet. the modules are not prepared for i18n yet.

which are the possible solutions

• wiki / rst / natual doc - how bring them together?

1. solution should offer a html and pdf-version
2. should be easy to transfer to other languages

documentation roadmap

todos