[ofbiz-framework] branch trunk updated (70ff1c5 -> ee20e6c)

Previous Topic Next Topic
 
classic Classic list List threaded Threaded
3 messages Options
Reply | Threaded
Open this post in threaded view
|

[ofbiz-framework] branch trunk updated (70ff1c5 -> ee20e6c)

holivier
This is an automated email from the ASF dual-hosted git repository.

holivier pushed a change to branch trunk
in repository https://gitbox.apache.org/repos/asf/ofbiz-framework.git.


    from 70ff1c5  Fixed: createPartyGroupRoleAndContactMechs service not working (OFBIZ-11986)
     new f2f43bc  Improved: solve Error messages when generating HTML and PDF file from AsciiDoc files (OFBIZ-11893)
     new ee20e6c  Improved: solve Error messages when generating HTML and PDF file from AsciiDoc files (OFBIZ-11893)

The 2 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails.  The revisions
listed as "add" were already present in the repository and have only
been added to this reference.


Summary of changes:
 README.adoc                                 |  1 +
 build.gradle                                |  2 +
 docs/asciidoc/developer-manual.adoc         |  4 +-
 docs/asciidoc/documentation_guidelines.adoc | 79 +++++++++++++++++------------
 docs/asciidoc/user-manual.adoc              |  4 +-
 5 files changed, 56 insertions(+), 34 deletions(-)

Reply | Threaded
Open this post in threaded view
|

[ofbiz-framework] 01/02: Improved: solve Error messages when generating HTML and PDF file from AsciiDoc files (OFBIZ-11893)

holivier
This is an automated email from the ASF dual-hosted git repository.

holivier pushed a commit to branch trunk
in repository https://gitbox.apache.org/repos/asf/ofbiz-framework.git

commit f2f43bc8d146fbbb3470e7b204494df59abe3a54
Author: holivier <[hidden email]>
AuthorDate: Thu Oct 1 16:22:09 2020 +0200

    Improved: solve Error messages when generating HTML and PDF file from
    AsciiDoc files (OFBIZ-11893)
   
    * Add allow-uri-read when generated html and pdf to be able to allow
    image from external uri, it's used for apache2.0 image;
    Generalize usage of apache2.0 image for all main documents
    * Put Trunk Version in gradle generation parameter and so remove in all
    documents (to avoid Version unspecified)
---
 README.adoc                                 |  1 +
 build.gradle                                |  2 ++
 docs/asciidoc/developer-manual.adoc         |  4 ++-
 docs/asciidoc/documentation_guidelines.adoc | 52 +++++++++++++++--------------
 docs/asciidoc/user-manual.adoc              |  4 ++-
 5 files changed, 36 insertions(+), 27 deletions(-)

diff --git a/README.adoc b/README.adoc
index 944d5ee..8d74b10 100644
--- a/README.adoc
+++ b/README.adoc
@@ -18,6 +18,7 @@ under the License.
 ////
 [[apache-ofbiz]]
 = Apache OFBiz®
+The Apache OFBiz Project
 
 image:https://img.shields.io/badge/License-Apache%202.0-blue.svg[link="http://www.apache.org/licenses/LICENSE-2.0"]
 
