transpect / docx2hub

Converts Microsoft docx to flat hub XML
BSD 2-Clause "Simplified" License
27 stars 15 forks source link

Convey information when a footnote label rendered in the text differs from the label in the note #11

Open gimsieke opened 7 years ago

gimsieke commented 7 years ago

In OOXML: <w:footnoteReference w:customMarkFollows="1" w:id="…"/>, followed by w:t with the label that is rendered in the text. It is not clear whether DocBook’s label attribute is intended to convey the label rendered in the note or in the text. Since we only use phrase[@role='hub:identifier'] to mark up the note label, we could use @label for the differing text label. Otherwise we can maybe use @xreflabel.

mkraetke commented 7 years ago

The DocBook documentation states that @label identifies the desired footnote mark. In this sense, it would be an appropriate choice. The term footnote mark is commonly used for marks in the text (e.g. LaTeX \footnotemark).

gimsieke commented 7 years ago

I think DocBook’s label attribute is meant to set both marks at once.

mkraetke commented 7 years ago

If you are afraid that the semantics of label is too ambiguous, then I would suggest to use xreflabel. Here is a brief example:

<footnote>
  <para role="Funotentext" css:text-align="left">
    <phrase role="hub:identifier" xreflabel="*">1</phrase>
    <phrase role="hub:separator" xml:space="preserve"> </phrase>
      Footnote text
  </para>
</footnote>