[jira] [Commented] (OFBIZ-12035) asciidoc Image directory convention for plugins and components

[Nicolas Malin (Jira)]

    [ https://issues.apache.org/jira/browse/OFBIZ-12035?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17206744#comment-17206744 ]

Jacques Le Roux commented on OFBIZ-12035:
-----------------------------------------

[I reported this|https://issues.apache.org/jira/browse/OFBIZ-11976?focusedCommentId=17206366&page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel#comment-17206366] in OFBIZ-11976, here it is again for clarity:

I have just noticed that (forget the rest, my own local tools):

        docs/asciidoc/images/birt/
        docs/asciidoc/images/security/

       scrum/src/docs/asciidoc/images/



{noformat}
C:\projectsASF\Git\ofbiz-framework>git status
On branch trunk
Your branch is up to date with 'origin/trunk'.

Untracked files:
  (use "git add <file>..." to include in what will be committed)
        docs/asciidoc/images/birt/
        docs/asciidoc/images/security/
        g.bat
        gc.bat
        gup.bat
        test.bat
        testu.bat
        tools/

nothing added to commit but untracked files present (use "git add" to track)

C:\projectsASF\Git\ofbiz-framework>cd plugins

C:\projectsASF\Git\ofbiz-framework\plugins>git status
On branch trunk
Your branch is up to date with 'origin/trunk'.

Untracked files:
  (use "git add <file>..." to include in what will be committed)
        OFBIZ-12029-StringUtil.wrapString-plugins.patch
        p-variantinfojs-2.patch
        p-variantinfojs-final.patch
        scrum/src/docs/asciidoc/images/
        variantinfojs-final.patch

nothing added to commit but untracked files present (use "git add" to track)

C:\projectsASF\Git\ofbiz-framework\plugins>
{noformat}

I don't remember which tasks generated which dirs

> asciidoc Image directory convention for plugins and components
> --------------------------------------------------------------
>
>                 Key: OFBIZ-12035
>                 URL: https://issues.apache.org/jira/browse/OFBIZ-12035
>             Project: OFBiz
>          Issue Type: Improvement
>          Components: birt
>    Affects Versions: Trunk
>            Reporter: Olivier Heintz
>            Assignee: Olivier Heintz
>            Priority: Major
>              Labels: Documentation
>         Attachments: framework_0001-Improved-change-asciidoc-Image-directory-convention-.patch, framework_0001-Improved-change-asciidoc-Image-directory-convention-.patch, plugins_0001-Improved-change-asciidoc-Image-directory-convention-.patch
>
>
> 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|https://ci.apache.org/projects/ofbiz/site/trunk/ofbizdoc/html5/user-manual.html#_apache_ofbiz_plugins] or [developer-manual|https://ci.apache.org/projects/ofbiz/site/trunk/ofbizdoc/html5/developer-manual.html#_apache_ofbiz_plugins_for_developer]
> 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.
>  

--
This message was sent by Atlassian Jira
(v8.3.4#803005)