Stage 3 proposal: Feature 13114

Proposal to add the @rev attribute to the <title>, <navtitle>, <searchtitle>, and <titlealts>.

Champion

JoAnn Hackos, Hal Trent

Tracking information

Event Date Links
Stage 1 proposal accepted 20120814 https://www.oasis-open.org/apps/org/workgroup/dita/download.php/46689/minutes20120814.txt
Stage 2 proposal submitted 20130114 https://www.oasis-open.org/apps/org/workgroup/dita/documents.php?folder_id=913
Stage 2 proposal discussed 20130122 https://www.oasis-open.org/apps/org/workgroup/dita/download.php/48045/minutes20130122.txt
Stage 2 proposal approved 20130122 https://www.oasis-open.org/apps/org/workgroup/dita/download.php/48045/minutes20130122.txt
Stage 3 proposal submitted to reviewers 20130620 Don Day/Stan Doherty
Stage 3 proposal (this document) submitted 20130701  

Approved technical requirements

The DTD modification introduces the @rev attribute to all <title> contexts, including searchtitle, titlealts, navtitle, and the title element in table and figure..
DTD and Schema modifications
None
Topic or map specialization
None
Domain
None
Element
Add the @rev attribute to the attribute list for <title>:
<!ENTITY % title.attributes
             "%id-atts;
              %localization-atts;
              base 
                        CDATA 
                                  #IMPLIED
              %base-attribute-extensions;
              rev 
                        CDATA 
                                  #IMPLIED
              outputclass
                        CDATA 
                                  #IMPLIED"
>
Attributes
None
Processing impact
Processors that explicitly ignore title elements for @rev processing would need to now account for the possibility of @rev on <title>.
Overall usability

This proposal would improve the usability of the topic title in situations where the title has been changed and requires review.

Pro
The use of @rev attribute in <title> will simplify authoring by providing a useful function to the authors and to organizations with stringent review requirements. For example, when updating release notes, the @rev attribute allows reviews to easily find multiple iterations of a release note topic.
Con
None

Dependencies or interrelated proposals

None

Modified DTDs

List the files that must be modified and provide the exact code modifications.

DITA-OT/dtd/base/dtd/commonElements.mod
<!ENTITY % title.attributes
             "%id-atts;
              %localization-atts;
              rev
                        CDATA
                                  #IMPLIED
              base 
                        CDATA 
                                  #IMPLIED
              %base-attribute-extensions;
              
              outputclass
                        CDATA 
                                  #IMPLIED"
                                  
>

Modified specification documentation

Modified topics all with the same modification:
  • 3.1.1.1.2 title
  • 3.1.1.1.3 titlealts
  • 3.1.1.1.4 search title
  • 3.1.1.1.5 navtitle

Add the description of the @rev attribute to the Attributes Table for each of these topics.

rev Indicates a revision level of an element that identifies when the element was added or modified. It may be used to flag outputs when it matches a run-time parameter; it cannot be used for filtering. It is not sufficient to be used for version control. If no value is specified, but the attribute is specified on an ancestor within a map or within the related-links section, the value will cascade from the closest ancestor. CDATA #IMPLIED No

New language reference topic

Example

<topic id="topicid">
  <title rev="121212">Monitoring the patient following the procedure
    <draft-comment>deleted the word "during" and added the word "following"</draft-comment> 
</title>
  ...
  <fig id="fig-01">
    <title rev="121212">Patient monitoring procedure flow following procedures
<draft-comment>deleted the word "during" and added 
the word "following"</draft-comment></title>
   ...
  </fig>
  ...
</topic>
<topic id="topicid">
  <titlealts>
        <navtitle rev="121212">Monitoring the patient  
        <searchtitle rev="121212"> Monitoring the patient