GNOME.org
 

[gnome-doc-utils] [mallard] Give info_name and info_email their own pages, allow ext attrs

commit 2e0cbb22aabfe8baee95f3e5a120a5280ee6ea25
Author: Shaun McCance <shaunm gnome org>
Date:   Sun Aug 2 11:49:49 2009 -0500

    [mallard] Give info_name and info_email their own pages, allow ext attrs

 doc/mallard/C/mal_info.page           |   11 ++++-
 doc/mallard/C/mal_info_copyright.page |    9 ++--
 doc/mallard/C/mal_info_credit.page    |    7 ++-
 doc/mallard/C/mal_info_email.page     |   81 +++++++++++++++++++++++++++++
 doc/mallard/C/mal_info_name.page      |   90 +++++++++++++++++++++++++++++++++
 doc/mallard/Makefile.am               |    4 ++
 6 files changed, 194 insertions(+), 8 deletions(-)
---
diff --git a/doc/mallard/C/mal_info.page b/doc/mallard/C/mal_info.page
index ee7e5c3..65a59df 100644
--- a/doc/mallard/C/mal_info.page
+++ b/doc/mallard/C/mal_info.page
@@ -8,7 +8,7 @@
   <revision version="0.1" date="2008-02-21" status="stub"/>
 </info>
 
