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

Timestamp:

04/12/18 12:57:42 (7 years ago)

Author:

cvvergara

Comment:

adding a how to write a quickstart

How to document the quickstart file

@@ +1 @@
+[[PageOutline(1-2)]]
+
+= How to document the quickstart file
+
+== Where to find the quickstart files
+
+The overview files are located at:
+
+https://github.com/OSGeo/OSGeoLive-doc/tree/master/doc/quickstart
+
+== 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`  ||
+|| @SCREENSHOT_<slug>@ || `@SCREENSHOT_udig@` || Places the screenshot to a given standard size ||
+|| |version-<slug>| || `|version-udig|` || Project's version defined on the `projects_info.csv`
+
+
+= `quickstart_<slug>.rst` File Structure
+
+{{{
+:Author: <author's name>
+:Reviewer: <reviewer name>
+:Version: <OSGeoLive version from which this documentation is valid>
+:License: Creative Commons Attribution-ShareAlike 3.0 Unported  (CC BY-SA 3.0)
+
+
+
+@LOGO_<slug>@
+@OSGEO_KIND_<slug>@
+
+********************************************************************************
+@NAME_<slug>@ Quickstart
+********************************************************************************
+
+
+First sentence defines what the application does.
+You may also need to include a sentence of two describing the domain.
+Eg: For a Business Intelligence application, you should describe what
+Business Intelligence is.
+
+This Quick Start describes how to:
+
+* Add a title and subtitle
+* Add a link
+* `Web Map Service (WMS) <http://www.opengeospatial.org/standards/wms>`__
+* use the standard map tools
+* apply color to map features using styling
+
+.. contents:: Contents
+  
+This is a title
+================================================================================
+
+A title has a line with 80 '=', and you  use them to separate big sections of the quickstart
+
+Here a paragraph is starting because of the blank line above.
+But this line belongs to this second paragraph.
+
+This is a subtitle
+--------------------------------------------------------------------------------
+
+A subtitle has a line with 80 '-', and you  use them to separate sections within the title
+
+The following is an image, and Its being described here
+
+.. image:: /images/projects/<slug>/image_name.png
+   :scale: 70 %
+
+
+The image can be described here also
+
+.. this is a comment, because it does not start with a sphinx command
+
+.. TODO I am using a comment to mention some reminder of things to do
+
+
+
+This :menuselection:`Geospatial --> Desktop GIS --> uDig` can be used for a sequence of clicks on menus will look like: `Geospatial ‣ Desktop GIS ‣ uDig`
+
+* This is a bulleted list.
+* It has two items, the second
+  item uses two lines. (note the indentation)
+
+1. This is a numbered list.
+2. It has two items too.
+3. This numbered list
+
+   * Has a bullet list (note the blank line and the indentation)
+   * This bullet has an image (note the blank line and the indentation)
+
+      .. image:: /images/projects/<slug>/image_name.png
+         :scale: 70 %
+
+
+.. note::
+  Notes are used to provide descriptions and background information without
+  getting in the way of instructions. Notes will likely be rendered in
+  the margin in some printed formats.
+
+
+.. tip::   Tips are used to provide extra useful information, and will 
+  likely be rendered in the margin in some printed formats.
+
+
+The **Bold** and the *Italic*.
+
+The following is for code
+
+::
+
+   Code starts here, (note the blank line bewtween the `::` and the code
+   More code
+
+This is not code
+
+
+The following is `link title <http://this/is/the/external_link.html>`__
+(note back ticks ` and the 2 underscores at the end)
+
+The following is an internal link :doc:`../overview/<other_slug>_overview`.
+
+
+
+
+Things to Try
+================================================================================
+
+This section is highly recommended, and should provide pointers further things to try.
+
+Present a list of ideas for people to try out:
+
+* Start off very specific with something most people can do based on the materials as presented.
+* Continue on with a challenge that involves a small bit of research
+* It is **recommended** that research be limited to something that can be
+found in documentation packaged on OSGeoLive, as users might not be
+connected to the Internet.
+
+Here are some additional challenges for you to try:
+
+#. Try Lorem ipsum dolor sit amet, consectetur adipiscing elit.
+   Mauris eget dui vitae estsodales consequat eget vel risus.
+   Fusce suscipit lorem sit amet elementum volutpat.
+#. Try Praesent pretium mauris id porta convallis.
+
+
+What Next?
+================================================================================
+
+
+This section is highly recommended, please provide links to further tutorials and other documentation.
+
+
+* the tutorial
+
+   Maybe have a short description of the tutorial. The tutorial or documentation might not be inside the disk, so use this link style:
+   
+   The link: `link title <http://this/is/the/external_link.html>`__
+
+
+}}}
+
+