Subject: [xml2rfc-dev] bug in txt and nroff output when using hangIndent

From: Alice Hagens <[email-masked]>
Date: Fri, 26 Aug 2011 18:46:56 -0400

Greetings,
Thanks for all the work on this. 

Looking at the output - specifically when using list style="hanging" hangIndent="X". For example, testing draft-ietf-morg-multimailbox-search-07.xml (as available from http://www.ietf.org/id/draft-ietf-morg-multimailbox-search-07.xml) using http://xml.resource.org/experimental.html.

in XML:

    <section title="New ESEARCH command">
      <t>
        <list style="hanging" hangIndent="12">
        <t hangText="Arguments:">OPTIONAL source options<vspace/>
          OPTIONAL result options<vspace/>
          OPTIONAL charset specification (see <xref target="RFC2978"/>)<vspace/>
          searching criteria (one or more)
        </t>
	<t hangText="Responses:">REQUIRED untagged response: ESEARCH<vspace/>
        </t>
        <t hangText="Result:">OK - search completed<vspace/>
          NO - error: cannot search that charset or criteria<vspace/>
          BAD - command unknown or arguments invalid
        </t>
        </list>
      </t>

experimental text output:
2.  New ESEARCH command
   Arguments: OPTIONAL source options
               OPTIONAL result options
               OPTIONAL charset specification (see [RFC2978])
               searching criteria (one or more)

   Responses: REQUIRED untagged response: ESEARCH

   Result: OK - search completed
               NO - error: cannot search that charset or criteria
               BAD - command unknown or arguments invalid

experimental nroff output:
.ti 0
2.  New ESEARCH command

.in 15
.ti 3
Arguments: OPTIONAL source options
.in 3
OPTIONAL result options
OPTIONAL charset specification (see [RFC2978])
searching criteria (one or more)

.in 15
.ti 3
Responses: REQUIRED untagged response: ESEARCH

.ti 3
Result: OK - search completed
.in 3
NO - error: cannot search that charset or criteria
BAD - command unknown or arguments invalid

which yields text output:

2.  New ESEARCH command

   Arguments: OPTIONAL source options
   OPTIONAL result options OPTIONAL charset specification (see
   [RFC2978]) searching criteria (one or more)

   Responses: REQUIRED untagged response: ESEARCH

   Result: OK - search completed
   NO - error: cannot search that charset or criteria BAD - command
   unknown or arguments invalid

The production text output is the desired output (or one less space after the colon would be fine as well):

2.  New ESEARCH command

   Arguments:  OPTIONAL source options
               OPTIONAL result options
               OPTIONAL charset specification (see [RFC2978])
               searching criteria (one or more)

   Responses:  REQUIRED untagged response: ESEARCH

   Result:     OK - search completed
               NO - error: cannot search that charset or criteria
               BAD - command unknown or arguments invalid

side note: For this specific example, the production nroff output seems to be ok. (However, in general, there is an existing issue in xml2nroff which was mentioned in the RFP as "Note: in the current nroff output hangIndent does not have the expected result when the length of the hangText is over a certain number of characters. See current_output.nroff where .in 37 appears.")  

Thanks,
Alice