[ https://issues.apache.org/jira/browse/OFBIZ-9873?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16467299#comment-16467299 ]
Jacques Le Roux edited comment on OFBIZ-9873 at 5/8/18 11:58 AM: ----------------------------------------------------------------- Hi Taher, bq. So can you share what you did exactly as a workaround? It seems from some of the research I've done that the problem really won't go away until the folks at asciidoctor release a new version with new dependencies. Yes, I simply replaced rouge by coderay like the Spring team does for now. I suggest that we replace rouge by coderay until rouge works in Windows, see [^OFBIZ-9873-rouge-coderay.patch] for that bq. generateOfbizDocumentation essentially publishes everything consolidated as one But that does not work for framework/entityext/src/doc/asciidoc/EntitySync-manual.adoc It's not included anywhere in a PDF or HTML at generation. So I need to do my own Gradle task or? I see that humanres.adoc has no way to generate the PDF/HTML too. So what do I miss? Are *.adoc like humanres.adoc and EntitySync-manual.adoc not supposed to generate PDF/HTML? I guess we need to discuss that on dev ML, no? was (Author: jacques.le.roux): Hi Taher, bq. So can you share what you did exactly as a workaround? It seems from some of the research I've done that the problem really won't go away until the folks at asciidoctor release a new version with new dependencies. Yes, I simply replaced rouge by coderay like the Spring team does for now. I suggest that we replace rouge by coderay until rouge works in Windows, see [^OFBIZ-9873-rouge-coderay.patch] for that bq. generateOfbizDocumentation essentially publishes everything consolidated as one But that does not work for framework/entityext/src/doc/asciidoc/EntitySync-manual.adoc It's not included anywhere in a PDF or HTML at generation. So I need to do my own Gradle task or? I see that humanres.adoc has no way to generate the PDF/HTML too. So what do I miss? Are *.ad [^OFBIZ-9873-rouge-coderay.patch] oc like humanres.adoc and EntitySync-manual.adoc not supposed to generate PDF/HTML? I guess we need to discuss that on dev ML, no? > Create a PoC for a documentation system for OFBiz based on Asciidoc > ------------------------------------------------------------------- > > Key: OFBIZ-9873 > URL: https://issues.apache.org/jira/browse/OFBIZ-9873 > Project: OFBiz > Issue Type: Improvement > Affects Versions: Upcoming Branch > Reporter: Taher Alkhateeb > Assignee: Taher Alkhateeb > Priority: Minor > Fix For: Upcoming Branch > > Attachments: OFBIZ-9873-rouge-coderay.patch, OFBIZ-9873.patch, > OFBIZ-9873.patch > > > In reference to the [discussion > thread|https://lists.apache.org/thread.html/8cc03b7b8733512244129ddae9e0cc1fb2a28e3e250aba1c8cf678f8@%3Cdev.ofbiz.apache.org%3E] > this is an attempt to create a PoC for OFBiz documentation system based on > Asciidoc. The main assumptions for the design of this system are: > - The documentation language to use is Asciidoc > - The documentation tool is Asciidoctor > - Publishing happens through Gradle using the asciidoctor gradle plugin (not > the OFBiz framework or anything else). > - The only place where we write documentation is inside the code base > - Every component contains its own documentation > - General documentation goes to either a standalone directory or a generic > component like common or base > - As much as possible, documentation files are small and focused on one > topic. And then other longer documents are constructed from these snippets of > documentation. > - We publish to all formats including PDF for users, or HTML for embedded > help and wiki pages. So OFBiz does not parse docbook for its help system, > instead it just renders generated HTML. -- This message was sent by Atlassian JIRA (v7.6.3#76005)