Changes between Version 2 and Version 3 of the_docs_strikes_back


Ignore:
Timestamp:
10 Apr 2018 12:17:18 (19 months ago)
Author:
cvvergara
Comment:

adding a sketch of the documentation for an overview part 1

Legend:

Unmodified
Added
Removed
Modified
  • the_docs_strikes_back

    v2 v3  
    106106
    107107Yes right before WPS ! {{{:doc:}}} are use to link to document in the documentation, but it is a link to the WPS webpage. So sphinx doesn't find the {{{WPS <http://www.opengeospatial.org/standards/wps>}}} file and gives an error.
     108
     109
     110----
     111
     112= How to document the overview file
     113
     114
     115The overview files are located at:
     116
     117https://github.com/OSGeo/OSGeoLive-doc/tree/master/doc/overview
     118
     119For this documentation:
     120
     121*  Words surrounded by `< >` are to be defined by the person documenting the project
     122  * <slug> is the slug name defined on `projects_info.csv` file
     123* The project overview file name is `<slug>_overview.rst` for example `udig_overview.rst`
     124* Words surrounded by `@` are variables and will automatically get values, the purpose is to keep consistency through all the documentation
     125
     126||= Table Header =|| Example || Action ||
     127|| @LOGO_<slug>@ || `@LOGO_udig@` || Gets the logo image of the project  if it exists ||
     128|| @OSGEO_KIND_<slug>@ || `@OSGEO_KIND_udig@` || Gets the logo of the kind of project within OSGeo ||
     129|| @NAME_udig@ || `@NAME_udig@` || Gets the name of the project as defined on the `projects_info.csv` ||
     130|| @QUICKSTART_udig@ || `@QUICKSTART_udig@` || Will generate a link to the quickstart if it exists ||
     131
     132and has the following structure:
     133
     134{{{
     135:Author: <author's name>
     136:Reviewer: <reviewer name>
     137:Version: <OSGeoLive version from which this documentation is valid>
     138:License: Creative Commons Attribution 3.0 Unported (CC BY 3.0)
     139
     140
     141@LOGO_<slug>@
     142@OSGEO_KIND_<slug>@
     143
     144
     145@NAME_<slug>@
     146================================================================================
     147
     148Lorem ipsum dolor sit amet, consectetur adipiscing elit. Mauris eget dui vitae est
     149sodales consequat eget vel risus. Fusce suscipit lorem sit amet elementum volutpat.
     150Praesent pretium mauris id porta convallis. Integer suscipit, massa at tempor congue,
     151lectus ipsum tempor eros, non elementum orci felis eget diam. Praesent vitae tortor
     152finibus, bibendum orci vulputate, semper lectus. Morbi fringilla dignissim consectetur.
     153
     154Donec ac dictum nisi. Cras sed justo id augue lacinia tincidunt vel non purus.
     155Doneceget ante blandit leo porta semper eu in sapien. Donec at nibh finibus,
     156posuere eros eget, fringilla tortor. Morbi quam @NAME_<slug>@ ipsum, molestie et mi nec,
     157bibendum feugiat ipsum. Fusce mauris ligula, iaculis id varius a, laoreet nec lectus.
     158Phasellus rhoncus pulvinar purus.
     159
     160@NAME_<slug>@  Praesent quis sapien nibh. Integer dictum, augue sed semper tincidunt,
     161lectus sem porttitor mauris, a porta magna est a orci.
     162
     163
     164@SCREENSHOT_udig@
     165
     166Core Features
     167--------------------------------------------------------------------------------
     168
     169* Vestibulum massa risus
     170* sagittis eu ornare ut
     171* dapibus sit amet risus
     172
     173Implemented Standards
     174--------------------------------------------------------------------------------
     175
     176* OGC Web Map Server (WMS)
     177* OGC Web Feature Server (WFS)
     178
     179
     180Details
     181--------------------------------------------------------------------------------
     182
     183**Website:** <wesite link>
     184
     185**Licence:** <license>
     186
     187**Software Version:** |version-udig|
     188
     189**Supported Platforms:** <List of platforms>
     190
     191**API Interfaces:** <list of API interfaces>
     192
     193**Support:** <support link>
     194
     195**Developers:** <developers link>
     196
     197
     198@QUICKSTART_udig@
     199
     200.. presentation-note
     201    Lorem ipsum dolor sit amet, consectetur adipiscing elit. Mauris eget dui vitae est
     202    sodales consequat eget vel risus. Fusce suscipit lorem sit amet elementum volutpat.
     203    Praesent pretium mauris id porta convallis. Integer suscipit, massa at tempor congue,
     204    lectus ipsum tempor eros, non elementum orci felis eget diam. Praesent vitae tortor
     205    finibus, bibendum orci vulputate, semper lectus. Morbi fringilla dignissim consectetur.
     206 
     207}}}