Changes between Initial Version and Version 1 of How to document the overview file

Timestamp:

04/10/18 12:45:14 (7 years ago)

Author:

cvvergara

Comment:

fixing more

How to document the overview file

@@ +1 @@
+[[PageOutline(1-2)]]
+
+= How to document the overview file
+
+== Where to find the overview files
+
+The overview files are located at:
+
+https://github.com/OSGeo/OSGeoLive-doc/tree/master/doc/overview
+
+== Notation
+
+For this documentation:
+
+*  Words surrounded by `< >` are to be defined by the person documenting the project
+  * `<slug>` is the slug name defined on `projects_info.csv` file
+* The project overview file name is `<slug>_overview.rst` for example `udig_overview.rst`
+* Words surrounded by `@ @` are variables
+* Words surrounded by `| |` are Sphinx variables
+
+
+
+||= Variable =||= Example =||= Action =||
+|| @LOGO_<slug>@ || `@LOGO_udig@` || Gets the logo image of the project  if it exists ||
+|| @OSGEO_KIND_<slug>@ || `@OSGEO_KIND_udig@` || Gets the logo of the kind of project within OSGeo as defined on the `projects_info.csv`||
+|| @NAME_<slug>@ || `@NAME_udig@` || Gets the name of the project as defined on the `projects_info.csv` ||
+|| @QUICKSTART_<slug>@ || `@QUICKSTART_udig@` || Will generate a link to the quickstart if defined on the `projects_info.csv`  ||
+|| |version-<slug>| || `|version-udig|` || Project's version defined on the `projects_info.csv`
+
+== `overview_slug.rst` File Structure
+
+{{{
+:Author: <author's name>
+:Reviewer: <reviewer name>
+:Version: <OSGeoLive version from which this documentation is valid>
+:License: Creative Commons Attribution 3.0 Unported (CC BY 3.0)
+
+
+@LOGO_<slug>@
+@OSGEO_KIND_<slug>@
+
+
+@NAME_<slug>@
+================================================================================
+
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Mauris eget dui vitae est
+sodales consequat eget vel risus. Fusce suscipit lorem sit amet elementum volutpat.
+Praesent pretium mauris id porta convallis. Integer suscipit, massa at tempor congue,
+lectus ipsum tempor eros, non elementum orci felis eget diam. Praesent vitae tortor
+finibus, bibendum orci vulputate, semper lectus. Morbi fringilla dignissim consectetur.
+
+Donec ac dictum nisi. Cras sed justo id augue lacinia tincidunt vel non purus.
+Doneceget ante blandit leo porta semper eu in sapien. Donec at nibh finibus,
+posuere eros eget, fringilla tortor. Morbi quam @NAME_<slug>@  together with
+@NAME_<other_slug>@ ipsum, molestie et mi nec,
+bibendum feugiat ipsum. Fusce mauris ligula, iaculis id varius a, laoreet nec lectus.
+Phasellus rhoncus pulvinar purus.
+
+@NAME_<slug>@  Praesent quis sapien nibh. Integer dictum, augue sed semper tincidunt,
+lectus sem porttitor mauris, a porta magna est a orci.
+
+
+@SCREENSHOT_<slug>@
+
+Core Features
+--------------------------------------------------------------------------------
+
+* Vestibulum massa risus
+* sagittis eu ornare ut
+* dapibus sit amet risus
+
+Implemented Standards
+--------------------------------------------------------------------------------
+
+* OGC Web Map Server (WMS)
+* OGC Web Feature Server (WFS)
+
+
+Details
+--------------------------------------------------------------------------------
+
+**Website:** <wesite link>
+
+**Licence:** <license>
+
+**Software Version:** |version-<slug>|
+
+**Supported Platforms:** <List of platforms>
+
+**API Interfaces:** <list of API interfaces>
+
+**Support:** <support link>
+
+**Developers:** <developers link>
+
+
+
+@QUICKSTART_udig@
+
+.. presentation-note
+    Lorem ipsum dolor sit amet, consectetur adipiscing elit. Mauris eget dui vitae est
+    sodales consequat eget vel risus. Fusce suscipit lorem sit amet elementum volutpat.
+    Praesent pretium mauris id porta convallis. Integer suscipit, massa at tempor congue,
+    lectus ipsum tempor eros, non elementum orci felis eget diam. Praesent vitae tortor
+    finibus, bibendum orci vulputate, semper lectus. Morbi fringilla dignissim consectetur.
+ 
+}}}