XMLWordPrintableJSON

    • Icon: Change Request Change Request
    • Resolution: Persuasive
    • Icon: Medium Medium
    • Cross Paradigm Gender Harmony - Sex and Gender Representation (OTHER)
    • 1.0.0-ballot
    • Terminology Infrastructure
    • Model Overview [deprecated]
    • Hide

      We will do this in the following way:
      First you make a file for each of your plantuml files. Given them the extension ".plantuml". Put them into the "input/image-source" folder. The IG publisher will see these and create temporary svg renderings of them. Temporary because if you don't do step 2, then nothing results.
       
      Second in your markdown, where you want the uml diagram to appear you will ask the IG publisher to include your UML. You do this with the following, given a "foobar.plantuml" file name that holds the uml code (step 1 above).
       

      Unknown macro: {%include foobar.svg%}

       
      Third, this tends to have issues with overall rendering so you tend to need to add an explicit html break after it.

      <br clear="all>

       
      Fourth, you could use xml figure caption to give your image a nice figure caption. So here is the full recommendation
       

      <figure>

      Unknown macro: {%include foobar.svg%}

      <figcaption><b>Figure: UML for Foo Bar process</b></figcaption>
      </figure>
      <br clear="all>

       

      Show
      We will do this in the following way: First you make a file for each of your plantuml files. Given them the extension ".plantuml". Put them into the "input/image-source" folder. The IG publisher will see these and create temporary svg renderings of them. Temporary because if you don't do step 2, then nothing results.   Second in your markdown, where you want the uml diagram to appear you will ask the IG publisher to include your UML. You do this with the following, given a "foobar.plantuml" file name that holds the uml code (step 1 above).   Unknown macro: {%include foobar.svg%}   Third, this tends to have issues with overall rendering so you tend to need to add an explicit html break after it. <br clear="all>   Fourth, you could use xml figure caption to give your image a nice figure caption. So here is the full recommendation   <figure> Unknown macro: {%include foobar.svg%} <figcaption><b>Figure: UML for Foo Bar process</b></figcaption> </figure> <br clear="all>  
    • MaryKay McDaniel / Christopher Gracon : 6-0-3
    • Clarification
    • Non-substantive

      The diagram appears to be UML, but is a PNG. The IG tooling supports sourcing these diagrams in UML. (PLANTUML text format). The result is a SVG that is screen-reader friendly, and the publication of the PLANTUML source enables downstream reuse.

            seanmuir Sean Muir
            john_moehrke John Moehrke
            Watchers:
            3 Start watching this issue

              Created:
              Updated:
              Resolved: