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


Ignore:
Timestamp:
10 Apr 2018 12:45:14 (20 months ago)
Author:
cvvergara
Comment:

fixing more

Legend:

Unmodified
Added
Removed
Modified
  • How to document the overview file

    v1 v1  
     1[[PageOutline(1-2)]]
     2
     3= How to document the overview file
     4
     5== Where to find the overview files
     6
     7The overview files are located at:
     8
     9https://github.com/OSGeo/OSGeoLive-doc/tree/master/doc/overview
     10
     11== Notation
     12
     13For this documentation:
     14
     15*  Words surrounded by `< >` are to be defined by the person documenting the project
     16  * `<slug>` is the slug name defined on `projects_info.csv` file
     17* The project overview file name is `<slug>_overview.rst` for example `udig_overview.rst`
     18* Words surrounded by `@ @` are variables
     19* Words surrounded by `| |` are Sphinx variables
     20
     21
     22
     23||= Variable =||= Example =||= Action =||
     24|| @LOGO_<slug>@ || `@LOGO_udig@` || Gets the logo image of the project  if it exists ||
     25|| @OSGEO_KIND_<slug>@ || `@OSGEO_KIND_udig@` || Gets the logo of the kind of project within OSGeo as defined on the `projects_info.csv`||
     26|| @NAME_<slug>@ || `@NAME_udig@` || Gets the name of the project as defined on the `projects_info.csv` ||
     27|| @QUICKSTART_<slug>@ || `@QUICKSTART_udig@` || Will generate a link to the quickstart if defined on the `projects_info.csv`  ||
     28|| |version-<slug>| || `|version-udig|` || Project's version defined on the `projects_info.csv`
     29
     30== `overview_slug.rst` File Structure
     31
     32{{{
     33:Author: <author's name>
     34:Reviewer: <reviewer name>
     35:Version: <OSGeoLive version from which this documentation is valid>
     36:License: Creative Commons Attribution 3.0 Unported (CC BY 3.0)
     37
     38
     39@LOGO_<slug>@
     40@OSGEO_KIND_<slug>@
     41
     42
     43@NAME_<slug>@
     44================================================================================
     45
     46Lorem ipsum dolor sit amet, consectetur adipiscing elit. Mauris eget dui vitae est
     47sodales consequat eget vel risus. Fusce suscipit lorem sit amet elementum volutpat.
     48Praesent pretium mauris id porta convallis. Integer suscipit, massa at tempor congue,
     49lectus ipsum tempor eros, non elementum orci felis eget diam. Praesent vitae tortor
     50finibus, bibendum orci vulputate, semper lectus. Morbi fringilla dignissim consectetur.
     51
     52Donec ac dictum nisi. Cras sed justo id augue lacinia tincidunt vel non purus.
     53Doneceget ante blandit leo porta semper eu in sapien. Donec at nibh finibus,
     54posuere eros eget, fringilla tortor. Morbi quam @NAME_<slug>@  together with
     55@NAME_<other_slug>@ ipsum, molestie et mi nec,
     56bibendum feugiat ipsum. Fusce mauris ligula, iaculis id varius a, laoreet nec lectus.
     57Phasellus rhoncus pulvinar purus.
     58
     59@NAME_<slug>@  Praesent quis sapien nibh. Integer dictum, augue sed semper tincidunt,
     60lectus sem porttitor mauris, a porta magna est a orci.
     61
     62
     63@SCREENSHOT_<slug>@
     64
     65Core Features
     66--------------------------------------------------------------------------------
     67
     68* Vestibulum massa risus
     69* sagittis eu ornare ut
     70* dapibus sit amet risus
     71
     72Implemented Standards
     73--------------------------------------------------------------------------------
     74
     75* OGC Web Map Server (WMS)
     76* OGC Web Feature Server (WFS)
     77
     78
     79Details
     80--------------------------------------------------------------------------------
     81
     82**Website:** <wesite link>
     83
     84**Licence:** <license>
     85
     86**Software Version:** |version-<slug>|
     87
     88**Supported Platforms:** <List of platforms>
     89
     90**API Interfaces:** <list of API interfaces>
     91
     92**Support:** <support link>
     93
     94**Developers:** <developers link>
     95
     96
     97
     98@QUICKSTART_udig@
     99
     100.. presentation-note
     101    Lorem ipsum dolor sit amet, consectetur adipiscing elit. Mauris eget dui vitae est
     102    sodales consequat eget vel risus. Fusce suscipit lorem sit amet elementum volutpat.
     103    Praesent pretium mauris id porta convallis. Integer suscipit, massa at tempor congue,
     104    lectus ipsum tempor eros, non elementum orci felis eget diam. Praesent vitae tortor
     105    finibus, bibendum orci vulputate, semper lectus. Morbi fringilla dignissim consectetur.
     106 
     107}}}