Uploaded image for project: 'OFBiz'
  1. OFBiz
  2. OFBIZ-12035

asciidoc Image directory convention for plugins and components

    XMLWordPrintableJSON

    Details

    • Type: Improvement
    • Status: Closed
    • Priority: Major
    • Resolution: Fixed
    • Affects Version/s: Trunk
    • Fix Version/s: Trunk
    • Component/s: birt
    • Labels:

      Description

      Plugins documentation (in asciidoc) can be generated with one document per plugins (in https://ci.apache.org/projects/ofbiz/site/trunk/pluginsdoc/ directory) or include in the general user-manual or developer-manual

      Currently, image usage not works in the two case, because image path is relative to the root document.

      To solve the problem, I propose to put image(s) relative to a component in the src/docs/asciidoc/images/${component.name} of the component and modifying gradle generateDocumentation task to copy the subdirectory in the general docs/asciidoc/images/ directory before generation and remove it after.

      Currently only birt is concern but it's better to have schema and other image in documentation, so in future all components should be concerned.

       

        Attachments

          Activity

            People

            • Assignee:
              holivier Olivier Heintz
              Reporter:
              holivier Olivier Heintz
            • Votes:
              0 Vote for this issue
              Watchers:
              3 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved: