Menu

#12 Need to Resolve Nomenclature Reference in Text

asap
pending
Tooling (8)
2021-04-05
2021-02-04
Martin
No

As the requirements, notes, etc. have to be written independently from their location where they appear in the document, we will have to clarify the relation between the text (mainly requirement) and related structural elements.
For example:

R5007: A SERVICE PROVIDER with GAS SUPPLY capabilities SHALL instantiate a VMD with pm:Type/@Code = [gs_ct_001] for each type of gas that is supplied for the device.

Thus, it is necessary that the [gs_ct_001] reference is resolved in a proper way.

1 Attachments

Discussion

  • Jan Schlamelcher

    • status: open --> pending
    • Attachments has changed:

    Diff:

    --- old
    +++ new
    @@ -0,0 +1 @@
    +hXid.diff (2.4 kB; text/x-patch)
    
     
  • Jan Schlamelcher

    Commit #9ae8779d63e4cc646 introduces anchors to all the respective elements in the generated HTML output. For table content, this is realized using the HTML <a> element and for section content (e.g. a VMD), this is realized using the respective <hX> element's "id" attribute as it works for classic HTML. The former is already supported by the external ieee-converter, the latter isn't. I've also prepared the attached patch for the ieee-converter to implement <hX id=""> based anchors that I will also provide via E-Mail directly.

    However, it seems that the ieee-converter does not handle references that are defined after being referred to, e.g. when referencing a metric from the alert system table, that comes before the table specifying the metrics in the generated artifact, the reference is not resolved correctly. This must be implemented in the ieee-converter to fully resolve this issue. I believe processing the input twice to first gather all references before generating the result in the second pass or something like that may be required. I tried to make sense of the ieee-converter's code in that regard but gave up after about 15 minutes due to this not being straight forward and such the author will probably be way quicker in implementing this than me, as he knows the tools architecture instead of having to understand it first.

     

    Last edit: Jan Schlamelcher 2021-04-05

Log in to post a comment.

Want the latest updates on software, tech news, and AI?
Get latest updates about software, tech news, and AI from SourceForge directly in your inbox once a month.