From be7d9e4a7349bc10bd9c162b5a4b306872b17b43 Mon Sep 17 00:00:00 2001 From: Shaun McCance Date: Thu, 28 May 2009 20:23:28 -0500 Subject: [mallard] Finishing info_credit and info_copyright --- doc/mallard/C/mal_info_copyright.xml | 72 ++++++++++++++++++-- doc/mallard/C/mal_info_credit.xml | 127 ++++++++++++++++++++++++++++++++--- 2 files changed, 186 insertions(+), 13 deletions(-) diff --git a/doc/mallard/C/mal_info_copyright.xml b/doc/mallard/C/mal_info_copyright.xml index 3020625..2dd4945 100644 --- a/doc/mallard/C/mal_info_copyright.xml +++ b/doc/mallard/C/mal_info_copyright.xml @@ -5,6 +5,8 @@ + + Shaun McCance shaunm@gnome.org @@ -16,17 +18,79 @@ - + Record information about copyright holders. Copyright Information mal_info_copyright = element copyright { - element year { text } +, - element name { mal_inline }, - element email { mal_inline } ? + attribute * - (mal:* | local:*) { text } *, + + ( element year { text } + + & element name { mal_inline } + & element email { mal_inline } ? + & element * - (mal:* | local:*) { mal_inline } * + ) } +

Use the copyright element to include information about the +copyright holders of the page or section. You can record the name and email +address of the copyright holder, as well as any years in which the holder +contributed copyrighted material.

+ + + +
+ Notes + +

The copyright element contains one or more year + elements, a name element, and an optional email element. + The copyright element can also contain elements from external + namespaces. The order of the child elements does not matter.

 + +

The copyright element can occur in any + info element.

 + +

The copyright element can have attributes from external + namespaces. See for more information + on external-namespace attributes.

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

There are no specific processing expectations for the copyright + element. As an informational element, it is not necessarily displayed. Some + tools, however, may choose to display copyrights at the bottom of a page, on a + separate information page, or in a dialog.

+ +

When processing the children of a copyright element, tools + should select the child elements they understand and ignore all other child + content.

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

The copyright element is similar to the + copyright + element in DocBook. Mallard allows more information to be recorded about a + particular copyright holder through informational child elements. In DocBook, + a single copyright element can have multiple + holder + children. In Mallard, each copyright element is restricted to + a single copyright holder.

+
+ + + diff --git a/doc/mallard/C/mal_info_credit.xml b/doc/mallard/C/mal_info_credit.xml index 705e595..7ecebb3 100644 --- a/doc/mallard/C/mal_info_credit.xml +++ b/doc/mallard/C/mal_info_credit.xml @@ -5,7 +5,20 @@ - + + + + Shaun McCance + shaunm@gnome.org + + + 2008 + Shaun McCance + + + + + Give credit where credit is due. Credits @@ -15,16 +28,112 @@ mal_info_credit = element credit { attribute type { "author" | "editor" | "maintainer" | "collaborator" | - "translator" | "publisher" }, - attribute date { xsd:date } ?, - element name { mal_inline }, - element email { mal_inline } ? + "translator" | "publisher" } ?, + attribute * - (mal:* | local:*) { text } *, + + ( element name { mal_inline } + & element email { mal_inline } ? + & element * - (mal:* | local:*) { mal_inline } * + ) } - - Shaun McCance -

Add examples, processing expectations

- +

Use the credit element to record credits for who has contributed +to the page or section. You can optionally use the type attribute +to specify what type of contribution the person has made. If a person has made +contributions in multiple roles, include multiple credit elements +for that person.

+ + + +
+ Notes + +

The credit element contains a name element + and an optional email element. The credit element + can also contain elements from external namespaces. The order of the child + elements does not matter.

 + +

The credit element can occur in any + info element.

 + + +

The optional type attribute can be used to specify + what type of contribution the person has made. The following values are + allowed:

+ + + + + + + + + + + + + + + + + + + + + + + + + + +

"author"

somebody responsible for writing content

"editor"

somebody who has provided reviews or editorial corrections

"maintainer"

the person or entity currently responsible for the work

"collaborator"

somebody who has provided extensive rough information

"translator"

somebody who has translated the work into another language

"publisher"

a person or entity who distributes formatted copies

+ + +

The credit element can have attributes from external + namespaces. See for more information + on external-namespace attributes.

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

There are no specific processing expectations for the credit + element. As an informational element, it is not necessarily displayed. Some + tools, however, may choose to display credits at the bottom of a page, on a + separate information page, or in a dialog.

+ +

When processing the children of a credit element, tools + should select the child elements they understand and ignore all other child + content.

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

The credit element serves the purpose of the + author, + collab, + corpauthor, + editor, + othercredit, and + publisher + elements in DocBook. DocBook does not have specific elements for maintainers + and translators.

+ +

In DocBook, certain credit elements have highly structured content, whereas + others allow simple inline text. In Mallard, all credits use simple structured + content. While Mallard does not provide child elements for everything that can + be recorded in DocBook, elements from external namespaces may be used for any + additional information that is needed.

+
+ -- cgit v1.2.1