* Added support for layer summaries.

* Added a "Index" link on the menu to link to index.html
* Added links from the master interface & template lists
  to their respective documentation in their module.
* Added links to "Interfaces" and "Templates" in modules
  that have both.
* Added "Return" links after the "Interfaces" and "Templates"
  section that go to the top of the module site.

refpolicy/Changelog

@@ -1,3 +1,7 @@
+	* Doc tool now links directly to the interface/template in the
+	  module page when it is selected in the interface/template index.
+	* Added support for layer summaries.
+
 20050707 (7 Jul 2005)
 	* Changed xml to have modules encapsulated by layer tags, rather
 	  than putting layer="foo" in the module tags.  Also in the future
@@ -12,8 +16,9 @@
 	* Doc tool retains the user's settings in modules.conf and
 	  tunables.conf if the files already exist.
 	* Modules.conf behavior has been changed to be a list of all
-	  available modules, and the user can toggle the module on or
-	  off to include the module or not.
+	  available modules, and the user can specify if the module is
+	  built as a loadable module, included in the monolithic policy,
+	  or excluded.
 	* Added policies:
 		fstools (fsck, mkfs, swapon, etc. tools)
 		logrotate

refpolicy/doc/templates/int_list.html

@@ -2,7 +2,7 @@
 
 [[for int in interfaces]]
 <div id="interfacesmall">
-Module: <a href='[[int['mod_layer']+ "_" + int['mod_name']]].html'>
+Module: <a href='[[int['mod_layer']+ "_" + int['mod_name'] + ".html#link_" + int['interface_name']]]'>
 [[int['mod_name']]]</a><p/>
 Layer: <a href='[[int['mod_layer']]].html'>
 [[int['mod_layer']]]</a><p/>

refpolicy/doc/templates/interface.html

@@ -1,4 +1,5 @@
 [[for int in interfaces]]
+<a name="link_[[int['interface_name']]]"></a>
 <div id="interface">
 [[if int.has_key("mod_layer")]]
 	Layer: [[mod_layer]]<br>

refpolicy/doc/templates/menu.html

@@ -10,6 +10,8 @@
 		</div>
 	[[end]]
 	<br/><p/>
+	<a href="index.html">*&nbsp;Layer Index</a>
+	<br/><p/>
 	<a href="interfaces.html">*&nbsp;Interface Index</a>
 	<br/><p/>
 	<a href="templates.html">*&nbsp;Template Index</a>

refpolicy/doc/templates/module.html

@@ -1,12 +1,10 @@
 <a name="top":></a>
 <h1>Layer: [[mod_layer]]</h1><p/>
 <h2>Module: [[mod_name]]</h2><p/>
-[[if interfaces]]
-[[if templates]]
+[[if interfaces and templates]]
 <a href=#interfaces>Interfaces</a>
 <a href=#templates>Templates</a>
 [[end]]
-[[end]]
 <h3>Description:</h3>
 [[if mod_desc]] 
 <p>[[mod_desc]]</p>

refpolicy/doc/templates/module_list.html

@@ -1,5 +1,8 @@
 [[if mod_layer]]
 <h1>Layer: [[mod_layer]]</h1><p/>
+[[if layer_summary]]
+<p>[[layer_summary]]</p><br/>
+[[end]]
 [[end]]
 <table border="1" cellspacing="0" cellpadding="3" width="75%">
 <tr><td class="title">Module:</td><td class="title">Description:</td></tr>

refpolicy/doc/templates/temp_list.html

@@ -2,7 +2,7 @@
 
 [[for temp in templates]]
 <div id="templatesmall">
-Module: <a href='[[temp['mod_layer']+ "_" + temp['mod_name']]].html'>
+Module: <a href='[[temp['mod_layer']+ "_" + temp['mod_name'] + ".html#link_" + temp['template_name']]]'>
 [[temp['mod_name']]]</a><p/>
 Layer: <a href='[[temp['mod_layer']]].html'>
 [[temp['mod_layer']]]</a><p/>

refpolicy/doc/templates/template.html

@@ -1,4 +1,5 @@
 [[for temp in templates]]
+<a name="link_[[temp['template_name']]]"></a>
 <div id="template">
 [[if temp.has_key("mod_layer")]]
 	Layer: [[mod_layer]]<br>

refpolicy/support/sedoctool.py

@@ -308,8 +308,14 @@ def gen_docs(doc, working_dir, templatedir):
 	for mod_layer,modules in module_list.iteritems():
 		menu = gen_doc_menu(mod_layer, module_list)
 
+		layer_summary = None
+		for desc in doc.getElementsByTagName("summary"):
+			if desc.parentNode.getAttribute("name") == mod_layer:
+				layer_summary = format_html_desc(desc)
+
 		menu_args = { "menulist" : menu,
-			      "mod_layer" : mod_layer }
+			      "mod_layer" : mod_layer,
+			      "layer_summary" : layer_summary }
 		menu_tpl = pyplate.Template(menudata)
 		menu_buf = menu_tpl.execute_string(menu_args)