GNOME.org
 

[gobject-introspection/wip/docs: 7/23] doctool: Use a standard title for both links and for page titles

commit 6b270e16dd8fb4a23b0a96115537a921aed4a4e1
Author: Jasper St. Pierre <jstpierre mecheye net>
Date:   Thu Jan 31 11:33:57 2013 -0500

    doctool: Use a standard title for both links and for page titles

 giscanner/doctemplates/C/mallard-C-class.tmpl      |    2 +-
 giscanner/doctemplates/C/mallard-C-default.tmpl    |    2 +-
 giscanner/doctemplates/C/mallard-C-enum.tmpl       |    2 +-
 giscanner/doctemplates/C/mallard-C-function.tmpl   |    2 +-
 giscanner/doctemplates/C/mallard-C-namespace.tmpl  |    2 +-
 giscanner/doctemplates/C/mallard-C-property.tmpl   |    2 +-
 giscanner/doctemplates/C/mallard-C-record.tmpl     |    2 +-
 giscanner/doctemplates/C/mallard-C-signal.tmpl     |    2 +-
 giscanner/doctemplates/C/mallard-C-vfunc.tmpl      |    2 +-
 .../doctemplates/Python/mallard-Python-class.tmpl  |    2 +-
 .../Python/mallard-Python-default.tmpl             |    2 +-
 .../doctemplates/Python/mallard-Python-enum.tmpl   |    2 +-
 .../Python/mallard-Python-function.tmpl            |    2 +-
 .../Python/mallard-Python-namespace.tmpl           |    2 +-
 .../Python/mallard-Python-property.tmpl            |    2 +-
 .../doctemplates/Python/mallard-Python-record.tmpl |    2 +-
 .../doctemplates/Python/mallard-Python-signal.tmpl |    2 +-
 .../doctemplates/Python/mallard-Python-vfunc.tmpl  |    2 +-
 .../DocExamples.Obj-property-example.page          |    2 +-
 .../DocExamples.Obj-signal-example.page            |    2 +-
 .../DocExamples.Obj-vfunc.page                     |    2 +-
 .../DocExamples.Obj.page                           |    2 +-
 .../DocExamples.ObjClass.page                      |    2 +-
 .../doctool/DocExamples-1.0-C-expected/index.page  |    2 +-
 .../DocExamples.Obj-vfunc.page                     |    2 +-
 .../DocExamples.Obj.method.page                    |    2 +-
 .../DocExamples.Obj.static_method.page             |    2 +-
 .../DocExamples-1.0-Python-expected/index.page     |    2 +-
 28 files changed, 28 insertions(+), 28 deletions(-)
---
diff --git a/giscanner/doctemplates/C/mallard-C-class.tmpl b/giscanner/doctemplates/C/mallard-C-class.tmpl
index 5081f85..3a20844 100644
--- a/giscanner/doctemplates/C/mallard-C-class.tmpl
+++ b/giscanner/doctemplates/C/mallard-C-class.tmpl
@@ -8,7 +8,7 @@
   <info>
     <link type="guide" xref="index" group="class"/>
   </info>
-  <title>${node.ctype}</title>
+  <title>${formatter.format_page_name(node)}</title>
 ${formatter.format(node, node.doc)}
 % if node.version:
 <p>Since ${node.version}</p>
diff --git a/giscanner/doctemplates/C/mallard-C-default.tmpl b/giscanner/doctemplates/C/mallard-C-default.tmpl
index c6ce176..d2c4105 100644
--- a/giscanner/doctemplates/C/mallard-C-default.tmpl
+++ b/giscanner/doctemplates/C/mallard-C-default.tmpl
@@ -6,6 +6,6 @@
       xmlns:ui="http://projectmallard.org/experimental/ui/";>
   <info>
   </info>
-  <title>${namespace.name}.${node.name}</title>
+  <title>${formatter.format_page_name(node)}</title>
 ${formatter.format(node, node.doc)}
 </page>
diff --git a/giscanner/doctemplates/C/mallard-C-enum.tmpl b/giscanner/doctemplates/C/mallard-C-enum.tmpl
index 393fae4..7283366 100644
--- a/giscanner/doctemplates/C/mallard-C-enum.tmpl
+++ b/giscanner/doctemplates/C/mallard-C-enum.tmpl
@@ -7,6 +7,6 @@
   <info>
     <link type="guide" xref="index"/>
   </info>
-  <title>${node.namespace.name}.${node.name}</title>
+  <title>${formatter.format_page_name(node)}</title>
 ${formatter.format(node, node.doc)}
 </page>
