[GRASS-SVN] r66041 - grass/trunk/man

svn_grass at osgeo.org svn_grass at osgeo.org
Wed Aug 26 19:06:14 PDT 2015


Author: wenzeslaus
Date: 2015-08-26 19:06:14 -0700 (Wed, 26 Aug 2015)
New Revision: 66041

Modified:
   grass/trunk/man/build_html.py
   grass/trunk/man/build_topics.py
Log:
docs: link keywords index entry at the end of the page

User should first read the topic modules and then look for more.

Also replace 'Note: see...' by simple and more readable 'See...'


Modified: grass/trunk/man/build_html.py
===================================================================
--- grass/trunk/man/build_html.py	2015-08-27 01:51:27 UTC (rev 66040)
+++ grass/trunk/man/build_html.py	2015-08-27 02:06:14 UTC (rev 66041)
@@ -317,8 +317,7 @@
 <hr class="header">
 
 <h2>Topic: ${keyword}</h2>
-<i>Note: see also the corresponding keyword <a href="keywords.html#${keyword}">${keyword}</a> for additional references.</i>
-<p>
+
 <table>
 """)
 #"

Modified: grass/trunk/man/build_topics.py
===================================================================
--- grass/trunk/man/build_topics.py	2015-08-27 01:51:27 UTC (rev 66040)
+++ grass/trunk/man/build_topics.py	2015-08-27 02:06:14 UTC (rev 66041)
@@ -62,6 +62,13 @@
         topicsfile.writelines([moduletopics_tmpl.substitute(
             key=key.lower(), name=key.replace('_', ' '))])
     keyfile.write("</table>\n")
+    # link to the keywords index
+    # TODO: the labels in keywords index are with spaces and capitals
+    # this should be probably changed to lowercase with underscores
+    keyfile.write(
+        '<p><em>See also the corresponding keyword'
+        ' <a href="keywords.html#{key}">{key}</a>'
+        ' for additional references.</em>'.format(key=key.replace('_', ' ')))
     write_html_footer(keyfile, "index.html", year)
 topicsfile.write("</ul>\n")
 write_html_footer(topicsfile, "index.html", year)



More information about the grass-commit mailing list