Changeset 4012


Ignore:
Timestamp:
08/07/21 00:57:02 (7 months ago)
Author:
krathnayake@ietf.org
Message:

Remove quotes from the text rendering of <tt>. Fixes #600 and #647. Commit ready for merge.

Location:
personal/kesara/3.9.1.dev0
Files:
11 edited

Legend:

Unmodified
Added
Removed
  • personal/kesara/3.9.1.dev0/tests/valid/draft-miek-test.pages.text

    r3986 r4012  
    130130   for Comments (RFC) series.
    131131
    132    This version is adapted to work with "xml2rfc" version 2.x.
     132   This version is adapted to work with xml2rfc version 2.x.
    133133
    134134   Pandoc is an "almost plain text" format and therefor particularly
     
    149149   During the last few years people have been developing markup
    150150   languages that are very easy to remember and type.  These languages
    151    have become known as "almost plain text"-markup languages.  One of
    152    the first was the Markdown (http://daringfireball.net/projects/
    153    markdown/) syntax.  One that was developed later and incorporates
    154    Markdown and a number of extensions is Pandoc
    155    (http://johnmacfarlane.net/pandoc/).  The power of Pandoc also comes
    156    from the fact that it can be translated to numerous output formats,
    157    including, but not limited to: HTML, (plain) Markdown and "docbook"
    158    XML.
     151   have become known as almost plain text-markup languages.  One of the
     152   first was the Markdown (http://daringfireball.net/projects/markdown/)
     153   syntax.  One that was developed later and incorporates Markdown and a
     154   number of extensions is Pandoc (http://johnmacfarlane.net/pandoc/).
     155   The power of Pandoc also comes from the fact that it can be
     156   translated to numerous output formats, including, but not limited to:
     157   HTML, (plain) Markdown and docbook XML.
    159158
    160159   So using Pandoc for writing RFCs seems like a sane choice.  As
    161    "xml2rfc" uses XML, the easiest way would be to create "docbook" XML
    162    and transform that using XSLT.  Pandoc2rfc does just that.  The
     160   xml2rfc uses XML, the easiest way would be to create docbook XML and
     161   transform that using XSLT.  Pandoc2rfc does just that.  The
    163162   conversions are, in some way amusing, as we start off with (almost)
    164163   plain text, use elaborate XML and end up with plain text again.
     164
    165165
    166166
     
    187187                  Figure 1: Attempt to justify Pandoc2rfc.
    188188
    189    The XML generated (the output after the "xsltproc" step in Figure 1)
    190    is suitable for inclusion in either the "middle" or "back" section of
    191    an RFC.  The simplest way is to create a template XML file and
    192    include the appropriate XML:
     189   The XML generated (the output after the xsltproc step in Figure 1) is
     190   suitable for inclusion in either the middle or back section of an
     191   RFC.  The simplest way is to create a template XML file and include
     192   the appropriate XML:
    193193
    194194   <?xml version='1.0' ?>
     
    233233   3.  template.xml (probably a fairly static file).
    234234
    235    The draft ("draft.txt") you are reading now, is automatically created
    236    when you call "make".  The homepage of Pandoc2rfc is this github
     235   The draft (draft.txt) you are reading now, is automatically created
     236   when you call make.  The homepage of Pandoc2rfc is this github
    237237   repository (https://github.com/miekg/pandoc2rfc).
    238238
    2392392.1.  Dependencies
    240240
    241    It needs "xsltproc" and "pandoc" to be installed.  See the Pandoc
    242    user manual for the details (http://johnmacfarlane.net/pandoc/
    243    README.html) on how to type in Pandoc style.  And of course "xml2rfc"
    244    version two.
     241   It needs xsltproc and pandoc to be installed.  See the Pandoc user
     242   manual for the details (http://johnmacfarlane.net/pandoc/README.html)
     243   on how to type in Pandoc style.  And of course xml2rfc version two.
    245244
    246245   When using Pandoc2rfc consider adding the following sentence to an
     
    2512503.  Starting a new project
    252251
    253    When starting a new project with "pandoc2rfc" you'll need to copy the
     252   When starting a new project with pandoc2rfc you'll need to copy the
    254253   following files:
    255254
    256    *  "Makefile"
    257 
    258    *  "transform.xslt"
     255   *  Makefile
     256
     257   *  transform.xslt
    259258
    260259   *  And the above mentioned files:
    261260
    262       -  "middle.pdc"
    263 
    264       -  "back.pdc"
    265 
    266       -  "template.xml"
     261      -  middle.pdc
     262
     263      -  back.pdc
     264
     265      -  template.xml
    267266
    268267   After that you can start editing.
     
    279278
    280279      -  style=empty (Section 7.3.3);
     280
    281281
    282282
     
    299299   *  Figure/artwork with a title (Section 7.4);
    300300
    301    *  Block quote this is converted to "<list style="empty">" paragraph
     301   *  Block quote this is converted to <list style="empty"> paragraph
    302302      (Section 7.5);
    303303
     
    3243245.  Unsupported Features
    325325
    326    *  Lists inside a table ("xml2rfc" doesn't handle this);
     326   *  Lists inside a table (xml2rfc doesn't handle this);
    327327
    328328   *  Pandoc markup in the caption for figures/artwork.  Pandoc markup
     
    330330
    331331   *  crefs: for comments (no input syntax available), use HTML
    332       comments: "<!-- ... -->";
     332      comments: <!-- ... -->;
    333333
    334334
     
    375375   Bla
    376376
    377    Converts to: "<section title="Section1 One" anchor="section1-one">"
    378    If you have another section that is also named "Section1 One", that
     377   Converts to: <section title="Section1 One" anchor="section1-one"> If
     378   you have another section that is also named "Section1 One", that
    379379   anchor will be called "section1-one-1", but _only_ when the sections
    380380   are in the _same_ source file!
    381381
    382    Referencing the section is done with "see [](#section1-one)", as in
    383    see Section 7.2.
     382   Referencing the section is done with see [](#section1-one), as in see
     383   Section 7.2.
    384384
    3853857.3.  List Styles
     
    402402
    403403
    404    Converts to "<list style="symbol">":
     404   Converts to <list style="symbol">:
    405405
    406406   *  Item one;
     
    415415   1. Item two.
    416416
    417    Converts to "<list style="numbers">":
     417   Converts to <list style="numbers">:
    418418
    419419   1.  Item one;
     
    430430   #. Item two.
    431431
    432    Converts to "<list style="empty">":
     432   Converts to <list style="empty">:
    433433
    434434      Item one;
     
    443443   ii. Item two.
    444444
    445    Converts to "<list style="format %i.">":
     445   Converts to <list style="format %i.">:
    446446
    447447   i.   Item one;
     
    465465   II. Item two.
    466466
    467    Yields "<list style="format (%d) ">":
     467   Yields <list style="format (%d) ">:
    468468
    469469   (1)  Item one;
     
    478478   b.  Item two.
    479479
    480    Converts to "<list style="letters">":
     480   Converts to <list style="letters">:
    481481
    482482   a.  Item one;
     
    527527   :   Explanation two
    528528
    529    Converts to: "<list style="hanging">" and "<t hangText="First item
    530    that...">"
     529   Converts to: <list style="hanging"> and <t hangText="First item
     530   that...">
    531531
    532532   If you want a newline after the hangTexts, search for the string
    533    "OPTION" in "transform.xsl" and uncomment it.
     533   OPTION in transform.xsl and uncomment it.
    534534
    5355357.4.  Figure/Artwork
     
    539539   Like this
    540540
    541    Converts to: "<figure><artwork> ..." Note that "xml2rfc" supports a
    542    caption with "<artwork>".  Pandoc does not support this, but
    543    Pandoc2rfc does.  If you add a "@Figure: some text" as the last line,
    544    the artwork gets a "title" attribute with the text after "@Figure:".
    545    It will also be possible to reference the artwork.  If a caption is
    546    supplied the artwork will be centered.  If a caption is needed but
    547    the figure should not be centered use "@figure:\".
     541   Converts to: <figure><artwork> ...  Note that xml2rfc supports a
     542   caption with <artwork>.  Pandoc does not support this, but Pandoc2rfc
     543   does.  If you add a @Figure: some text as the last line, the artwork
     544   gets a title attribute with the text after @Figure:. It will also be
     545   possible to reference the artwork.  If a caption is supplied the
     546   artwork will be centered.  If a caption is needed but the figure
     547   should not be centered use @figure:\.
    548548
    5495497.4.1.  References
    550550
    551    The reference anchor attribute will be: "fig:" + "first 10
    552    (normalized) characters from the caption".  Where normalized means:
     551   The reference anchor attribute will be: fig: + first 10 (normalized)
     552   characters from the caption.  Where normalized means:
    553553
    554554   *  Take the first 10 characters of the caption (i.e. this is the text
    555       _after_ the string "@Figure:");
    556 
    557    *  Spaces and single quotes (') are translated to a minus "-";
     555      _after_ the string @Figure:);
     556
     557   *  Spaces and single quotes (') are translated to a minus -;
    558558
    559559   *  Uppercase letters translated to lowercase.
    560560
    561    So the first artwork with a caption will get "fig:a-minimal-" as a
     561   So the first artwork with a caption will get fig:a-minimal- as a
    562562   reference.  See for instance Figure 2.
    563563
     
    573573
    574574
    575    This anchoring is completely handled from within the "xslt".  Note
    576    that duplicate anchors are an XML validation error which will make
    577    "xml2rfc" fail.
     575   This anchoring is completely handled from within the xslt.  Note that
     576   duplicate anchors are an XML validation error which will make xml2rfc
     577   fail.
    578578
    5795797.5.  Block Quote
     
    583583   > quoted text
    584584
    585    Converts to: "<t><list style="empty"> ..." paragraph, making it
     585   Converts to: <t><list style="empty"> ... paragraph, making it
    586586   indented.
    587587
     
    594594   [Click here](URI)
    595595
    596    Converts to: "<ulink target="URI">Click here ..."
     596   Converts to: <ulink target="URI">Click here ...
    597597
    5985987.6.2.  Internal
     
    602602   [Click here](#localid)
    603603
    604    Converts to: "<link target="localid">Click here ..."
     604   Converts to: <link target="localid">Click here ...
    605605
    606606   For referring to RFCs (for which you manually need add the reference
     
    6326327.7.  Spanx Styles
    633633
    634    The verb style can be selected with back-tics: "`text`" Converts to:
    635    "<spanx style="verb"> ..."
    636 
    637    And the emphasis style with asterisks: "*text*" or underscores:
    638    "_text_" Converts to: "<spanx style="emph"> ..."
    639 
    640    And the emphasis style with double asterisks: "**text**" Converts to:
    641    "<spanx style="strong"> ..."
     634   The verb style can be selected with back-tics: `text` Converts to:
     635   <spanx style="verb"> ...
     636
     637   And the emphasis style with asterisks: *text* or underscores: _text_
     638   Converts to: <spanx style="emph"> ...
     639
     640   And the emphasis style with double asterisks: **text** Converts to:
     641   <spanx style="strong"> ...
    642642
    6436437.8.  Tables
     
    655655      Figure 3: A caption describing the figure describing the table.
    656656
    657    Is translated to "<texttable>" element in "xml2rfc".  You can choose
     657   Is translated to <texttable> element in xml2rfc.  You can choose
    658658   multiple styles as input, but they all are converted to the same
    659    style (plain "<texttable>") table in "xml2rfc".  The column alignment
    660    is copied over to the generated XML.
     659   style (plain <texttable>) table in xml2rfc.  The column alignment is
     660   copied over to the generated XML.
    661661
    6626627.8.1.  References
    663663
    664    The caption is _always_ translated to a "title" attribute.  If a
    665    table has a caption, it will _also_ get a reference.  The reference
    666    anchor attribute will be: "tab-" + "first 10 (normalized) characters
    667    from the caption".  Where normalized means:
     664   The caption is _always_ translated to a title attribute.  If a table
     665   has a caption, it will _also_ get a reference.  The reference anchor
     666   attribute will be: tab- + first 10 (normalized) characters from the
     667   caption.  Where normalized means:
    668668
    669669   *  Take the first 10 characters of the caption (i.e. this is the text
    670       _after_ the string "Table:");
    671 
    672    *  Spaces and single quotes (') are translated to a minus "-";
     670      _after_ the string Table:);
     671
     672   *  Spaces and single quotes (') are translated to a minus -;
    673673
    674674   *  Uppercase letters translated to lowercase.
    675675
    676    So the first table with a caption will get "tab-a-caption-" for
     676   So the first table with a caption will get tab-a-caption- for
    677677   reference use.  See for instance
    678678
     
    687687
    688688
    689    This anchoring is completely handled from within the "xslt".  Note
    690    that duplicate anchors are an XML validation error which will make
    691    "xml2rfc" fail.
     689   This anchoring is completely handled from within the xslt.  Note that
     690   duplicate anchors are an XML validation error which will make xml2rfc
     691   fail.
    692692
    6936937.9.  Indexes
     
    701701   [^1]: footnote text
    702702
    703    We re-use this syntax for the "<iref>" tag.  The above text
    704    translates to:
     703   We re-use this syntax for the <iref> tag.  The above text translates
     704   to:
    705705
    706706   <iref item="footnote text"/>
    707707
    708    Sub items are also supported.  Use an exclamation mark ("!") to
     708   Sub items are also supported.  Use an exclamation mark (!) to
    709709   separate them:
    710710
     
    721721   or processed in the same Pandoc run.  Concatenating the different
    722722   section files before processing them is a solution to this problem.
    723    You can, for instance, amend the "Makefile" and add something like
     723   You can, for instance, amend the Makefile and add something like
    724724   this:
    725725
     
    727727           cat $@ > allsections.pdc
    728728
    729    And then process "allsection.pdc" in the normal way.
     729   And then process allsection.pdc in the normal way.
    730730
    7317318.2.  Setting the title
    732732
    733    If you use double quotes in the documents title in the "docName"
     733   If you use double quotes in the documents title in the docName
    734734   attribute, like:
    735735
     
    7537538.3.  Uploading the XML/txt
    754754
    755    The "draft.xml" target will generate an XML file with all XML
    756    included, so you can upload just one file to the I-D tracker.
     755   The draft.xml target will generate an XML file with all XML included,
     756   so you can upload just one file to the I-D tracker.
    757757
    7587588.4.  VIM syntax highlighting
     
    790790
    791791   This appendix consists out of a few tests that should all render to
    792    proper "xml2rfc" XML.
     792   proper xml2rfc XML.
    793793
    794794
     
    808808A.2.  Markup in heading
    809809
    810    This is discarded by "xml2rfc".
     810   This is discarded by xml2rfc.
    811811
    812812A.3.  Blockquote
     
    833833      double asterisks: *double asterisks*
    834834
    835       backticks: "backticks"
     835      backticks: backticks
    836836
    837837A.7.  List Tests
     
    11251125      isnt converted to a <spanx> style, because this is copied as-is.
    11261126
    1127    And how a figure that is not centered, do to using "figure" and not
    1128    "Figure".
     1127   And how a figure that is not centered, do to using figure and not
     1128   Figure.
    11291129
    11301130   This is a figure
     
    11331133                      Figure 5: A non centered figure.
    11341134
    1135    Test the use of "@title":
     1135   Test the use of @title:
    11361136
    11371137
  • personal/kesara/3.9.1.dev0/tests/valid/draft-miek-test.text

    r3986 r4012  
    112112   for Comments (RFC) series.
    113113
    114    This version is adapted to work with "xml2rfc" version 2.x.
     114   This version is adapted to work with xml2rfc version 2.x.
    115115
    116116   Pandoc is an "almost plain text" format and therefor particularly
     
    131131   During the last few years people have been developing markup
    132132   languages that are very easy to remember and type.  These languages
    133    have become known as "almost plain text"-markup languages.  One of
    134    the first was the Markdown (http://daringfireball.net/projects/
    135    markdown/) syntax.  One that was developed later and incorporates
    136    Markdown and a number of extensions is Pandoc
    137    (http://johnmacfarlane.net/pandoc/).  The power of Pandoc also comes
    138    from the fact that it can be translated to numerous output formats,
    139    including, but not limited to: HTML, (plain) Markdown and "docbook"
    140    XML.
     133   have become known as almost plain text-markup languages.  One of the
     134   first was the Markdown (http://daringfireball.net/projects/markdown/)
     135   syntax.  One that was developed later and incorporates Markdown and a
     136   number of extensions is Pandoc (http://johnmacfarlane.net/pandoc/).
     137   The power of Pandoc also comes from the fact that it can be
     138   translated to numerous output formats, including, but not limited to:
     139   HTML, (plain) Markdown and docbook XML.
    141140
    142141   So using Pandoc for writing RFCs seems like a sane choice.  As
    143    "xml2rfc" uses XML, the easiest way would be to create "docbook" XML
    144    and transform that using XSLT.  Pandoc2rfc does just that.  The
     142   xml2rfc uses XML, the easiest way would be to create docbook XML and
     143   transform that using XSLT.  Pandoc2rfc does just that.  The
    145144   conversions are, in some way amusing, as we start off with (almost)
    146145   plain text, use elaborate XML and end up with plain text again.
     
    159158                  Figure 1: Attempt to justify Pandoc2rfc.
    160159
    161    The XML generated (the output after the "xsltproc" step in Figure 1)
    162    is suitable for inclusion in either the "middle" or "back" section of
    163    an RFC.  The simplest way is to create a template XML file and
    164    include the appropriate XML:
     160   The XML generated (the output after the xsltproc step in Figure 1) is
     161   suitable for inclusion in either the middle or back section of an
     162   RFC.  The simplest way is to create a template XML file and include
     163   the appropriate XML:
    165164
    166165   <?xml version='1.0' ?>
     
    196195   3.  template.xml (probably a fairly static file).
    197196
    198    The draft ("draft.txt") you are reading now, is automatically created
    199    when you call "make".  The homepage of Pandoc2rfc is this github
     197   The draft (draft.txt) you are reading now, is automatically created
     198   when you call make.  The homepage of Pandoc2rfc is this github
    200199   repository (https://github.com/miekg/pandoc2rfc).
    201200
    2022012.1.  Dependencies
    203202
    204    It needs "xsltproc" and "pandoc" to be installed.  See the Pandoc
    205    user manual for the details (http://johnmacfarlane.net/pandoc/
    206    README.html) on how to type in Pandoc style.  And of course "xml2rfc"
    207    version two.
     203   It needs xsltproc and pandoc to be installed.  See the Pandoc user
     204   manual for the details (http://johnmacfarlane.net/pandoc/README.html)
     205   on how to type in Pandoc style.  And of course xml2rfc version two.
    208206
    209207   When using Pandoc2rfc consider adding the following sentence to an
     
    2142123.  Starting a new project
    215213
    216    When starting a new project with "pandoc2rfc" you'll need to copy the
     214   When starting a new project with pandoc2rfc you'll need to copy the
    217215   following files:
    218216
    219    *  "Makefile"
    220 
    221    *  "transform.xslt"
     217   *  Makefile
     218
     219   *  transform.xslt
    222220
    223221   *  And the above mentioned files:
    224222
    225       -  "middle.pdc"
    226 
    227       -  "back.pdc"
    228 
    229       -  "template.xml"
     223      -  middle.pdc
     224
     225      -  back.pdc
     226
     227      -  template.xml
    230228
    231229   After that you can start editing.
     
    254252   *  Figure/artwork with a title (Section 7.4);
    255253
    256    *  Block quote this is converted to "<list style="empty">" paragraph
     254   *  Block quote this is converted to <list style="empty"> paragraph
    257255      (Section 7.5);
    258256
     
    2792775.  Unsupported Features
    280278
    281    *  Lists inside a table ("xml2rfc" doesn't handle this);
     279   *  Lists inside a table (xml2rfc doesn't handle this);
    282280
    283281   *  Pandoc markup in the caption for figures/artwork.  Pandoc markup
     
    285283
    286284   *  crefs: for comments (no input syntax available), use HTML
    287       comments: "<!-- ... -->";
     285      comments: <!-- ... -->;
    288286
    2892876.  Acknowledgements
     
    317315   Bla
    318316
    319    Converts to: "<section title="Section1 One" anchor="section1-one">"
    320    If you have another section that is also named "Section1 One", that
     317   Converts to: <section title="Section1 One" anchor="section1-one"> If
     318   you have another section that is also named "Section1 One", that
    321319   anchor will be called "section1-one-1", but _only_ when the sections
    322320   are in the _same_ source file!
    323321
    324    Referencing the section is done with "see [](#section1-one)", as in
    325    see Section 7.2.
     322   Referencing the section is done with see [](#section1-one), as in see
     323   Section 7.2.
    326324
    3273257.3.  List Styles
     
    336334   * Item two.
    337335
    338    Converts to "<list style="symbol">":
     336   Converts to <list style="symbol">:
    339337
    340338   *  Item one;
     
    349347   1. Item two.
    350348
    351    Converts to "<list style="numbers">":
     349   Converts to <list style="numbers">:
    352350
    353351   1.  Item one;
     
    364362   #. Item two.
    365363
    366    Converts to "<list style="empty">":
     364   Converts to <list style="empty">:
    367365
    368366      Item one;
     
    377375   ii. Item two.
    378376
    379    Converts to "<list style="format %i.">":
     377   Converts to <list style="format %i.">:
    380378
    381379   i.   Item one;
     
    389387   II. Item two.
    390388
    391    Yields "<list style="format (%d) ">":
     389   Yields <list style="format (%d) ">:
    392390
    393391   (1)  Item one;
     
    402400   b.  Item two.
    403401
    404    Converts to "<list style="letters">":
     402   Converts to <list style="letters">:
    405403
    406404   a.  Item one;
     
    434432   :   Explanation two
    435433
    436    Converts to: "<list style="hanging">" and "<t hangText="First item
    437    that...">"
     434   Converts to: <list style="hanging"> and <t hangText="First item
     435   that...">
    438436
    439437   If you want a newline after the hangTexts, search for the string
    440    "OPTION" in "transform.xsl" and uncomment it.
     438   OPTION in transform.xsl and uncomment it.
    441439
    4424407.4.  Figure/Artwork
     
    446444   Like this
    447445
    448    Converts to: "<figure><artwork> ..." Note that "xml2rfc" supports a
    449    caption with "<artwork>".  Pandoc does not support this, but
    450    Pandoc2rfc does.  If you add a "@Figure: some text" as the last line,
    451    the artwork gets a "title" attribute with the text after "@Figure:".
    452    It will also be possible to reference the artwork.  If a caption is
    453    supplied the artwork will be centered.  If a caption is needed but
    454    the figure should not be centered use "@figure:\".
     446   Converts to: <figure><artwork> ...  Note that xml2rfc supports a
     447   caption with <artwork>.  Pandoc does not support this, but Pandoc2rfc
     448   does.  If you add a @Figure: some text as the last line, the artwork
     449   gets a title attribute with the text after @Figure:. It will also be
     450   possible to reference the artwork.  If a caption is supplied the
     451   artwork will be centered.  If a caption is needed but the figure
     452   should not be centered use @figure:\.
    455453
    4564547.4.1.  References
    457455
    458    The reference anchor attribute will be: "fig:" + "first 10
    459    (normalized) characters from the caption".  Where normalized means:
     456   The reference anchor attribute will be: fig: + first 10 (normalized)
     457   characters from the caption.  Where normalized means:
    460458
    461459   *  Take the first 10 characters of the caption (i.e. this is the text
    462       _after_ the string "@Figure:");
    463 
    464    *  Spaces and single quotes (') are translated to a minus "-";
     460      _after_ the string @Figure:);
     461
     462   *  Spaces and single quotes (') are translated to a minus -;
    465463
    466464   *  Uppercase letters translated to lowercase.
    467465
    468    So the first artwork with a caption will get "fig:a-minimal-" as a
     466   So the first artwork with a caption will get fig:a-minimal- as a
    469467   reference.  See for instance Figure 2.
    470468
    471    This anchoring is completely handled from within the "xslt".  Note
    472    that duplicate anchors are an XML validation error which will make
    473    "xml2rfc" fail.
     469   This anchoring is completely handled from within the xslt.  Note that
     470   duplicate anchors are an XML validation error which will make xml2rfc
     471   fail.
    474472
    4754737.5.  Block Quote
     
    479477   > quoted text
    480478
    481    Converts to: "<t><list style="empty"> ..." paragraph, making it
     479   Converts to: <t><list style="empty"> ... paragraph, making it
    482480   indented.
    483481
     
    490488   [Click here](URI)
    491489
    492    Converts to: "<ulink target="URI">Click here ..."
     490   Converts to: <ulink target="URI">Click here ...
    493491
    4944927.6.2.  Internal
     
    498496   [Click here](#localid)
    499497
    500    Converts to: "<link target="localid">Click here ..."
     498   Converts to: <link target="localid">Click here ...
    501499
    502500   For referring to RFCs (for which you manually need add the reference
     
    5165147.7.  Spanx Styles
    517515
    518    The verb style can be selected with back-tics: "`text`" Converts to:
    519    "<spanx style="verb"> ..."
    520 
    521    And the emphasis style with asterisks: "*text*" or underscores:
    522    "_text_" Converts to: "<spanx style="emph"> ..."
    523 
    524    And the emphasis style with double asterisks: "**text**" Converts to:
    525    "<spanx style="strong"> ..."
     516   The verb style can be selected with back-tics: `text` Converts to:
     517   <spanx style="verb"> ...
     518
     519   And the emphasis style with asterisks: *text* or underscores: _text_
     520   Converts to: <spanx style="emph"> ...
     521
     522   And the emphasis style with double asterisks: **text** Converts to:
     523   <spanx style="strong"> ...
    526524
    5275257.8.  Tables
     
    539537      Figure 3: A caption describing the figure describing the table.
    540538
    541    Is translated to "<texttable>" element in "xml2rfc".  You can choose
     539   Is translated to <texttable> element in xml2rfc.  You can choose
    542540   multiple styles as input, but they all are converted to the same
    543    style (plain "<texttable>") table in "xml2rfc".  The column alignment
    544    is copied over to the generated XML.
     541   style (plain <texttable>) table in xml2rfc.  The column alignment is
     542   copied over to the generated XML.
    545543
    5465447.8.1.  References
    547545
    548    The caption is _always_ translated to a "title" attribute.  If a
    549    table has a caption, it will _also_ get a reference.  The reference
    550    anchor attribute will be: "tab-" + "first 10 (normalized) characters
    551    from the caption".  Where normalized means:
     546   The caption is _always_ translated to a title attribute.  If a table
     547   has a caption, it will _also_ get a reference.  The reference anchor
     548   attribute will be: tab- + first 10 (normalized) characters from the
     549   caption.  Where normalized means:
    552550
    553551   *  Take the first 10 characters of the caption (i.e. this is the text
    554       _after_ the string "Table:");
    555 
    556    *  Spaces and single quotes (') are translated to a minus "-";
     552      _after_ the string Table:);
     553
     554   *  Spaces and single quotes (') are translated to a minus -;
    557555
    558556   *  Uppercase letters translated to lowercase.
    559557
    560    So the first table with a caption will get "tab-a-caption-" for
     558   So the first table with a caption will get tab-a-caption- for
    561559   reference use.  See for instance
    562560
    563    This anchoring is completely handled from within the "xslt".  Note
    564    that duplicate anchors are an XML validation error which will make
    565    "xml2rfc" fail.
     561   This anchoring is completely handled from within the xslt.  Note that
     562   duplicate anchors are an XML validation error which will make xml2rfc
     563   fail.
    566564
    5675657.9.  Indexes
     
    575573   [^1]: footnote text
    576574
    577    We re-use this syntax for the "<iref>" tag.  The above text
    578    translates to:
     575   We re-use this syntax for the <iref> tag.  The above text translates
     576   to:
    579577
    580578   <iref item="footnote text"/>
    581579
    582    Sub items are also supported.  Use an exclamation mark ("!") to
     580   Sub items are also supported.  Use an exclamation mark (!) to
    583581   separate them:
    584582
     
    595593   or processed in the same Pandoc run.  Concatenating the different
    596594   section files before processing them is a solution to this problem.
    597    You can, for instance, amend the "Makefile" and add something like
     595   You can, for instance, amend the Makefile and add something like
    598596   this:
    599597
     
    601599           cat $@ > allsections.pdc
    602600
    603    And then process "allsection.pdc" in the normal way.
     601   And then process allsection.pdc in the normal way.
    604602
    6056038.2.  Setting the title
    606604
    607    If you use double quotes in the documents title in the "docName"
     605   If you use double quotes in the documents title in the docName
    608606   attribute, like:
    609607
     
    6196178.3.  Uploading the XML/txt
    620618
    621    The "draft.xml" target will generate an XML file with all XML
    622    included, so you can upload just one file to the I-D tracker.
     619   The draft.xml target will generate an XML file with all XML included,
     620   so you can upload just one file to the I-D tracker.
    623621
    6246228.4.  VIM syntax highlighting
     
    656654
    657655   This appendix consists out of a few tests that should all render to
    658    proper "xml2rfc" XML.
     656   proper xml2rfc XML.
    659657
    660658A.1.  A Very Long Title Considerations With Regards to the Already
     
    665663A.2.  Markup in heading
    666664
    667    This is discarded by "xml2rfc".
     665   This is discarded by xml2rfc.
    668666
    669667A.3.  Blockquote
     
    690688      double asterisks: *double asterisks*
    691689
    692       backticks: "backticks"
     690      backticks: backticks
    693691
    694692A.7.  List Tests
     
    929927      isnt converted to a <spanx> style, because this is copied as-is.
    930928
    931    And how a figure that is not centered, do to using "figure" and not
    932    "Figure".
     929   And how a figure that is not centered, do to using figure and not
     930   Figure.
    933931
    934932   This is a figure
     
    937935                      Figure 5: A non centered figure.
    938936
    939    Test the use of "@title":
     937   Test the use of @title:
    940938
    941939   This is a figure with a title
  • personal/kesara/3.9.1.dev0/tests/valid/draft-v3-features.text

    r3986 r4012  
    8989     1.4.  sup/sub
    9090   2.  Section Titles
    91      2.1.  Title in "<name>" element, including markup
    92      2.2.  Title with "xref": Section 2.2
     91     2.1.  Title in <name> element, including markup
     92     2.2.  Title with xref: Section 2.2
    9393     2.3.  Title with id
    9494   3.  Renaming References
     
    101101     4.5.  Unordered Lists (empty=true)
    102102     4.6.  Referring to list items
    103    5.  "<blockquote>"
    104    6.  "<aside>"
    105    7.  "<sourcecode>"
    106    8.  "SVG"
     103   5.  <blockquote>
     104   6.  <aside>
     105   7.  <sourcecode>
     106   8.  SVG
    107107     8.1.  inline (with @alt attribute)
    108108     8.2.  inline (left)
     
    110110     8.4.  inline (right)
    111111     8.5.  included (type svg)
    112    9.  "<figure>"/"<name>"
     112   9.  <figure>/<name>
    113113   10. Tables
    114114     10.1.  Bare Table (unnamed, no anchor, with iref)
     
    1491491.2.  tt
    150150
    151    This is "monospaced".  Standard 78: [STD78].
     151   This is monospaced.  Standard 78: [STD78].
    152152
    1531531.3.  bcp14
     
    1761762.  Section Titles
    177177
    178 2.1.  Title in "<name>" element, including markup
     1782.1.  Title in <name> element, including markup
    179179
    180180   Test.
     
    183183   markup".
    184184
    185 2.2.  Title with "xref": Section 2.2
     1852.2.  Title with xref: Section 2.2
    186186
    187187   Test.
     
    264264
    265265   _Term1_
    266       Description1.  "Description1".  Description1. *Description1*.
     266      Description1.  Description1.  Description1. *Description1*.
    267267
    268268   multi-paragraph
     
    438438   (title, TEXTCONTENT) see TEXTCONTENT (listitem).
    439439
    440 5.  "<blockquote>"
     4405.  <blockquote>
    441441
    442442   Let's cite:
     
    480480   |     gettysburg.htm
    481481
    482 6.  "<aside>"
    483 
    484       |  *Note:* this is an "aside".
     4826.  <aside>
     483
     484      |  *Note:* this is an aside.
    485485      | 
    486486      |  A second paragraph.
    487487
    488 7.  "<sourcecode>"
     4887.  <sourcecode>
    489489
    490490   Text before...
     
    502502   foo = bar
    503503
    504 8.  "SVG"
     5048.  SVG
    505505
    5065068.1.  inline (with @alt attribute)
     
    552552   be in conflict with an id attribute in the included SVG.
    553553
    554 9.  "<figure>"/"<name>"
     5549.  <figure>/<name>
    555555
    556556   ABC
    557557
    558                        Figure 2: "<figure>"/"<name>"
     558                         Figure 2: <figure>/<name>
    559559
    56056010.  Tables
     
    651651    +=============================================+===================+
    652652    | The _quick_ ^brown _fox *jumps* over the    | Paragraph 1       |
    653     | lazy OPTIONAL "dog".  Table 9               |                   |
     653    | lazy OPTIONAL dog.  Table 9                 |                   |
    654654    | https://en.wikipedia.org/wiki/              | Paragraph 2       |
    655655    | The_quick_brown_fox_jumps_over_the_lazy_dog |                   |
     
    13421342
    13431343   [0REFTEST] Reschke, J., "Reference Test", additional prose goes
    1344               _here_, November 2014.  Due to a "<displayreference>"
     1344              _here_, November 2014.  Due to a <displayreference>
    13451345              element, this should be listed as "[0REFTEST]".
    13461346
  • personal/kesara/3.9.1.dev0/tests/valid/indexes.pages.text

    r4011 r4012  
    44
    55Network Working Group                                     H. Person, Ed.
    6 Internet-Draft                                              July 7, 2021
     6Internet-Draft                                              July 8, 2021
    77Intended status: Experimental                                           
    8 Expires: January 8, 2022
     8Expires: January 9, 2022
    99
    1010
     
    2727   material or to cite them other than as "work in progress."
    2828
    29    This Internet-Draft will expire on January 8, 2022.
     29   This Internet-Draft will expire on January 9, 2022.
    3030
    3131Copyright Notice
     
    5050
    5151   This is a section!  _Emphatically._ *Loudly.* _(Subscripted.)
    52    ^(Superscripted.)  "Typewritten."
     52   ^(Superscripted.)  Typewritten.
    5353
    5454
    5555
    56 Person                   Expires January 8, 2022                [Page 1]
     56Person                   Expires January 9, 2022                [Page 1]
    5757
    5858
     
    111111
    112112
    113 Person                   Expires January 8, 2022                [Page 2]
     113Person                   Expires January 9, 2022                [Page 2]
    114114
    115115
     
    168168
    169169
    170 Person                   Expires January 8, 2022                [Page 3]
     170Person                   Expires January 9, 2022                [Page 3]
  • personal/kesara/3.9.1.dev0/tests/valid/indexes.prepped.xml

    r4011 r4012  
    11<?xml version='1.0' encoding='utf-8'?>
    2 <rfc xmlns:xi="http://www.w3.org/2001/XInclude" version="3" category="exp" docName="indexes-00" indexInclude="true" ipr="trust200902" prepTime="2021-07-07T15:35:53" scripts="Common,Latin" sortRefs="true" submissionType="independent" symRefs="true" tocDepth="3" tocInclude="true">
     2<rfc xmlns:xi="http://www.w3.org/2001/XInclude" version="3" category="exp" docName="indexes-00" indexInclude="true" ipr="trust200902" prepTime="2021-07-08T11:51:21" scripts="Common,Latin" sortRefs="true" submissionType="independent" symRefs="true" tocDepth="3" tocInclude="true">
    33  <!-- xml2rfc v2v3 conversion 3.9.1 -->
    44 
     
    2121      </address>
    2222    </author>
    23     <date day="07" month="07" year="2021"/>
     23    <date day="08" month="07" year="2021"/>
    2424    <boilerplate>
    2525      <section anchor="status-of-memo" numbered="false" removeInRFC="false" toc="exclude" pn="section-boilerplate.1">
     
    4242        </t>
    4343        <t indent="0" pn="section-boilerplate.1-4">
    44         This Internet-Draft will expire on 8 January 2022.
     44        This Internet-Draft will expire on 9 January 2022.
    4545        </t>
    4646      </section>
  • personal/kesara/3.9.1.dev0/tests/valid/indexes.text

    r4011 r4012  
    44
    55Network Working Group                                     H. Person, Ed.
    6 Internet-Draft                                              July 7, 2021
     6Internet-Draft                                              July 8, 2021
    77Intended status: Experimental                                           
    8 Expires: January 8, 2022
     8Expires: January 9, 2022
    99
    1010
     
    2727   material or to cite them other than as "work in progress."
    2828
    29    This Internet-Draft will expire on January 8, 2022.
     29   This Internet-Draft will expire on January 9, 2022.
    3030
    3131Copyright Notice
     
    5050
    5151   This is a section!  _Emphatically._ *Loudly.* _(Subscripted.)
    52    ^(Superscripted.)  "Typewritten."
     52   ^(Superscripted.)  Typewritten.
    5353
    5454   This is another section!
  • personal/kesara/3.9.1.dev0/tests/valid/indexes.v3.py36.html

    r4011 r4012  
    2424<tfoot><tr>
    2525<td class="left">Person</td>
    26 <td class="center">Expires January 8, 2022</td>
     26<td class="center">Expires January 9, 2022</td>
    2727<td class="right">[Page]</td>
    2828</tr></tfoot>
     
    3737<dt class="label-published">Published:</dt>
    3838<dd class="published">
    39 <time datetime="2021-07-07" class="published">July 7, 2021</time>
     39<time datetime="2021-07-08" class="published">July 8, 2021</time>
    4040    </dd>
    4141<dt class="label-intended-status">Intended Status:</dt>
    4242<dd class="intended-status">Experimental</dd>
    4343<dt class="label-expires">Expires:</dt>
    44 <dd class="expires"><time datetime="2022-01-08">January 8, 2022</time></dd>
     44<dd class="expires"><time datetime="2022-01-09">January 9, 2022</time></dd>
    4545<dt class="label-authors">Author:</dt>
    4646<dd class="authors">
     
    7272        material or to cite them other than as "work in progress."<a href="#section-boilerplate.1-3" class="pilcrow">¶</a></p>
    7373<p id="section-boilerplate.1-4">
    74         This Internet-Draft will expire on January 8, 2022.<a href="#section-boilerplate.1-4" class="pilcrow">¶</a></p>
     74        This Internet-Draft will expire on January 9, 2022.<a href="#section-boilerplate.1-4" class="pilcrow">¶</a></p>
    7575</section>
    7676</div>
  • personal/kesara/3.9.1.dev0/tests/valid/indexes.v3.py37.html

    r4011 r4012  
    2424<tfoot><tr>
    2525<td class="left">Person</td>
    26 <td class="center">Expires January 8, 2022</td>
     26<td class="center">Expires January 9, 2022</td>
    2727<td class="right">[Page]</td>
    2828</tr></tfoot>
     
    3737<dt class="label-published">Published:</dt>
    3838<dd class="published">
    39 <time datetime="2021-07-07" class="published">July 7, 2021</time>
     39<time datetime="2021-07-08" class="published">July 8, 2021</time>
    4040    </dd>
    4141<dt class="label-intended-status">Intended Status:</dt>
    4242<dd class="intended-status">Experimental</dd>
    4343<dt class="label-expires">Expires:</dt>
    44 <dd class="expires"><time datetime="2022-01-08">January 8, 2022</time></dd>
     44<dd class="expires"><time datetime="2022-01-09">January 9, 2022</time></dd>
    4545<dt class="label-authors">Author:</dt>
    4646<dd class="authors">
     
    7272        material or to cite them other than as "work in progress."<a href="#section-boilerplate.1-3" class="pilcrow">¶</a></p>
    7373<p id="section-boilerplate.1-4">
    74         This Internet-Draft will expire on January 8, 2022.<a href="#section-boilerplate.1-4" class="pilcrow">¶</a></p>
     74        This Internet-Draft will expire on January 9, 2022.<a href="#section-boilerplate.1-4" class="pilcrow">¶</a></p>
    7575</section>
    7676</div>
  • personal/kesara/3.9.1.dev0/tests/valid/indexes.v3.py38.html

    r4011 r4012  
    2424<tfoot><tr>
    2525<td class="left">Person</td>
    26 <td class="center">Expires January 8, 2022</td>
     26<td class="center">Expires January 9, 2022</td>
    2727<td class="right">[Page]</td>
    2828</tr></tfoot>
     
    3737<dt class="label-published">Published:</dt>
    3838<dd class="published">
    39 <time datetime="2021-07-07" class="published">July 7, 2021</time>
     39<time datetime="2021-07-08" class="published">July 8, 2021</time>
    4040    </dd>
    4141<dt class="label-intended-status">Intended Status:</dt>
    4242<dd class="intended-status">Experimental</dd>
    4343<dt class="label-expires">Expires:</dt>
    44 <dd class="expires"><time datetime="2022-01-08">January 8, 2022</time></dd>
     44<dd class="expires"><time datetime="2022-01-09">January 9, 2022</time></dd>
    4545<dt class="label-authors">Author:</dt>
    4646<dd class="authors">
     
    7272        material or to cite them other than as "work in progress."<a href="#section-boilerplate.1-3" class="pilcrow">¶</a></p>
    7373<p id="section-boilerplate.1-4">
    74         This Internet-Draft will expire on January 8, 2022.<a href="#section-boilerplate.1-4" class="pilcrow">¶</a></p>
     74        This Internet-Draft will expire on January 9, 2022.<a href="#section-boilerplate.1-4" class="pilcrow">¶</a></p>
    7575</section>
    7676</div>
  • personal/kesara/3.9.1.dev0/tests/valid/manpage.txt

    r4011 r4012  
    11xml2rfc(1)                                                    xml2rfc(1)
    2                                                              7 July 2021
     2                                                             8 July 2021
    33
    44
     
    2424   4.  References
    2525   Appendix A.  RELAX NG Schema
    26    Appendix B.  "xml2rfc" Command-line Options
    27    Appendix C.  "xml2rfc" Configuration Files
    28    Appendix D.  "xml2rfc" Documentation Template Variables
     26   Appendix B.  xml2rfc Command-line Options
     27   Appendix C.  xml2rfc Configuration Files
     28   Appendix D.  xml2rfc Documentation Template Variables
    2929   Author's Address
    3030
     
    546546
    547547   xml2rfc has a help option which will list all names and country codes
    548    it recognizes as valid country names: "xml2rfc --country-help" .
     548   it recognizes as valid country names: xml2rfc --country-help .
    549549
    550550   This element can be a child element of <postal>.
     
    10701070
    10711071   The indentation of the list elements relative to the start of the
    1072    list item number.  With "indent='adaptive'", the width of the widest
     1072   list item number.  With indent='adaptive', the width of the widest
    10731073   list item number will determine the indentation.  With a numeric
    10741074   value, that value will be used to determine the amount of
     
    15771577   Descendant sections of unnumbered sections are unnumbered by
    15781578   definition.  (New) Both top-level <section>s and other <section>s may
    1579    have "numbered='false'".
     1579   have numbered='false'.
    15801580
    158115812.50.3.  "removeInRFC" Attribute
     
    18631863   Acts as a hint to the output formatters that do pagination to do a
    18641864   best-effort attempt to keep the paragraph with the next element,
    1865    whatever that happens to be.  For example, for HTML output "@media
    1866    print" CSS might translate this to page-break-after: avoid.  For PDF,
     1865   whatever that happens to be.  For example, for HTML output @media
     1866   print CSS might translate this to page-break-after: avoid.  For PDF,
    18671867   the paginator could attempt to keep the paragraph with the next
    18681868   element.  Note: this attribute is strictly a hint and not always
     
    18761876   Acts as a hint to the output formatters that do pagination to do a
    18771877   best-effort attempt to keep the paragraph with the previous element,
    1878    whatever that happens to be.  For example, for HTML output "@media
    1879    print" CSS might translate this to page-break-before: avoid.  For
    1880    PDF, the paginator could attempt to keep the paragraph with the
    1881    previous element.  Note: this attribute is strictly a hint and not
    1882    always actionable.
     1878   whatever that happens to be.  For example, for HTML output @media
     1879   print CSS might translate this to page-break-before: avoid.  For PDF,
     1880   the paginator could attempt to keep the paragraph with the previous
     1881   element.  Note: this attribute is strictly a hint and not always
     1882   actionable.
    18831883
    188418842.60.  <table>
     
    38763876   <CODE ENDS>
    38773877
    3878 Appendix B.  "xml2rfc" Command-line Options
     3878Appendix B.  xml2rfc Command-line Options
    38793879
    38803880   The following command-line options are available.  Long options may
     
    38853885B.1.  Positional arguments
    38863886
    3887    "source"
     3887   source
    38883888      Input XML file to render to one or more of the available formats.
    38893889
     
    38933893   options.
    38943894
    3895    "--help", "-h"
     3895   --help, -h
    38963896      Show a help message and exit.
    38973897
    3898    "--docfile"
     3898   --docfile
    38993899      Generate a documentation XML file ready for formatting.
    39003900
    3901       The "--docfile" and "--manpage" switches takes input from 5
    3902       places:
    3903 
    3904       *  The "v3.rng" file distributed as part of the xml2rfc package,
     3901      The --docfile and --manpage switches takes input from 5 places:
     3902
     3903      *  The v3.rng file distributed as part of the xml2rfc package,
    39053904         which is also used to validate and process v3 XML input.
    3906       *  A "rfc7991.rng" file distributed as part of the xml2rfc
    3907          package, which holds the schema defined in [RFC7991].  This is
    3908          used in determining elements and attributes that are new in the
    3909          current "v3.rng" schema, compared to the RFC7991 schema.
     3905      *  A rfc7991.rng file distributed as part of the xml2rfc package,
     3906         which holds the schema defined in [RFC7991].  This is used in
     3907         determining elements and attributes that are new in the current
     3908         v3.rng schema, compared to the RFC7991 schema.
    39103909      *  Lists of deprecated elements and attributes, which are part of
    39113910         the xml2rfc source.
    3912       *  A YAML file "doc.yaml" that contains XML snippets with
     3911      *  A YAML file doc.yaml that contains XML snippets with
    39133912         descriptions of elements, attributes, attribute values, and
    3914          switches, from the same directory as "doc.xml".
    3915       *  An XML template file "doc.xml", by default taken from the
    3916          "templates" directory of the xml2rfc package (but this can be
    3917          changed with the "--templates-dir" switch).  The 4 preceding
     3913         switches, from the same directory as doc.xml.
     3914      *  An XML template file doc.xml, by default taken from the
     3915         templates directory of the xml2rfc package (but this can be
     3916         changed with the --templates-dir switch).  The 4 preceding
    39183917         sources provide content that is used to expand the template
    3919          file when generating the "--docfile" and "--manpage" output.
    3920 
    3921    "--manpage"
     3918         file when generating the --docfile and --manpage output.
     3919
     3920   --manpage
    39223921      Show paged text documentation.
    39233922
     
    39253924      elements and attributes from the v3 RelaxNG schema file which is
    39263925      part of the xml2rfc distribution, and YAML and XML files that
    3927       provide the text content and formatting.  See the "--docfile"
    3928       switch for more details.
    3929 
    3930    "--country-help"
     3926      provide the text content and formatting.  See the --docfile switch
     3927      for more details.
     3928
     3929   --country-help
    39313930      Show the recognized <country> strings.
    39323931
    3933    "--pdf-help"
     3932   --pdf-help
    39343933      Show pdf generation requirements.
    39353934
    3936    "--template-dir"
     3935   --template-dir
    39373936      Directory to pull the doc.xml and doc.yaml templates from.  The
    39383937      default is the "templates" directory of the xml2rfc package.
    39393938
    3940       This is used to find the templates used by the "--docfile" and
    3941       "--manpage" commands and for legacy .html template and .dtd files.
     3939      This is used to find the templates used by the --docfile and
     3940      --manpage commands and for legacy .html template and .dtd files.
    39423941
    39433942      A consequence of being able to specify a different template
    39443943      directory than the default is that it's possible to use the
    3945       "--docfile" command to generate additional documentation XML files
     3944      --docfile command to generate additional documentation XML files
    39463945      based on the current V3 grammar file.  The default template and
    39473946      snippets file does not include documentation for deprecated
     
    39523951      escape sequences: '\ <' and '\ >'.
    39533952
    3954    "--values"
     3953   --values
    39553954      Show option values and from where they come.
    39563955
     
    39623961      *  Config file search path
    39633962
    3964    "--version", "-V"
     3963   --version, -V
    39653964      Display the version number and exit.
    39663965
    3967       With the "--verbose" switch, the versions of the external python
     3966      With the --verbose switch, the versions of the external python
    39683967      modules used will also be shown.
    39693968
     
    39753974   group has 10 options.
    39763975
    3977    "--text"
     3976   --text
    39783977      Outputs formatted text to file, with proper page breaks.
    39793978
    3980    "--html"
     3979   --html
    39813980      Outputs formatted HTML to file.
    39823981
    3983    "--nroff"
     3982   --nroff
    39843983      Outputs formatted nroff to file (only v2 input).
    39853984
    3986    "--pdf"
     3985   --pdf
    39873986      Outputs formatted PDF to file.
    39883987
    3989    "--raw"
     3988   --raw
    39903989      Outputs formatted text to file, unpaginated (only v2 input).
    39913990
    3992    "--expand"
     3991   --expand
    39933992      Outputs XML to file with all references expanded.
    39943993
    3995    "--v2v3"
     3994   --v2v3
    39963995      Convert vocabulary version 2 XML to version 3.
    39973996
    3998    "--preptool"
     3997   --preptool
    39993998      Run preptool on the input.
    40003999
    4001    "--unprep"
     4000   --unprep
    40024001      Reduce prepped xml to unprepped.
    40034002
    4004    "--info"
     4003   --info
    40054004      Generate a JSON file with anchor to section lookup information.
    40064005
    40074006B.4.  Generic Switch Options
    40084007
    4009    "--clear-cache", "-C"
     4008   --clear-cache, -C
    40104009      Purge the cache and exit.
    40114010
    4012    "--debug"
     4011   --debug
    40134012      Show debugging output.
    40144013
    4015    "--no-network", "-N"
     4014   --no-network, -N
    40164015      Don't use the network to resolve references.
    40174016
    4018    "--no-org-info", "-O"
     4017   --no-org-info, -O
    40194018      Don't show author orgainzation info on page one (legacy only).
    40204019
    4021    "--quiet", "-q"
     4020   --quiet, -q
    40224021      Don't print anything while working.
    40234022
    4024    "--skip-config-files"
     4023   --skip-config-files
    40254024      Ignore config file settings.
    40264025
     
    40304029      file settings to be ignored.
    40314030
    4032    "--remove-pis", "-r"
     4031   --remove-pis, -r
    40334032      Remove XML processing instructions.
    40344033
    4035    "--utf8", "-u"
     4034   --utf8, -u
    40364035      Generate utf8 output.
    40374036
    4038    "--verbose", "-v"
     4037   --verbose, -v
    40394038      Print extra information.
    40404039
    40414040B.5.  Generic Options with Values
    40424041
    4043    "--basename", "-b" = NAME
     4042   --basename, -b = NAME
    40444043      Specify the base name for output files.
    40454044
    4046    "--cache", "-c" = PATH
     4045   --cache, -c = PATH
    40474046      Specify a primary cache directory to write to; default: try [
    40484047      /var/cache/xml2rfc, ~/.cache/xml2rfc ].
    40494048
    4050    "--config-file" = FILE
     4049   --config-file = FILE
    40514050      Specify a configuration file.
    40524051
    40534052      This argument can be repeated, to read multiple explicitly
    40544053      specified config files.  They will be read after any config files
    4055       found in 'standard' locations have been read.  Run "xml2rfc
    4056       --values" to see the default search path for config files.
    4057 
    4058    "--dtd", "-d" = DTDFILE
     4054      found in 'standard' locations have been read.  Run xml2rfc
     4055      --values to see the default search path for config files.
     4056
     4057   --dtd, -d = DTDFILE
    40594058      Specify an alternate dtd file.
    40604059
    40614060      This option can be negated with --no-dtd.
    40624061
    4063    "--date", "-D" = DATE
     4062   --date, -D = DATE
    40644063      Run as if the date is DATE (format: yyyy-mm-dd).  Default: Today's
    40654064      date.
    40664065
    4067    "--filename", "-f" = FILE
     4066   --filename, -f = FILE
    40684067      Deprecated.  The same as -o.
    40694068
    4070    "--indent", "-i" = INDENT
     4069   --indent, -i = INDENT
    40714070      With some v3 formatters: Indentation to use when pretty-printing
    40724071      XML.
    40734072
    4074    "--out", "-o" = FILE
     4073   --out, -o = FILE
    40754074      Specify an explicit output filename.
    40764075
    4077    "--path", "-p" = PATH
     4076   --path, -p = PATH
    40784077      Specify the directory path for output files.
    40794078
    4080    "--silence", "-s" = STRING
     4079   --silence, -s = STRING
    40814080      Silence any warning beginning with the given string.
    40824081
     
    41024101B.6.  Generic Format Options
    41034102
    4104    "--v3"
     4103   --v3
    41054104      With --text and --html: use the v3 formatter, rather than the
    41064105      legacy one.
     
    41124111      intermediary conversion step.
    41134112
    4114    "--v2", "--legacy"
     4113   --v2, --legacy
    41154114      With --text and --html: use the legacy output formatters, rather
    41164115      than the v3 ones.
     
    41204119      be used with pure v2 input files.
    41214120
    4122    "--id-is-work-in-progress"
     4121   --id-is-work-in-progress
    41234122      In references, refer to Internet-Drafts as "Work in Progress".
    41244123
    41254124B.7.  Text Format Options
    41264125
    4127    "--no-headers"
     4126   --no-headers
    41284127      Calculate page breaks, and emit form feeds and page top spacing,
    41294128      but omit headers and footers from the paginated format.
    41304129
    4131    "--legacy-list-symbols"
     4130   --legacy-list-symbols
    41324131      Use the legacy list bullet symbols, rather than the new ones.
    41334132
    4134    "--legacy-date-format"
     4133   --legacy-date-format
    41354134      Use the legacy date format, rather than the new one.
    41364135
    41374136      This option can be negated with --no-legacy-date-format.
    41384137
    4139    "--list-symbols" = 4*CHAR
     4138   --list-symbols = 4*CHAR
    41404139      Use the characters given as list bullet symbols.
    41414140
    4142    "--BOM", "--bom"
     4141   --BOM, --bom
    41434142      Add a BOM (unicode byte order mark) to the start of text files.
    41444143
    4145    "--pagination", "--paginate"
     4144   --pagination, --paginate
    41464145      Do pagination.
    41474146
     
    41514150      This option can be negated with --no-pagination.
    41524151
    4153    "--table-hyphen-breaks"
     4152   --table-hyphen-breaks
    41544153      More easily do line breaks after hyphens in table cells to give a
    41554154      more compact table.
    41564155
    4157    "--table-borders"
     4156   --table-borders
    41584157
    41594158      Default value: full
     
    42174216B.8.  Html Format Options
    42184217
    4219    "--css" = FILE
     4218   --css = FILE
    42204219      Use the given CSS file instead of the builtin.
    42214220
    4222    "--external-css"
     4221   --external-css
    42234222      Place css in external files.
    42244223
    42254224      This option can be negated with --no-external-css.
    42264225
    4227    "--external-js"
     4226   --external-js
    42284227      Place js in external files.
    42294228
    42304229      This option can be negated with --no-external-js.
    42314230
    4232    "--rfc-base-url"
     4231   --rfc-base-url
    42334232
    42344233      Default value: https://www.rfc-editor.org/rfc/
     
    42364235      Base URL for RFC links.
    42374236
    4238    "--id-base-url"
     4237   --id-base-url
    42394238
    42404239      Default value: https://datatracker.ietf.org/doc/html/
     
    42424241      Base URL for Internet-Draft links.
    42434242
    4244    "--rfc-reference-base-url"
     4243   --rfc-reference-base-url
    42454244
    42464245      Default value: https://rfc-editor.org/rfc/
     
    42494248      value given in the reference entry.
    42504249
    4251    "--id-reference-base-url"
     4250   --id-reference-base-url
    42524251
    42534252      Default value: https://datatracker.ietf.org/doc/html/
     
    42554254      Base URL for I-D reference targets.
    42564255
    4257    "--metadata-js-url"
     4256   --metadata-js-url
    42584257
    42594258      Default value: metadata.min.js
     
    42634262B.9.  V2-V3 Converter Options
    42644263
    4265    "--add-xinclude"
     4264   --add-xinclude
    42664265      Replace reference elements with RFC and Internet-Draft seriesInfo
    42674266      with the appropriate XInclude element.
    42684267
    4269    "--draft-revs", "--draft-revisions"
     4268   --draft-revs, --draft-revisions
    42704269      Reference explicit draft revisions when inserting XIncludes for
    42714270      draft references.
    42724271
    4273    "--strict"
     4272   --strict
    42744273      Be strict about stripping some deprecated attributes.
    42754274
    42764275B.10.  Preptool Options
    42774276
    4278    "--accept-prepped"
     4277   --accept-prepped
    42794278      Accept already prepped input.
    42804279
    4281 Appendix C.  "xml2rfc" Configuration Files
     4280Appendix C.  xml2rfc Configuration Files
    42824281
    42834282   Most options have built-in defaults, and the command-line switches
    4284    above can be used to override those.  Additionally, "xml2rfc" will
    4285    look for config files in some standard file locations.  The option
    4286    "--values" will show the places "xml2rfc" will look for config files
    4287    on your system (among other information).  Any settings in config
    4288    files will override the program defaults, but will in turn be
    4289    overridden by command-line options.
     4283   above can be used to override those.  Additionally, xml2rfc will look
     4284   for config files in some standard file locations.  The option
     4285   --values will show the places xml2rfc will look for config files on
     4286   your system (among other information).  Any settings in config files
     4287   will override the program defaults, but will in turn be overridden by
     4288   command-line options.
    42904289
    42914290   The config files are expected to contain lines with option value
     
    43034302   abbreviations are handled during command-line option processing).
    43044303
    4305 Appendix D.  "xml2rfc" Documentation Template Variables
     4304Appendix D.  xml2rfc Documentation Template Variables
    43064305
    43074306   The following variables are available for use in an xml2rfc manpage
     
    43114310
    43124311   {{ descriptions }}:
    4313       The descriptions read from the "doc.yaml" file
     4312      The descriptions read from the doc.yaml file
    43144313
    43154314   {{ element_tags }}:
  • personal/kesara/3.9.1.dev0/xml2rfc/writers/text.py

    r3986 r4012  
    45664566    #    the formatting will be additive.
    45674567    def render_tt(self, e, width, **kwargs):
    4568         p = e.getparent()
    4569         render_plain = list(p.iterancestors('table')) and not utils.hastext(p, ignore=['tt'])
    4570         if render_plain:
    4571             text = '%s' % self.inner_text_renderer(e)
    4572         else:
    4573             text = '"%s"' % self.inner_text_renderer(e)
     4568        text = '%s' % self.inner_text_renderer(e)
    45744569        text += e.tail or ''
    45754570        return text
Note: See TracChangeset for help on using the changeset viewer.