Changes between Version 17 and Version 18 of Submitting/Python

Timestamp:

Mar 21, 2018, 11:45:27 PM (6 years ago)

Author:

neteler

Comment:

+Adding description and keywords

Submitting/Python

@@ -267 +267 @@
 See also locale/README for more information on translation process and related issues.
 
+=== Adding description and keywords ===
+
+Each module needs to have a description and at least 3 keywords. Here an example from scripts/g.extension/g.extension.py:
+
+{{{
+#%module
+#% label: Maintains GRASS Addons extensions in local GRASS installation.
+#% description: Downloads and installs extensions from GRASS Addons repository or other source into the local GRASS installation or removes installed extensions.
+#% keyword: general
+#% keyword: installation
+#% keyword: extensions
+#% keyword: addons
+#% keyword: download
+#%end
+}}}
+
+Notes:
+ * the **first** keyword is the module family (**g**.list belongs to "general") which go to the [https://grass.osgeo.org/grass74/manuals/general.html module family index] in the manual
+ * the **second** keyword is the overall topic which go to the [https://grass.osgeo.org/grass74/manuals/topics.html topic index] in the manual
+ * the **third* (and more) keyword is describing further keywords which go to the [https://grass.osgeo.org/grass74/manuals/keywords.html keyword index] in the manual
+
+These index manual pages are autogenerated during the build process of GRASS GIS.
+
 == Documentation and comments ==