You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@ofbiz.apache.org by ho...@apache.org on 2020/10/01 14:30:17 UTC
[ofbiz-framework] 01/02: Improved: solve Error messages when
generating HTML and PDF file from AsciiDoc files (OFBIZ-11893)
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 <ho...@apache.org>
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.