-<title>Page Information</title>
+<title>Informational Elements</title>
 
 <synopsis><code mime="application/relax-ng-compact-syntax">
 mal_info = element info {
@@ -50,4 +50,13 @@ link (guide/page/seealso)
 </section>
 <!-- END elements -->
 
+<!-- BEGIN additional -->
+<section id="additional">
+  <info>
+    <title type="link">Additional Informational Elements</title>
+  </info>
+  <title>Additional Elements</title>
+</section>
+<!-- END additional -->
+
 </page>
diff --git a/doc/mallard/C/mal_info_copyright.page b/doc/mallard/C/mal_info_copyright.page
index f54559c..bfedfe8 100644
--- a/doc/mallard/C/mal_info_copyright.page
+++ b/doc/mallard/C/mal_info_copyright.page
@@ -27,10 +27,11 @@
 mal_info_copyright = element copyright {
   attribute * - (mal:* | local:*) { text } *,
 
-  ( element year { text } +
-  &amp; element name { <link xref="mal_inline">mal_inline</link> }
-  &amp; element email { <link xref="mal_inline">mal_inline</link> } ?
-  &amp; element * - (mal:* | local:*) { mal_inline } *
+  (
+    element year { text } + &amp;
+    <link xref="mal_info_name">mal_info_name</link> &amp;
+    <link xref="mal_info_email">mal_info_email</link> ? &amp;
+    element * - (mal:* | local:*) { mal_inline } *
   )
 }
 </code></synopsis>
diff --git a/doc/mallard/C/mal_info_credit.page b/doc/mallard/C/mal_info_credit.page
index 79f398b..be15025 100644
--- a/doc/mallard/C/mal_info_credit.page
+++ b/doc/mallard/C/mal_info_credit.page
@@ -31,9 +31,10 @@ mal_info_credit = element credit {
     "translator" | "publisher"    } ?,
   attribute * - (mal:* | local:*) { text } *,
 
-  ( element name { <link xref="mal_inline">mal_inline</link> }
-  &amp; element email { <link xref="mal_inline">mal_inline</link> } ?
-  &amp; element * - (mal:* | local:*) { mal_inline } *
+  (
+    <link xref="mal_info_name">mal_info_name</link> &amp;
+    <link xref="mal_info_email">mal_info_email</link> ? &amp;
+    element * - (mal:* | local:*) { mal_inline } *
   )
 }
 </code></synopsis>
diff --git a/doc/mallard/C/mal_info_email.page b/doc/mallard/C/mal_info_email.page
new file mode 100644
index 0000000..0a51fce
--- /dev/null
+++ b/doc/mallard/C/mal_info_email.page
@@ -0,0 +1,81 @@
+<page xmlns="http://projectmallard.org/1.0/";
+      type="topic"
+      id="mal_info_email">
+
+<info>
+  <link type="guide" xref="mal_info#additional"/>
+
+  <revision version="0.1" date="2009-08-01" status="review"/>
+
+  <credit type="author">
+    <name>Shaun McCance</name>
+    <email>shaunm gnome org</email>
+  </credit>
+  <copyright>
+    <year>2009</year>
+    <name>Shaun McCance</name>
+  </copyright>
+
+  <include href="legal.xml" xmlns="http://www.w3.org/2001/XInclude"; />
+
+  <desc>FIXME</desc>
+</info>
+
+<title>Email Addresses</title>
+
+<synopsis><code mime="application/relax-ng-compact-syntax">
+mal_info_email = element email {
+  attribute * - (mal:* | local:*) { text } *,
+  <link xref="mal_inline">mal_inline</link>
+}
+</code></synopsis>
+
+<p>Use the <code>email</code> element to mark up the email address for a
+person or organization in a <code xref="mal_info_copyright">copyright</code>
+or <code xref="mal_info_credit">credit</code> element.</p>
+
+
+<!-- BEGIN notes -->
+<section id="notes">
+  <title>Notes</title>
+  <list>
+    <item><p>The <code>email</code> element can contain a mixture of text and
+    any <link xref="mal_inline">general inline elements</link>.</p></item>
+
+    <item><p>The <code>email</code> element can occur in a
+    <code xref="mal_info_copyright">copyright</code> or
+    <code xref="mal_info_credit">credit</code> element.</p></item>
+
+    <item><p>The <code>email</code> element can have attributes from external
+    namespaces.  See <link xref="mal_external"/> for more information
+    on external-namespace attributes.</p></item>
+  </list>
+</section>
+<!-- END notes -->
+
+
+<!-- BEGIN processing -->
+<section id="processing">
+  <title>Processing Expectations</title>
+
+  <p>See the processing expectations for the
+  <code xref="mal_info_copyright">copyright</code> and
+  <code xref="mal_info_credit">credit</code> elements.</p>
+</section>
+<!-- END processing -->
+
+
+<!-- BEGIN comparison -->
+<section id="comparison">
+  <title>Comparison to Other Formats</title>
+
+  <p>The <code>email</code> element is similar to the
+  <code href="http://www.docbook.org/tdg/en/html/email.html";>code</code>
+  element in DocBook when that element is used in an informational context.
+  The <code>email</code> element in Mallard does not double as an inline
+  element.</p>
+</section>
+<!-- END comparison -->
+
+
+</page>
diff --git a/doc/mallard/C/mal_info_name.page b/doc/mallard/C/mal_info_name.page
new file mode 100644
index 0000000..5438d58
--- /dev/null
+++ b/doc/mallard/C/mal_info_name.page
@@ -0,0 +1,90 @@
+<page xmlns="http://projectmallard.org/1.0/";
+      type="topic"
+      id="mal_info_name">
+
+<info>
+  <link type="guide" xref="mal_info#additional"/>
+
+  <revision version="0.1" date="2009-08-01" status="review"/>
+
+  <credit type="author">
+    <name>Shaun McCance</name>
+    <email>shaunm gnome org</email>
+  </credit>
+  <copyright>
+    <year>2009</year>
+    <name>Shaun McCance</name>
+  </copyright>
+
+  <include href="legal.xml" xmlns="http://www.w3.org/2001/XInclude"; />
+
+  <desc>FIXME</desc>
+</info>
+
+<title>Names</title>
+
+<synopsis><code mime="application/relax-ng-compact-syntax">
+mal_info_name = element name {
+  attribute * - (mal:* | local:*) { text } *,
+  <link xref="mal_inline">mal_inline</link>
+}
+</code></synopsis>
+
+<p>Use the <code>name</code> element to mark up the name of a person or
+organization in a <code xref="mal_info_copyright">copyright</code> or
+<code xref="mal_info_credit">credit</code> element.</p>
+
+
+<!-- BEGIN notes -->
+<section id="notes">
+  <title>Notes</title>
+  <list>
+    <item><p>The <code>name</code> element can contain a mixture of text and
+    any <link xref="mal_inline">general inline elements</link>.</p></item>
+
+    <item><p>The <code>name</code> element can occur in a
+    <code xref="mal_info_copyright">copyright</code> or
+    <code xref="mal_info_credit">credit</code> element.</p></item>
+
+    <item><p>The <code>name</code> element can have attributes from external
+    namespaces.  See <link xref="mal_external"/> for more information
+    on external-namespace attributes.</p></item>
+  </list>
+</section>
+<!-- END notes -->
+
+
+<!-- BEGIN processing -->
+<section id="processing">
+  <title>Processing Expectations</title>
+
+  <p>See the processing expectations for the
+  <code xref="mal_info_copyright">copyright</code> and
+  <code xref="mal_info_credit">credit</code> elements.</p>
+</section>
+<!-- END processing -->
+
+
+<!-- BEGIN comparison -->
+<section id="comparison">
+  <title>Comparison to Other Formats</title>
+
+  <p>In a <code xref="mal_info_copyright">copyright</code> element, the
+  <code>name</code> element is similar to the
+  <code href="http://www.docbook.org/tdg/en/html/holder.html";>holder</code>
+  element in DocBook.</p>
+
+  <p>In a <code xref="mal_info_credit">credit</code> element, the <code>name</code>
+  element fulfills the same role as numerous DocBook elements, including
+  <link href="http://www.docbook.org/tdg/en/html/collabname.html";>collabname</link>,
+  <link xref="http://www.docbook.org/tdg/en/html/personname.html";>personname</link>, and
+  <link xref="http://www.docbook.org/tdg/en/html/publishername.html";>publishername</link>.
+  Note that Mallard does not attempt to model the names of people, as the rules for
+  how to display names from their constituent parts vary considerably.  If parts of
+  a name are needed for a domain-specific purpose, they can be included using elements
+  from external namespaces on the parent element.</p>
+</section>
+<!-- END comparison -->
+
+
+</page>
diff --git a/doc/mallard/Makefile.am b/doc/mallard/Makefile.am
index 093c32a..14a53cf 100644
--- a/doc/mallard/Makefile.am
+++ b/doc/mallard/Makefile.am
@@ -1,3 +1,5 @@
+AUTOMAKE_OPTIONS = -Wno-portability
+
 include $(top_srcdir)/tools/gnome-doc-utils.make
 include $(top_srcdir)/bootstrap.make
 dist-hook: doc-dist-hook
@@ -44,8 +46,10 @@ DOC_PAGES =				\
 	mal_info_copyright.page		\
 	mal_info_credit.page		\
 	mal_info_desc.page		\
+	mal_info_email.page		\
 	mal_info_license.page		\
 	mal_info_link.page		\
+	mal_info_name.page		\
 	mal_info.page			\
 	mal_info_revision.page		\
 	mal_info_title.page		\
[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]