diff --git a/build.gradle b/build.gradle
index e5ec8b4..830e000 100644
--- a/build.gradle
+++ b/build.gradle
@@ -504,7 +504,9 @@ tasks.withType(AsciidoctorTask) { task ->
     backends 'html5', 'pdf'
     attributes \
         'doctype': 'book',
+ 'revnumber': 'Trunk',
         'experimental': '',
+ 'allow-uri-read': true,
         'icons': 'font',
         'sectnums': '',
         'chapter-label': '',
diff --git a/docs/asciidoc/developer-manual.adoc b/docs/asciidoc/developer-manual.adoc
index c32f8e7..8ddd5a3 100644
--- a/docs/asciidoc/developer-manual.adoc
+++ b/docs/asciidoc/developer-manual.adoc
@@ -18,13 +18,15 @@ under the License.
 ////
 = Apache OFBiz Developer Manual
 The Apache OFBiz Project
-Release trunk
+
 :imagesdir: ./images
 ifdef::backend-pdf[]
 :title-logo-image: image::OFBiz-Logo.svg[Apache OFBiz Logo, pdfwidth=4.25in, align=center]
 :source-highlighter: rouge
 endif::[]
 
+image::https://img.shields.io/badge/License-Apache%202.0-blue.svg[link="http://www.apache.org/licenses/LICENSE-2.0"]
+
 == Introduction
 
 Welcome to the Apache OFBiz developer manual. This manual provides information
diff --git a/docs/asciidoc/documentation_guidelines.adoc b/docs/asciidoc/documentation_guidelines.adoc
index 011b59b..8d7b863 100644
--- a/docs/asciidoc/documentation_guidelines.adoc
+++ b/docs/asciidoc/documentation_guidelines.adoc
@@ -18,13 +18,15 @@ under the License.
 ////
 = Apache OFBiz Documentation Guidelines
 The Apache OFBiz Project
-Release trunk
+
 :imagesdir: ./images
 ifdef::backend-pdf[]
 :title-logo-image: image::OFBiz-Logo.svg[Apache OFBiz Logo, pdfwidth=4.25in, align=center]
 :source-highlighter: rouge
 endif::[]
 
+image:https://img.shields.io/badge/License-Apache%202.0-blue.svg[link="http://www.apache.org/licenses/LICENSE-2.0"]
+
 == Intro
 
 These guidelines serve as a general style guide and collection of examples of how we are documenting the project.
@@ -61,20 +63,18 @@ Please see below for details of the proposed configuration:
 
 ----
 The Apache OFBiz Project // <1>
-Release 17.12 // <2>
-:imagesdir: ./images // <3>
-ifdef::backend-pdf[] // <4>
-:title-logo-image: image::OFBiz-Logo.svg[Apache OFBiz Logo, pdfwidth=4.25in, align=center] // <5>
-:source-highlighter: rouge // <6>
-endif::[] // <7>
+:imagesdir: ./images // <2>
+ifdef::backend-pdf[] // <3>
+:title-logo-image: image::OFBiz-Logo.svg[Apache OFBiz Logo, pdfwidth=4.25in, align=center] // <4>
+:source-highlighter: rouge // <5>
+endif::[] // <6>
 ----
 <1> author
-<2> target release, indicates the release for which this documentation is valid
-<3> global definition of the image directory
-<4> begin block of configurations only for pdf rendering
-<5> define the title logo image
-<6> use the Rouge source code highlighter
-<7> end block of configurations only for PDF rendering
+<2> global definition of the image directory
+<3> begin block of configurations only for pdf rendering
+<4> define the title logo image
+<5> use the Rouge source code highlighter
+<6> end block of configurations only for PDF rendering
 
 The following configuration options are set globally in the Gradle build file.
 They are not configured in the document itself and are listed for reference only:
@@ -82,20 +82,22 @@ They are not configured in the document itself and are listed for reference only
 .build.gradle
 ----
 'doctype': 'book', // <1>
-'experimental': '', // <2>
-'icons': 'font', // <3>
-'sectnums': '', // <4>
-'chapter-label': '', // <5>
-'toc': '', // <6>
-'toclevels': '5' // <7>
+'revnumber': 'Trunk', // <2>
+'experimental': '', // <3>
+'icons': 'font', // <4>
+'sectnums': '', // <5>
+'chapter-label': '', // <6>
+'toc': '', // <7>
+'toclevels': '5' // <8>
 ----
 <1> doctype book
-<2> allow experimental features like keyboard shortcuts
-<3> make font awesome icons available
-<4> number chapters and sections automatically
-<5> do not prefix the chapters
-<6> insert a table of contents
-<7> max levels to show in the table of contents
+<2> target release, indicates the release for which the documentation is valid
+<3> allow experimental features like keyboard shortcuts
+<4> make font awesome icons available
+<5> number chapters and sections automatically
+<6> do not prefix the chapters
+<7> insert a table of contents
+<8> max levels to show in the table of contents
 
 === Apache License Header
 
diff --git a/docs/asciidoc/user-manual.adoc b/docs/asciidoc/user-manual.adoc
index c8393cb..70154a4 100644
--- a/docs/asciidoc/user-manual.adoc
+++ b/docs/asciidoc/user-manual.adoc
@@ -18,13 +18,15 @@ under the License.
 ////
 = Apache OFBiz User Manual
 The Apache OFBiz Project
-Release trunk
+
 :imagesdir: ./images
 ifdef::backend-pdf[]
 :title-logo-image: image::OFBiz-Logo.svg[Apache OFBiz Logo, pdfwidth=4.25in, align=center]
 :source-highlighter: rouge
 endif::[]
 
+image::https://img.shields.io/badge/License-Apache%202.0-blue.svg[link="http://www.apache.org/licenses/LICENSE-2.0"]
+
 == Introduction to OFBiz
 
 Welcome to _Apache OFBiz_! A powerful top level Apache software project.

Reply | Threaded
Open this post in threaded view
|

[ofbiz-framework] 02/02: Improved: solve Error messages when generating HTML and PDF file from AsciiDoc files (OFBIZ-11893)

holivier
In reply to this post by holivier
This is an automated email from the ASF dual-hosted git repository.

holivier pushed a commit to branch trunk
in repository https://gitbox.apache.org/repos/asf/ofbiz-framework.git

commit ee20e6c715e0301eb29b90ca5a0231b3fcc18816
Author: holivier <[hidden email]>
AuthorDate: Thu Oct 1 16:25:06 2020 +0200

    Improved: solve Error messages when generating HTML and PDF file from
    AsciiDoc files (OFBIZ-11893)
   
    Add the correct set when use icon, to avoid INFO message
---
 docs/asciidoc/documentation_guidelines.adoc | 27 ++++++++++++++++++++-------
 1 file changed, 20 insertions(+), 7 deletions(-)

diff --git a/docs/asciidoc/documentation_guidelines.adoc b/docs/asciidoc/documentation_guidelines.adoc
index 8d7b863..1c69c86 100644
--- a/docs/asciidoc/documentation_guidelines.adoc
+++ b/docs/asciidoc/documentation_guidelines.adoc
@@ -563,18 +563,31 @@ The result will be different depending on the rendering (PDF, HTML).
 === Using inline icons
 
 You can also add the `:icons: font` directive to the top of your document, which allows you to use the icons
-from http://fortawesome.github.io/Font-Awesome/icons/ directory via a macro.
+from http://fortawesome.github.io/Font-Awesome/icons/ directory via a macro using any of the following icon sets:
+
+* fa - https://fontawesome.com/v4.7.0/icons (default)
+* fas - https://fontawesome.com/icons?d=gallery&s=solid[Font Awesome - Solid]
+* fab - https://fontawesome.com/icons?d=gallery&s=brands[Font Awesome - Brands]
+* far - https://fontawesome.com/icons?d=gallery&s=regular[Font Awesome - Regular]
+* fi - http://zurb.com/playground/foundation-icon-fonts-3[Foundation Icons]
+* pf - https://paymentfont.com/[Payment font]
+
+The fa icon set is deprecated. Please use one of the other three FontAwesome icon sets. +
+when icon is not available in fa icon set but in an other, it's possible to give the correct set.
+
+The generate Document process generate a INFOS message, if icon is available in an other set and it is not given.
 ----
-icon:comment[] This is a comment icon
-icon:file[] And a file icon
-icon:battery-full[] And a battery icon
+icon:comment[set=far] This is a comment icon
+icon:file[set=far] And a file icon
+icon:battery-full[set=fas] And a battery icon
 ----
 
 .The output looks like the following
 [example]
-icon:comment[] This is a comment icon +
-icon:file[] And a file icon +
-icon:battery-full[] And a battery icon
+icon:comment[set=far] This is a comment icon +
+icon:file[set=far] And a file icon +
+icon:battery-full[set=fas] And a battery icon
+
 
 == How to write a...