DocumentConventions

From Device Description Working Group Wiki
Revision as of 19:41, 17 September 2008 by Ot (Talk | contribs)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

Document Conventions

These are the styles used in DDWG wiki documents to help readers to better understand the documents.

New Material

* This is a new paragraph. It is indicated by the star at the beginning. Readers should note that this new material differs from any previously officially published (non-wiki) documents. New material within wiki documents can be discovered via the wiki's RecentChanges page, or the Diff feature.

This is a modified paragraph. It contains four sentences. * This is new material added to the end of the paragraph. The new material brings the sentence count up to four.

This is a modified paragraph. * This is an inserted sentence. This is an existing sentence from the original paragraph.

This sentence has been deleted. * This is the replacement sentence.

Note: All substantive new material in the wiki is alerted to the readership via the mailing list.

Comments

This is an existing paragraph. It contains two sentences. ¤ This is a comment added to the end of a paragraph. Comments are here to draw your attention to an important issue relating to this paragraph.

¤ This is a stand-alone comment paragraph. It relates to the entire section in which this paragraph is a part.

This is an existing paragraph. ¤ This is an embedded comment.

Editor Notes

NOTE: This is an editor's note, strongly highlighted. Such notes draw the reader to substantive issues.

Code and Markup

Begin
  // This is a sample code block
  <note>
    Which can also be used to present markup.
  </note>
End

Disputed Text

Where there is a dispute about the text in a wiki page, the nature of the dispute is highlighted by an editor's note or ¤ ! comment, and there is a link to the public mailing list message(s) where the details of the dispute are recorded.

Resolved Text

When a dispute has been resolved, the agreed text is placed into the wiki as * OK new text and followed by a ¤ comment to indicate the resolution, and where possible to point to the public mailing list where the resolution is recorded.