Changes between Version 51 and Version 52 of Submitting/C

Timestamp:

Mar 21, 2018, 11:44:08 PM (6 years ago)

Author:

neteler

Comment:

+Adding description and keywords

Submitting/C

@@ -259 +259 @@
 See source:grass/trunk/lib/gis/parser_standard_options.c for details of the function definition.
 
+=== Adding description and keywords ===
+
+Each module needs to have a description and at least 3 keywords. Here an example from general/g.list/main.c:
+
+{{{
+    G_gisinit(argv[0]);
+
+    module = G_define_module();
+    G_add_keyword(_("general"));
+    G_add_keyword(_("map management"));
+    G_add_keyword(_("list"));
+    G_add_keyword(_("search"));
+    module->description =
+        _("Lists available GRASS data base files of "
+          "the user-specified data type optionally using the search pattern.");
+}}}
+
+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.
 == Indentation ==