Uploaded image for project: 'XJDF / JDF'
  1. XJDF / JDF
  2. JDF-633

Revise the use of glossary terms

    XMLWordPrintable

    Details

    • Type: Story
    • Status: Implemented (View Workflow)
    • Priority: Minor
    • Resolution: Fixed
    • Affects Version/s: None
    • Fix Version/s: 2.1
    • Component/s: all
    • Labels:
      None

      Description

      Currently the use of the glossary and glossary terms within all specifications is somewhat random.

      This is the original holding area for some ideas about the problem and possible solutions

      1. Move glossary to be an appendix
        Either as a table like the references appendix or as a more 'normal' glossary just listing words and definitions.
      2. Make the glossary a common framemaker chapter to all specifications.
        Use conditional markers if necessary to select the required terms for each document.
      3. Review the formatting of glossary terms.
        Currently these are simply italicized.
      4. Review existing document to use proper cross references to the glossary definitions.
        If possible in Framemaker get the term to have a hover over using the description from the table.
      5. Consider the case of glossary terms.
        Current practise is to avoid leading upper case as this clutters normal reading, however it's probably best.
      6. How to allow Jira drafts to indicate that the text is a glossary term.

       

       

        Draft

        <move "Allowed values are" and "Allowed values are from" entries as text to 1.11.3.1 Enumeration data types>
        <move "values include" and "Values include those from" entries as text to 1.11.3.2 NMTOKEN data types>

        Binding Side ...
        Enumeration ...
        Face Side ...
        Jog Edge ...
        NamedFeature ...
        Phase ...
        Queue Entry ...
        Queue ...
        Registered Side ...
        Unique ...
         

          Attachments

            Issue Links

              Activity

                People

                • Assignee:
                  Unassigned
                  Reporter:
                  GrahamMann Graham Mann
                • Votes:
                  0 Vote for this issue
                  Watchers:
                  2 Start watching this issue

                  Dates

                  • Created:
                    Updated:
                    Resolved: