[gnome-doc-utils/mallard] [mallard] Finished inline_link and removed inline_quote.



commit a61c4844982da69d81a83262144c14e6babe2fcd
Author: Shaun McCance <shaunm gnome org>
Date:   Wed May 20 11:20:23 2009 -0500

    [mallard] Finished inline_link and removed inline_quote.
    
    I'm not wholly convinced that an inline quote element serves any
    useful purpose.  It never generates any styling effects.  It only
    adds punctuation.  Punctuation are just characters that, as far
    as I'm concerned, are properly part of the text content.
    
    Granted, it's useful for making fancy quotation marks, but I don't
    think it's worth the processing baggage.  It seems simple at first,
    but it turns out that the punctuation rules in different languages
    are tricky.  I think it's best that people just type the punctuation
    they intend to have.
---
 doc/mallard/C/mal_block_quote.xml  |    5 --
 doc/mallard/C/mal_inline.xml       |    4 +-
 doc/mallard/C/mal_inline_link.xml  |   49 +++++++++++++++++++++++-
 doc/mallard/C/mal_inline_quote.xml |   73 ------------------------------------
 4 files changed, 51 insertions(+), 80 deletions(-)

diff --git a/doc/mallard/C/mal_block_quote.xml b/doc/mallard/C/mal_block_quote.xml
index 53dd3c7..dd0cf00 100644
--- a/doc/mallard/C/mal_block_quote.xml
+++ b/doc/mallard/C/mal_block_quote.xml
@@ -3,8 +3,6 @@
       id="mal_block_quote">
 
 <info>
-  <link type="seealso" xref="mal_inline_quote"/>
-
   <version number="0.1" date="2009-05-19" status="review"/>
 
   <credit type="author">
@@ -72,9 +70,6 @@ and have it automatically formatted by display tools.</p>
     <item><p>The <code>quote</code> element can have attributes from external
     namespaces.  See <link xref="mal_external"/> for more information
     on external-namespace attributes.</p></item>
-
-    <item><p>The <code>quote</code> element may also be used in an inline context.
-    See <link xref="mal_inline_quote"/> for more information.</p></item>
   </list>
 </section>
 <!-- END notes -->
