summaryrefslogtreecommitdiff
path: root/sandbox/mallard/spec/mal_comment.xml
diff options
context:
space:
mode:
Diffstat (limited to 'sandbox/mallard/spec/mal_comment.xml')
-rw-r--r--sandbox/mallard/spec/mal_comment.xml49
1 files changed, 49 insertions, 0 deletions
diff --git a/sandbox/mallard/spec/mal_comment.xml b/sandbox/mallard/spec/mal_comment.xml
new file mode 100644
index 0000000..59fea8f
--- /dev/null
+++ b/sandbox/mallard/spec/mal_comment.xml
@@ -0,0 +1,49 @@
+<topic xmlns="http://www.gnome.org/~shaunm/mallard"
+ id="mal_comment">
+<info>
+ <link type="guide" xref="mal_block#containers"/>
+</info>
+
+<title>Editorial Comments</title>
+
+<synopsis><code mime="application/relax-ng-compact-syntax">
+mal_comment = element comment {
+ <link xref="mal_attr">mal_attr_common</link>,
+ <link xref="mal_title">mal_title</link>?,
+ <link xref="mal_cite">mal_cite</link>,
+ <link xref="mal_block#simple">mal_block_simple</link>+,
+ mal_comment*
+}
+</code></synopsis>
+
+<p>The <code>comment</code> element allows you to insert editorial comments
+into your document. These comments are intended to be displayed only when
+editing or reviewing the document, and not when the document is viewed by the
+end reader. A <code>comment</code> element can contain other <code>comment</code>
+elements, allowing you to have a threaded discussion inside editorial comments.</p>
+
+<p>A <code>comment</code> element may optionally contain a
+<code xref="mal_title">title</code> element to provide a brief description
+of the subject of the comment. Titles are encouraged in top-level comments;
+however, they are usually unnecessary in replies.</p>
+
+<!-- FIXME
+<p>The <code xref="mal_credit">credit</code> element is a required element
+that specifies the person making the comment. The content model for the
+<code>credit</code> element is specified in <link xref="mal_credit"/>, but
+the element is listed here explicitly to prohimit the <code>type</code>
+attribute. Writers are highly encouraged to provide a <code xref="mal_date">mal_date</code>
+</p>
+-->
+
+<comment>
+ <cite><name>Shaun McCance</name><date>2006-11-16</date></cite>
+ <p>Add examples, processing expectations</p>
+
+ <comment>
+ <cite><name>Shaun McCance</name><date>2007-01-23</date></cite>
+ <p>This is a test of nested comments.</p>
+ </comment>
+</comment>
+
+</topic>