From d1ca9f057261dc155e628b4af86a397b7cea0c17 Mon Sep 17 00:00:00 2001 From: Shaun McCance Date: Wed, 13 May 2009 16:17:09 -0500 Subject: [mallard] Finishing up some inline elements: input, sys, span --- doc/mallard/C/mal_inline_input.xml | 28 ++++++++++++++++--- doc/mallard/C/mal_inline_span.xml | 57 +++++++++++++++++++++++++++++++++++++- doc/mallard/C/mal_inline_sys.xml | 31 +++++++++++++++++++-- 3 files changed, 108 insertions(+), 8 deletions(-) diff --git a/doc/mallard/C/mal_inline_input.xml b/doc/mallard/C/mal_inline_input.xml index 1165e6c..1b49bdc 100644 --- a/doc/mallard/C/mal_inline_input.xml +++ b/doc/mallard/C/mal_inline_input.xml @@ -11,11 +11,11 @@ shaunm@gnome.org - 2008 + 2008-2009 Shaun McCance - + Mark up text the user should input into a computer program. @@ -74,8 +74,28 @@ or into a text field in a graphical application.

Examples - Shaun McCance -

Add examples

 +

Use input to mark up a user response to a prompt:

+ + + Y at the prompt to proceed.]]> +

Type Y at the prompt to proceed.

+ + +

Use input and output + inside a screen element:

+ + + +$ ls mal_inline_output.xml +mal_inline_output.xml + +]]> + +$ ls mal_inline_output.xml +mal_inline_output.xml + +
diff --git a/doc/mallard/C/mal_inline_span.xml b/doc/mallard/C/mal_inline_span.xml index 5ad4a32..5749c6b 100644 --- a/doc/mallard/C/mal_inline_span.xml +++ b/doc/mallard/C/mal_inline_span.xml @@ -6,7 +6,18 @@ - + + + + Shaun McCance + shaunm@gnome.org + + + 2007-2009 + Shaun McCance + + + A generic inline element that can be used for semantic, localization, and styling purpose. @@ -24,6 +35,11 @@ mal_inline_span = element span { } +

Use the span element to surround a run of text +without using any of the semantic inline +elements. This is frequently necessary for extensions +using attributes from external namespaces.

+
@@ -52,4 +68,43 @@ mal_inline_span = element span {
+ + +
+ Examples + +

Use span with an external-namespace attribute to mark a word + as untranslatable using the + Internationalization Tag Set:

+ + + word should not be translated.]]> +

This word should not be translated.

+ +
+ + + + +
+ Processing Expectations + +

No particular special rendering is required for span elements. + Processing tools may have special processing rules for certain style hints or + external-namespace attributes.

+
+ + + + +
+ Comparison to Other Formats +

The span element is similar to the + phrase + element in DocBook.

+
+ + diff --git a/doc/mallard/C/mal_inline_sys.xml b/doc/mallard/C/mal_inline_sys.xml index 3eea0f8..3dbb736 100644 --- a/doc/mallard/C/mal_inline_sys.xml +++ b/doc/mallard/C/mal_inline_sys.xml @@ -5,7 +5,16 @@ - + + Shaun McCance + shaunm@gnome.org + + + 2008-2009 + Shaun McCance + + + Mark up general identifiers found on computer systems. @@ -22,6 +31,11 @@ mal_inline_sys = element sys { } +

Use the sys element to mark up any type of system item that +isn't covered by other elements such as file, +cmd, or +code.

+
@@ -54,6 +68,13 @@ mal_inline_sys = element sys {
Examples + +

Use sys to mark up a domain name:

+ + + git.kernel.org.]]> +

The Linux kernel is hosted on git.kernel.org.

+
@@ -61,6 +82,12 @@ mal_inline_sys = element sys {
Processing Expectations + +

System items are displayed in a fixed-width font. Fixed-width fonts + tend to have more distinction between visually similar characters. This + is particularly important in system items, since letters often appear + without the context of a known word that helps make them discernable in + normal prose.

@@ -75,8 +102,6 @@ mal_inline_sys = element sys { element. Since Mallard does not provide the level of markup specificity that DocBook does, the sys element should be used in place of these and various other elements.

- -

See for more background.

-- cgit v1.2.1