diff --git a/doc/mallard/C/mal_inline.xml b/doc/mallard/C/mal_inline.xml
index 0f76d20..5edabeb 100644
--- a/doc/mallard/C/mal_inline.xml
+++ b/doc/mallard/C/mal_inline.xml
@@ -38,7 +38,6 @@ mal_inline = mixed {
   <link xref="mal_inline_link">mal_inline_link</link> *,
   <link xref="mal_inline_media">mal_inline_media</link> *,
   <link xref="mal_inline_output">mal_inline_output</link> *,
-  <link xref="mal_inline_quote">mal_inline_quote</link> *,
   <link xref="mal_inline_span">mal_inline_span</link> *,
   <link xref="mal_inline_sys">mal_inline_sys</link> *,
   <link xref="mal_inline_var">mal_inline_var</link> *,
@@ -76,6 +75,9 @@ more information.</p>
 
 <!-- BEGIN processing -->
 <section id="processing">
+  <info>
+    <title type="link">Inline Processing Instructions</title>
+  </info>
   <title>Processing Expectations</title>
 
   <p>Inline elements occur within block elements or other inline elements.
diff --git a/doc/mallard/C/mal_inline_link.xml b/doc/mallard/C/mal_inline_link.xml
index 3c0e194..9d47cba 100644
--- a/doc/mallard/C/mal_inline_link.xml
+++ b/doc/mallard/C/mal_inline_link.xml
@@ -5,7 +5,7 @@
 <info>
   <link type="guide" xref="mal_inline#elements"/>
 
-  <version number="0.1" date="2007-02-05" status="incomplete"/>
+  <version number="0.1" date="2007-05-20" status="review"/>
 
   <credit type="author">
     <name>Shaun McCance</name>
@@ -17,6 +17,8 @@
   </copyright>
 
   <include href="legal.xml" xmlns="http://www.w3.org/2001/XInclude"; />
+
+  <desc>Link to other pages, sections, or web pages.</desc>
 </info>
 
 <title>Hyperlinks</title>
@@ -35,6 +37,13 @@ mal_inline_link = element link {
 }
 </code></synopsis>
 
+<p>Use the <code>link</code> to create a link to another page or section, or to
+an external resource such as a web page.  Most <link xref="mal_inline">inline
+elements</link> can act as links, but the <code>link</code> element allows you
+to create a link without any associated semantics.  The <code>link</code> element
+can also generate link text automatically for links to pages and sections within
+the same document.</p>
+
 
 <!-- BEGIN notes -->
 <section id="notes">
@@ -77,6 +86,44 @@ mal_inline_link = element link {
 <!-- BEGIN examples -->
 <section id="examples">
   <title>Examples</title>
+
+  <p>Link to another page in the same document:</p>
+
+  <example>
+    <code><![CDATA[
+See <link xref="mal_attr_link"/> for information on linking attributes.
+]]></code>
+    <p>See <link xref="mal_attr_link"/> for information on linking attributes.</p>
+  </example>
+
+  <p>Link to a section in the same page:</p>
+
+  <example>
+    <code><![CDATA[
+See <link xref="#processing"/> for details on automatic link text.
+]]></code>
+    <p>See <link xref="#processing"/> for details on automatic link text.</p>
+  </example>
+
+  <p>Link to a section in another page:</p>
+
+  <example>
+    <code><![CDATA[
+See <link xref="mal_inline#processing"/> for more processing expectations.
+]]></code>
+    <p>See <link xref="mal_inline#processing"/> for more processing expectations.</p>
+  </example>
+
+  <p>Link to an external resource:</p>
+
+  <example>
+    <code><![CDATA[
+See the <link href="http://www.w3.org/TR/REC-xml-names/";>XML Namespaces
+recommendation</link>.
+]]></code>
+    <p>See the <link href="http://www.w3.org/TR/REC-xml-names/";>XML Namespaces
+    recommendation</link>.</p>
+  </example>
 </section>
 <!-- END examples -->
 
diff --git a/doc/mallard/C/mal_inline_quote.xml b/doc/mallard/C/mal_inline_quote.xml
deleted file mode 100644
index 710ab08..0000000
--- a/doc/mallard/C/mal_inline_quote.xml
+++ /dev/null
@@ -1,73 +0,0 @@
-<page xmlns="http://www.gnome.org/~shaunm/mallard";
-      type="topic"
-      id="mal_inline_quote">
-
-<info>
-  <link type="guide" xref="mal_inline#elements"/>
-  <link type="seealso" xref="mal_block_quote"/>
-  <link type="seealso" xref="mal_attr_link"/>
-
-  <version number="0.1" date="2007-02-08" status="stub"/>
-
-  <credit type="author">
-    <name>Shaun McCance</name>
-    <email>shaunm gnome org</email>
-  </credit>
-  <copyright>
-    <year>2007-2009</year>
-    <name>Shaun McCance</name>
-  </copyright>
-
-  <include href="legal.xml" xmlns="http://www.w3.org/2001/XInclude"; />
-</info>
-
-<title>Quotes</title>
-
-<synopsis><code mime="application/relax-ng-compact-syntax">
-mal_inline_quote = element quote {
-  <link xref="mal_attr_link">mal_attr_link</link> ?,
-  attribute style { xsd:NMTOKENS } ?,
-  attribute * - (mal:* | local:*) { text } *,
-
-  <link xref="mal_inline">mal_inline</link>
-}
-</code></synopsis>
-
-<comment>
-  <cite date="2007-02-21"><name>Shaun McCance</name></cite>
-  <p>render quotes around inline</p>
-  <p>style="epipgraph"</p>
-</comment>
-
-<!-- BEGIN notes -->
-<section id="notes">
-  <title>Notes</title>
-  <list type="bullet">
-    <item><p>The <code>quote</code> element can contain a mixture of text and
-    any <link xref="mal_inline">general inline elements</link>.</p></item>
-
-    <item><p>The <code>quote</code> element can occur in any
-    general inline context, including inside most
-    <link xref="mal_inline">inline elements</link>, some
-    <link xref="mal_block#basic">basic block elements</link>, and certain
-    <link xref="mal_info">informational elements</link>.</p></item>
-
-    <item><p>The <code>quote</code> element can link to other pages or documents.
-    See <link xref="mal_attr_link"/> for more information.</p></item>
-
-    <item><p>The <code>style</code> attribute takes a space-separated list of
-    style hints.  Processing tools should adjust their behavior according to
-    those style hints they understand.</p></item>
-
-    <item><p>The <code>quote</code> element can have attributes from external
-    namespaces.  See <link xref="mal_external"/> for more information
-    on external-namespace attributes.</p></item>
-
-    <item><p>The <code>quote</code> element may also be used in a block context.
-    See <link xref="mal_block_quote"/> for more information.</p></item>
-  </list>
-</section>
-<!-- END notes -->
-
-
-</page>



[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]