[gnome-doc-utils/mallard: 58/87] Adding Just Enough Markup link
- From: Shaun McCance <shaunm src gnome org>
- To: svn-commits-list gnome org
- Subject: [gnome-doc-utils/mallard: 58/87] Adding Just Enough Markup link
- Date: Sun, 19 Apr 2009 12:19:13 -0400 (EDT)
commit 1559f2ca6745fed4afbe5fb007ad6fc8dde4dcbf
Author: Shaun McCance <shaunm gnome org>
Date: Mon Dec 1 18:32:21 2008 -0600
Adding Just Enough Markup link
---
doc/mallard/C/mal_inline_cmd.xml | 4 ++++
doc/mallard/C/mal_inline_code.xml | 2 ++
doc/mallard/C/mal_inline_gui.xml | 6 ++----
doc/mallard/C/mal_inline_sys.xml | 2 ++
4 files changed, 10 insertions(+), 4 deletions(-)
diff --git a/doc/mallard/C/mal_inline_cmd.xml b/doc/mallard/C/mal_inline_cmd.xml
index a16a684..167fd71 100644
--- a/doc/mallard/C/mal_inline_cmd.xml
+++ b/doc/mallard/C/mal_inline_cmd.xml
@@ -146,15 +146,19 @@ you to filter files based on their modification times.</p>
<!-- BEGIN docbook -->
<section id="docbook">
<title>Comparison to DocBook</title>
+
<p>The <code>cmd</code> element is similar to the
<code href="http://www.docbook.org/tdg/en/html/command.html">command</code>
element in DocBook. In DocBook, writers frequently use the
<code href="http://www.docbook.org/tdg/en/html/option.html">option</code>
element inside <code>command</code>. Mallard does not provide an element
for this purpose.</p>
+
<p>In DocBook, the <code>option</code> element is also used outside the
<code>command</code> element. In Mallard, simply use the <code>cmd</code>
element for options outside of an entire command.</p>
+
+ <p>See <link xref="principle-justenough"/> for more background.</p>
</section>
<!-- END docbook -->
diff --git a/doc/mallard/C/mal_inline_code.xml b/doc/mallard/C/mal_inline_code.xml
index a1620ea..7ca6416 100644
--- a/doc/mallard/C/mal_inline_code.xml
+++ b/doc/mallard/C/mal_inline_code.xml
@@ -113,6 +113,8 @@ by the user.</p>
in place of the DocBook elements
<code href="http://www.docbook.org/tdg/en/html/markup.html">markup</code> and
<code href="http://www.docbook.org/tdg/en/html/sgmltag.html">sgmltag</code>.</p>
+
+ <p>See <link xref="principle-justenough"/> for more background.</p>
</section>
<!-- END docbook -->
diff --git a/doc/mallard/C/mal_inline_gui.xml b/doc/mallard/C/mal_inline_gui.xml
index 280f51c..575b205 100644
--- a/doc/mallard/C/mal_inline_gui.xml
+++ b/doc/mallard/C/mal_inline_gui.xml
@@ -87,10 +87,8 @@ mal_inline_gui = element gui {
on a single element. Furthermore, DocBook's various elements are nowhere near
exhaustive. Thus, authors must frequently either abuse a specific element or
use the deprecated <code>interface</code> element.</p>
- <comment>
- <cite date="2008-11-09"><name>Shaun McCance</name></cite>
- <p>See principle of just enough markup</p>
- </comment>
+
+ <p>See <link xref="principle-justenough"/> for more background.</p>
</section>
<!-- END docbook -->
diff --git a/doc/mallard/C/mal_inline_sys.xml b/doc/mallard/C/mal_inline_sys.xml
index 1f2c1b7..b93d391 100644
--- a/doc/mallard/C/mal_inline_sys.xml
+++ b/doc/mallard/C/mal_inline_sys.xml
@@ -52,6 +52,8 @@ mal_inline_sys = element sys {
element. Since Mallard does not provide the level of markup specificity
that DocBook does, the <code>sys</code> element should be used in place
of these and various other elements.</p>
+
+ <p>See <link xref="principle-justenough"/> for more background.</p>
</section>
<!-- END docbook -->
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]