mkhtml.py 4.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151
  1. #!/usr/bin/env python
  2. ############################################################################
  3. #
  4. # MODULE: mkhtml.py
  5. # AUTHOR(S): Markus Neteler, Glynn Clements
  6. # TOC by Martin Landa <landa.martin gmail.com>
  7. # PURPOSE: create HTML manual page snippets
  8. # COPYRIGHT: (C) 2007,2009-2010 Glynn Clements and the GRASS Development Team
  9. #
  10. # This program is free software under the GNU General Public
  11. # License (>=v2). Read the file COPYING that comes with GRASS
  12. # for details.
  13. #
  14. #############################################################################
  15. import sys
  16. import os
  17. import string
  18. import re
  19. pgm = sys.argv[1]
  20. src_file = "%s.html" % pgm
  21. tmp_file = "%s.tmp.html" % pgm
  22. header_tmpl = string.Template(\
  23. """<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
  24. <html>
  25. <head>
  26. <title>GRASS GIS Manual: ${PGM}</title>
  27. <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
  28. <link rel="stylesheet" href="grassdocs.css" type="text/css">
  29. </head>
  30. <body bgcolor="white">
  31. <img src="grass_logo.png" alt="GRASS logo"><hr align=center size=6 noshade>
  32. <h2>NAME</h2>
  33. <em><b>${PGM}</b></em>
  34. """)
  35. footer_tmpl = string.Template(\
  36. """<hr>
  37. <p><a href="index.html">Main index</a> - <a href="$INDEXNAME.html">$INDEXNAME index</a> - <a href="full_index.html">Full index</a></p>
  38. <p>&copy; 2003-2010 <a href="http://grass.osgeo.org">GRASS Development Team</a></p>
  39. </body>
  40. </html>
  41. """)
  42. def read_file(name):
  43. try:
  44. f = open(name, 'rb')
  45. s = f.read()
  46. f.close()
  47. return s
  48. except IOError:
  49. return ""
  50. src_data = read_file(src_file)
  51. def get_toc_item(line, pattern):
  52. found = pattern.search(line)
  53. if found:
  54. return found.group(2).strip()
  55. return None
  56. def filter_toc_item(label):
  57. return label.replace('"', '&quot;')
  58. def write_toc_level(line, src_list, pattern, pattern_level, level, idx):
  59. indent = 4
  60. text = get_toc_item(line, pattern)
  61. if not text:
  62. return False, level
  63. if pattern_level > level:
  64. for l in range(level, pattern_level):
  65. sys.stdout.write('%s<ul>\n' % (' ' * l * indent))
  66. elif level > pattern_level:
  67. for l in range(level, pattern_level, -1):
  68. sys.stdout.write('%s</ul>\n' % (' ' * (l - 1) * indent))
  69. level = pattern_level
  70. sys.stdout.write('%s<li><a href="#%s">%s</a>\n' % (' ' * level * indent,
  71. filter_toc_item(text), filter_toc_item(text)))
  72. src_list[idx] = '<a name="%s"></a>' % filter_toc_item(text) + line
  73. return True, level
  74. def write_toc():
  75. global src_data
  76. level = 1
  77. idx = 0
  78. sys.stdout.write('<a name="TOC"></a><h2>TABLE OF CONTENT</h2>\n\n<ul>\n')
  79. src_list = src_data.splitlines()
  80. for line in src_list:
  81. found, level = write_toc_level(line, src_list,
  82. re.compile(r"(<h2>)(.*)(</h2>)", re.IGNORECASE), 1,
  83. level, idx)
  84. if not found:
  85. found, level = write_toc_level(line, src_list,
  86. re.compile(r"(<h3>)(.*)(</h3>)", re.IGNORECASE), 2,
  87. level, idx)
  88. if not found:
  89. found, level = write_toc_level(line, src_list,
  90. re.compile(r"(<h4>)(.*)(</h4>)", re.IGNORECASE), 3,
  91. level, idx)
  92. idx += 1
  93. sys.stdout.write('</ul>\n')
  94. src_data = '\n'.join(src_list)
  95. if not re.search('<html>', src_data, re.IGNORECASE):
  96. tmp_data = read_file(tmp_file)
  97. if not re.search('<html>', tmp_data, re.IGNORECASE):
  98. sys.stdout.write(header_tmpl.substitute(PGM = pgm))
  99. if tmp_data:
  100. for line in tmp_data.splitlines(True):
  101. if not re.search('</body>|</html>', line, re.IGNORECASE):
  102. sys.stdout.write(line)
  103. write_toc()
  104. sys.stdout.write(src_data)
  105. # if </html> is found, suppose a complete html is provided.
  106. # otherwise, generate module class reference:
  107. if re.search('</html>', src_data, re.IGNORECASE):
  108. sys.exit()
  109. index_names = {
  110. 'd' : 'display',
  111. 'db': 'database',
  112. 'g' : 'general',
  113. 'i' : 'imagery',
  114. 'm' : 'misc',
  115. 'ps': 'postscript',
  116. 'p' : 'paint',
  117. 'r' : 'raster',
  118. 'r3': 'raster3D',
  119. 's' : 'sites',
  120. 'v' : 'vector'
  121. }
  122. mod_class = pgm.split('.', 1)[0]
  123. index_name = index_names.get(mod_class, mod_class)
  124. sys.stdout.write(footer_tmpl.substitute(INDEXNAME = index_name))