diff --git a/giscanner/doctemplates/C/mallard-C-function.tmpl b/giscanner/doctemplates/C/mallard-C-function.tmpl
index 853a761..d433aa5 100644
--- a/giscanner/doctemplates/C/mallard-C-function.tmpl
+++ b/giscanner/doctemplates/C/mallard-C-function.tmpl
@@ -34,7 +34,7 @@
 % endfor
     </api:function>
   </info>
-  <title>${node.symbol}</title>
+  <title>${formatter.format_page_name(node)}</title>
 <synopsis><code mime="text/x-csrc">
 ${node.retval.type.ctype} ${node.symbol} (\
 % if node.is_method:
diff --git a/giscanner/doctemplates/C/mallard-C-namespace.tmpl b/giscanner/doctemplates/C/mallard-C-namespace.tmpl
index 5d39dbc..39d0261 100644
--- a/giscanner/doctemplates/C/mallard-C-namespace.tmpl
+++ b/giscanner/doctemplates/C/mallard-C-namespace.tmpl
@@ -6,7 +6,7 @@
       xmlns:ui="http://projectmallard.org/experimental/ui/";>
   <info>
   </info>
-  <title>${node.name} Documentation</title>
+  <title>${formatter.format_page_name(node)}</title>
   <links type="topic" ui:expanded="yes" groups="class" style="linklist">
     <title>Classes</title>
   </links>
diff --git a/giscanner/doctemplates/C/mallard-C-property.tmpl b/giscanner/doctemplates/C/mallard-C-property.tmpl
index 68f09ec..a253160 100644
--- a/giscanner/doctemplates/C/mallard-C-property.tmpl
+++ b/giscanner/doctemplates/C/mallard-C-property.tmpl
@@ -8,6 +8,6 @@
     <link type="guide" xref="${namespace.name}.${node.parent.name}" group="property"/>
     <title type="link" role="topic">${node.name}</title>
   </info>
-  <title>${node.parent.ctype}:${node.name}</title>
+  <title>${formatter.format_page_name(node)}</title>
 ${formatter.format(node, node.doc)}
 </page>
diff --git a/giscanner/doctemplates/C/mallard-C-record.tmpl b/giscanner/doctemplates/C/mallard-C-record.tmpl
index f0c80dc..7283366 100644
--- a/giscanner/doctemplates/C/mallard-C-record.tmpl
+++ b/giscanner/doctemplates/C/mallard-C-record.tmpl
@@ -7,6 +7,6 @@
   <info>
     <link type="guide" xref="index"/>
   </info>
-  <title>${node.namespace.name}${node.name}</title>
+  <title>${formatter.format_page_name(node)}</title>
 ${formatter.format(node, node.doc)}
 </page>
diff --git a/giscanner/doctemplates/C/mallard-C-signal.tmpl b/giscanner/doctemplates/C/mallard-C-signal.tmpl
index 33ed5c2..49ee985 100644
--- a/giscanner/doctemplates/C/mallard-C-signal.tmpl
+++ b/giscanner/doctemplates/C/mallard-C-signal.tmpl
@@ -8,6 +8,6 @@
     <link type="guide" xref="${namespace.name}.${node.parent.name}" group="signal"/>
     <title type="link" role="topic">${node.name}</title>
   </info>
-  <title>${node.parent.ctype}::${node.name}</title>
+  <title>${formatter.format_page_name(node)}</title>
 ${formatter.format(node, node.doc)}
 </page>
diff --git a/giscanner/doctemplates/C/mallard-C-vfunc.tmpl b/giscanner/doctemplates/C/mallard-C-vfunc.tmpl
index 3a00d99..3363ea8 100644
--- a/giscanner/doctemplates/C/mallard-C-vfunc.tmpl
+++ b/giscanner/doctemplates/C/mallard-C-vfunc.tmpl
@@ -8,7 +8,7 @@
   <info>
     <link type="guide" xref="${namespace.name}.${node.parent.name}" group="vfunc"/>
   </info>
-  <title>${node.name}</title>
+  <title>${formatter.format_page_name(node)}</title>
 <synopsis><code mime="text/x-csrc">
 </code></synopsis>
 ${formatter.format(node, node.doc)}
diff --git a/giscanner/doctemplates/Python/mallard-Python-class.tmpl b/giscanner/doctemplates/Python/mallard-Python-class.tmpl
index 6eef692..800d241 100644
--- a/giscanner/doctemplates/Python/mallard-Python-class.tmpl
+++ b/giscanner/doctemplates/Python/mallard-Python-class.tmpl
@@ -8,7 +8,7 @@
   <info>
     <link type="guide" xref="index" group="class"/>
   </info>
-  <title>${namespace.name}.${node.name}</title>
+  <title>${formatter.format_page_name(node)}</title>
 ${formatter.format(node, node.doc)}
 
   <synopsis><code>
diff --git a/giscanner/doctemplates/Python/mallard-Python-default.tmpl b/giscanner/doctemplates/Python/mallard-Python-default.tmpl
index 7bc55d8..1d20210 100644
--- a/giscanner/doctemplates/Python/mallard-Python-default.tmpl
+++ b/giscanner/doctemplates/Python/mallard-Python-default.tmpl
@@ -6,6 +6,6 @@
       xmlns:ui="http://projectmallard.org/experimental/ui/";>
   <info>
   </info>
-  <title>${namespace.name}.${node.name}</title>
+  <title>${formatter.format_page_name(node)}</title>
 ${formatter.format(node, node.doc)}
 </page>
diff --git a/giscanner/doctemplates/Python/mallard-Python-enum.tmpl b/giscanner/doctemplates/Python/mallard-Python-enum.tmpl
index 55ebdf5..c1a4d8c 100644
--- a/giscanner/doctemplates/Python/mallard-Python-enum.tmpl
+++ b/giscanner/doctemplates/Python/mallard-Python-enum.tmpl
@@ -7,7 +7,7 @@
   <info>
     <link type="guide" xref="index"/>
   </info>
-  <title>${node.namespace.name}.${node.name}</title>
+  <title>${formatter.format_page_name(node)}</title>
   ${formatter.format(node, node.doc)}
 % if node.members:
 <table>
diff --git a/giscanner/doctemplates/Python/mallard-Python-function.tmpl b/giscanner/doctemplates/Python/mallard-Python-function.tmpl
index 405f2c3..1976a1c 100644
--- a/giscanner/doctemplates/Python/mallard-Python-function.tmpl
+++ b/giscanner/doctemplates/Python/mallard-Python-function.tmpl
@@ -34,7 +34,7 @@
 % endfor
     </api:function>
   </info>
-  <title>${node.name}</title>
+  <title>${formatter.format_page_name(node)}</title>
 <synopsis><code mime="text/x-python">
 % if len(node.parameters) != 0:
 @accepts(\
diff --git a/giscanner/doctemplates/Python/mallard-Python-namespace.tmpl b/giscanner/doctemplates/Python/mallard-Python-namespace.tmpl
index 4ccf452..97bd713 100644
--- a/giscanner/doctemplates/Python/mallard-Python-namespace.tmpl
+++ b/giscanner/doctemplates/Python/mallard-Python-namespace.tmpl
@@ -6,7 +6,7 @@
       xmlns:ui="http://projectmallard.org/experimental/ui/";>
   <info>
   </info>
-  <title>${node.name} Documentation</title>
+  <title>${formatter.format_page_name(node)}</title>
   <links type="topic" ui:expanded="yes" groups="class">
     <title>Classes</title>
   </links>
diff --git a/giscanner/doctemplates/Python/mallard-Python-property.tmpl b/giscanner/doctemplates/Python/mallard-Python-property.tmpl
index 47187a7..7f4138c 100644
--- a/giscanner/doctemplates/Python/mallard-Python-property.tmpl
+++ b/giscanner/doctemplates/Python/mallard-Python-property.tmpl
@@ -8,7 +8,7 @@
     <link type="guide" xref="${namespace.name}.${node.parent.name}" group="property"/>
     <title type="link" role="topic">${node.name}</title>
   </info>
-  <title>${namespace.name}.${node.parent.name}:${node.name}</title>
+  <title>${formatter.format_page_name(node)}</title>
 <synopsis><code mime="text/x-python">
 "${node.name}"             ${formatter.format_type(node.type)}                : ${formatter.format_property_flags(node)}
 </code></synopsis>
diff --git a/giscanner/doctemplates/Python/mallard-Python-record.tmpl b/giscanner/doctemplates/Python/mallard-Python-record.tmpl
index f6abd11..43bea04 100644
--- a/giscanner/doctemplates/Python/mallard-Python-record.tmpl
+++ b/giscanner/doctemplates/Python/mallard-Python-record.tmpl
@@ -7,6 +7,6 @@
   <info>
     <link type="guide" xref="index"/>
   </info>
-  <title>${node.namespace.name}${node.name}</title>
+  <title>${formatter.format_page_name(node)}</title>
   <p>${node.doc}</p>
 </page>
diff --git a/giscanner/doctemplates/Python/mallard-Python-signal.tmpl b/giscanner/doctemplates/Python/mallard-Python-signal.tmpl
index 7bfaf9c..8dda89b 100644
--- a/giscanner/doctemplates/Python/mallard-Python-signal.tmpl
+++ b/giscanner/doctemplates/Python/mallard-Python-signal.tmpl
@@ -8,7 +8,7 @@
     <link type="guide" xref="${namespace.name}.${node.parent.name}" group="signal"/>
     <title type="link" role="topic">${node.name}</title>
   </info>
-  <title>${namespace.name}.${node.parent.name}::${node.name}</title>
+  <title>${formatter.format_page_name(node)}</title>
 <synopsis><code mime="text/x-python">
 def callback(${formatter.to_underscores(node.parent.name).lower()}, \
 % for arg, ix in zip(node.parameters, range(len(node.parameters))):
diff --git a/giscanner/doctemplates/Python/mallard-Python-vfunc.tmpl b/giscanner/doctemplates/Python/mallard-Python-vfunc.tmpl
index 2437e56..86dc685 100644
--- a/giscanner/doctemplates/Python/mallard-Python-vfunc.tmpl
+++ b/giscanner/doctemplates/Python/mallard-Python-vfunc.tmpl
@@ -9,7 +9,7 @@
     <link type="guide" xref="${namespace.name}.${node.parent.name}" group="vfunc"/>
     <title type="link" role="topic">${node.name}</title>
   </info>
-  <title>${namespace.name}.${node.parent.name}.${node.name}</title>
+  <title>${formatter.format_page_name(node)}</title>
 <synopsis><code mime="text/x-python">
 % if len(node.parameters) != 0:
 @accepts(\
diff --git a/tests/doctool/DocExamples-1.0-C-expected/DocExamples.Obj-property-example.page b/tests/doctool/DocExamples-1.0-C-expected/DocExamples.Obj-property-example.page
index e7702a2..fde0ffb 100644
--- a/tests/doctool/DocExamples-1.0-C-expected/DocExamples.Obj-property-example.page
+++ b/tests/doctool/DocExamples-1.0-C-expected/DocExamples.Obj-property-example.page
@@ -8,6 +8,6 @@
     <link type="guide" xref="DocExamples.Obj" group="property"/>
     <title type="link" role="topic">property-example</title>
   </info>
-  <title>DocExamplesObj:property-example</title>
+  <title>DocExamples.Obj:property-example</title>
 <p>This is an example of how to document a property.</p>
 </page>
diff --git a/tests/doctool/DocExamples-1.0-C-expected/DocExamples.Obj-signal-example.page b/tests/doctool/DocExamples-1.0-C-expected/DocExamples.Obj-signal-example.page
index 548588c..7f63fa4 100644
--- a/tests/doctool/DocExamples-1.0-C-expected/DocExamples.Obj-signal-example.page
+++ b/tests/doctool/DocExamples-1.0-C-expected/DocExamples.Obj-signal-example.page
@@ -8,6 +8,6 @@
     <link type="guide" xref="DocExamples.Obj" group="signal"/>
     <title type="link" role="topic">signal-example</title>
   </info>
-  <title>DocExamplesObj::signal-example</title>
+  <title>DocExamples.Obj::signal-example</title>
 <p>This is an example of how to document a signal.</p>
 </page>
diff --git a/tests/doctool/DocExamples-1.0-C-expected/DocExamples.Obj-vfunc.page b/tests/doctool/DocExamples-1.0-C-expected/DocExamples.Obj-vfunc.page
index 345d64b..c9b4766 100644
--- a/tests/doctool/DocExamples-1.0-C-expected/DocExamples.Obj-vfunc.page
+++ b/tests/doctool/DocExamples-1.0-C-expected/DocExamples.Obj-vfunc.page
@@ -8,7 +8,7 @@
   <info>
     <link type="guide" xref="DocExamples.Obj" group="vfunc"/>
   </info>
-  <title>vfunc</title>
+  <title>DocExamples.Obj::vfunc</title>
 <synopsis><code mime="text/x-csrc">
 </code></synopsis>
 <p>This is an example of how to document a vfunc.</p>
diff --git a/tests/doctool/DocExamples-1.0-C-expected/DocExamples.Obj.page b/tests/doctool/DocExamples-1.0-C-expected/DocExamples.Obj.page
index 0a46bd2..6014906 100644
--- a/tests/doctool/DocExamples-1.0-C-expected/DocExamples.Obj.page
+++ b/tests/doctool/DocExamples-1.0-C-expected/DocExamples.Obj.page
@@ -8,7 +8,7 @@
   <info>
     <link type="guide" xref="index" group="class"/>
   </info>
-  <title>DocExamplesObj</title>
+  <title>DocExamples.Obj</title>
 <p>This is an example of how to document a class</p><p>This class has a signal: <link xref="DocExamples.Obj-signal-example">DocExamples.Obj::signal-example</link>.</p><p>And also has a property: <link xref="DocExamples.Obj-property-example">DocExamples.Obj:property-example</link>.</p>
 <p>Since 0.99</p>
   <synopsis ui:expanded="no">
diff --git a/tests/doctool/DocExamples-1.0-C-expected/DocExamples.ObjClass.page b/tests/doctool/DocExamples-1.0-C-expected/DocExamples.ObjClass.page
index c3a958d..c8e4375 100644
--- a/tests/doctool/DocExamples-1.0-C-expected/DocExamples.ObjClass.page
+++ b/tests/doctool/DocExamples-1.0-C-expected/DocExamples.ObjClass.page
@@ -7,6 +7,6 @@
   <info>
     <link type="guide" xref="index"/>
   </info>
-  <title>DocExamplesObjClass</title>
+  <title>DocExamples.ObjClass</title>
 
 </page>
diff --git a/tests/doctool/DocExamples-1.0-C-expected/index.page b/tests/doctool/DocExamples-1.0-C-expected/index.page
index a61ea75..c87a104 100644
--- a/tests/doctool/DocExamples-1.0-C-expected/index.page
+++ b/tests/doctool/DocExamples-1.0-C-expected/index.page
@@ -6,7 +6,7 @@
       xmlns:ui="http://projectmallard.org/experimental/ui/";>
   <info>
   </info>
-  <title>DocExamples Documentation</title>
+  <title>Index</title>
   <links type="topic" ui:expanded="yes" groups="class" style="linklist">
     <title>Classes</title>
   </links>
diff --git a/tests/doctool/DocExamples-1.0-Python-expected/DocExamples.Obj-vfunc.page b/tests/doctool/DocExamples-1.0-Python-expected/DocExamples.Obj-vfunc.page
index 4f56bae..8a02f61 100644
--- a/tests/doctool/DocExamples-1.0-Python-expected/DocExamples.Obj-vfunc.page
+++ b/tests/doctool/DocExamples-1.0-Python-expected/DocExamples.Obj-vfunc.page
@@ -9,7 +9,7 @@
     <link type="guide" xref="DocExamples.Obj" group="vfunc"/>
     <title type="link" role="topic">vfunc</title>
   </info>
-  <title>DocExamples.Obj.vfunc</title>
+  <title>DocExamples.Obj::vfunc</title>
 <synopsis><code mime="text/x-python">
 @accepts(int)
 @returns(none)
diff --git a/tests/doctool/DocExamples-1.0-Python-expected/DocExamples.Obj.method.page b/tests/doctool/DocExamples-1.0-Python-expected/DocExamples.Obj.method.page
index 748add8..2477e45 100644
--- a/tests/doctool/DocExamples-1.0-Python-expected/DocExamples.Obj.method.page
+++ b/tests/doctool/DocExamples-1.0-Python-expected/DocExamples.Obj.method.page
@@ -38,7 +38,7 @@
       </api:arg>
     </api:function>
   </info>
-  <title>method</title>
+  <title>Obj.method</title>
 <synopsis><code mime="text/x-python">
 @accepts(int, float, bool, gpointer, unicode)
 @returns(bool)
diff --git a/tests/doctool/DocExamples-1.0-Python-expected/DocExamples.Obj.static_method.page b/tests/doctool/DocExamples-1.0-Python-expected/DocExamples.Obj.static_method.page
index efbdc41..e040414 100644
--- a/tests/doctool/DocExamples-1.0-Python-expected/DocExamples.Obj.static_method.page
+++ b/tests/doctool/DocExamples-1.0-Python-expected/DocExamples.Obj.static_method.page
@@ -18,7 +18,7 @@
       </api:arg>
     </api:function>
   </info>
-  <title>static_method</title>
+  <title>Obj.static_method</title>
 <synopsis><code mime="text/x-python">
 @accepts(int)
 @returns(bool)
diff --git a/tests/doctool/DocExamples-1.0-Python-expected/index.page b/tests/doctool/DocExamples-1.0-Python-expected/index.page
index fc6a9b7..bbf9d2d 100644
--- a/tests/doctool/DocExamples-1.0-Python-expected/index.page
+++ b/tests/doctool/DocExamples-1.0-Python-expected/index.page
@@ -6,7 +6,7 @@
       xmlns:ui="http://projectmallard.org/experimental/ui/";>
   <info>
   </info>
-  <title>DocExamples Documentation</title>
+  <title>Index</title>
   <links type="topic" ui:expanded="yes" groups="class">
     <title>Classes</title>
   </links>
[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]