You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@ofbiz.apache.org by "Olivier Heintz (Jira)" <ji...@apache.org> on 2020/10/01 13:24:00 UTC
[jira] [Created] (OFBIZ-12035) asciidoc Image directory convention
for plugins and components
Olivier Heintz created OFBIZ-12035:
--------------------------------------
Summary: 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
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)