docbook-tc — archive

more input on DocBook RFE #1190435 Add rule tag

From: Robert Stayton
To: [email protected]
Date: Fri, 07 Oct 2005 20:03:00 -0000

 MHonArc v2.5.0b2 -->
















docbook-tc message






[Date Prev]
 | [Thread Prev]
 | [Thread Next]
 | [Date Next]

--

[Date Index]
 | [Thread Index]
 | [List Home]








Subject: more input on DocBook RFE #1190435 Add rule tag




From: "Bob Stayton" <[email protected]>
To: "DocBook Technical Committee" <[email protected]>
Date: Fri, 7 Oct 2005 13:02:43 -0700






I asked for a response from the submitter for a use case.
Here is his response from the SourceForge Tracker.  You can respond
there if you have more questions.

----------------------------------------------------------------------------
-----
Consider for example a document that describe a set of
programming rules (eg. the one of
http://pcroot.cern.ch/TaligentDocs/TaligentOnline/DocumentRoot/1.0/Docs/books/WM/WM_21.html#HEADING31)

General description:
a rule describes a constraint applyed on a system or process

(here programming rules imposes constraints on software code
written in C++ among of a software developpment team)

Example of rule :
<rule>
  <title>Constructors and destructor</title>
  <ruledefinition>Every class should have a destructor and
at least one constructor</ruledefinition>
  <remark>Do this even if they do nothing or are defined to
do nothing. Be explicit; do not leave this up to the compiler.
  </remark>
</rule>

As far as I can see in
http://www.docbook.org/tdg/en/html/docbook.html, existing
docbook tags do not satisfy the need.

A procedure could be An optionnal subtag of rule, and in
that case it would define a procedure to chek/enforcethe rule.
----------------------------------------------------------------------------
--------

Bob Stayton
Sagehill Enterprises
DocBook Consulting
[email protected]
















[Date Prev]
 | [Thread Prev]
 | [Thread Next]
 | [Date Next]

--

[Date Index]
 | [Thread Index]
 | [List Home]