[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=17206342#comment-17206342 ]

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

With last commit pulled, I have still the issue reported jut above, also forgot to report this one:

> Task :scrum-Documentation
oct. 02, 2020 7:05:28 PM uri:classloader:/gems/asciidoctor-1.5.8/lib/asciidoctor/parser.rb parse
GRAVE: scrum-add-sprint.adoc: line 44: invalid part, must have at least one section (e.g., chapter, appendix, etc.)
invalid part, must have at least one section (e.g., chapter, appendix, etc.) :: scrum-add-sprint.adoc :: C:/projectsASF/Git/ofbiz-framework/plugins/scrum/src/docs/asciidoc/_include/C:/projectsASF/Git/ofbiz-framework/plugins/scrum/src/doc
s/asciidoc/_include/scrum-add-sprint.adoc:44 (uri:classloader:/gems/asciidoctor-1.5.8/lib/asciidoctor/parser.rb:parse)
oct. 02, 2020 7:05:36 PM uri:classloader:/gems/asciidoctor-1.5.8/lib/asciidoctor/parser.rb parse
invalid part, must have at least one section (e.g., chapter, appendix, etc.) :: scrum-add-sprint.adoc :: C:/projectsASF/Git/ofbiz-framework/plugins/scrum/src/docs/asciidoc/_include/C:/projectsASF/Git/ofbiz-framework/plugins/scrum/src/doc
s/asciidoc/_include/scrum-add-sprint.adoc:44 (uri:classloader:/gems/asciidoctor-1.5.8/lib/asciidoctor/parser.rb:parse)GRAVE: scrum-add-sprint.adoc: line 44: invalid part, must have at least one section (e.g., chapter, appendix, etc.)

> 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)