From 7e984551f7ca2e883c5a58cd8dae71dba0db6240 Mon Sep 17 00:00:00 2001 From: Sebastien Douheret Date: Mon, 19 Jun 2017 15:48:58 +0200 Subject: [PATCH] Add gitbook documentation (support PDF generation). To generate PDF doc: ./gendocs.sh pdf To generate HTML doc (local webserver): ./gendocs.sh serve Change-Id: Ib9b195814f4596a5cf5233d6a331d206e76c9bae Signed-off-by: Sebastien Douheret --- .gitignore | 2 + book.json | 93 + docs/1-frameworks.md | 0 docs/2-widgets.md | 0 docs/{overview.md => README.md} | 4 +- docs/SUMMARY.md | 11 + docs/_layouts/ebook/page.html | 36 + docs/_layouts/ebook/pdf_footer.html | 13 + docs/_layouts/ebook/pdf_header.html | 13 + docs/_layouts/ebook/summary.html | 58 + docs/_layouts/layout.html | 28 + docs/cover.jpg | Bin 0 -> 267142 bytes docs/cover_small.jpg | Bin 0 -> 18212 bytes docs/index.md | 1 - docs/pictures/make-units.svg | 13422 +++++----------------------------- docs/resources/cover.svg | 212 + docs/resources/ebook.css | 386 + docs/resources/make_cover.sh | 26 + gendocs.sh | 75 + mkdocs.yml | 2 +- 20 files changed, 2591 insertions(+), 11791 deletions(-) create mode 100644 book.json create mode 100644 docs/1-frameworks.md create mode 100644 docs/2-widgets.md rename docs/{overview.md => README.md} (99%) create mode 100644 docs/SUMMARY.md create mode 100644 docs/_layouts/ebook/page.html create mode 100644 docs/_layouts/ebook/pdf_footer.html create mode 100644 docs/_layouts/ebook/pdf_header.html create mode 100644 docs/_layouts/ebook/summary.html create mode 100644 docs/_layouts/layout.html create mode 100755 docs/cover.jpg create mode 100644 docs/cover_small.jpg delete mode 120000 docs/index.md create mode 100644 docs/resources/cover.svg create mode 100644 docs/resources/ebook.css create mode 100755 docs/resources/make_cover.sh create mode 100755 gendocs.sh diff --git a/.gitignore b/.gitignore index 9964491..6357f3f 100644 --- a/.gitignore +++ b/.gitignore @@ -5,3 +5,5 @@ build/ tests-w3c/ prepare-build.sh +node_modules/ +_book/ \ No newline at end of file diff --git a/book.json b/book.json new file mode 100644 index 0000000..da8c185 --- /dev/null +++ b/book.json @@ -0,0 +1,93 @@ +{ + "title": "Application Framework Service", + "description": "Application Framework Service of Automotive Grade Linux", + "keywords": "AGL, Development, application, framework, service", + "author": "IoT.Bzh Team", + "website": "http://iot.bzh", + "published": "June 2017", + "version": "4.0", + + "gitbook": "3.2.2", + "root": "docs", + "pdf": { + "fontFamily": "Verdana", + "fontSize": 12, + "paperSize": "a4", + "pageBreaksBefore": "//h:div[@class=\"page-break\"]" + }, + "styles": { + "website": "resources/ebook.css", + "ebook": "resources/ebook.css", + "pdf": "resources/ebook.css" + }, + + "hidepageheaders": [2], + "hidepagefooters": [2], + + "plugins": [ + "regexplace" + ], + "pluginsConfig": { + "regexplace": { + "removeFirstPartsInSectionNumber": true, + "substitutes": [{ + "pattern": "", + "flags": "g", + "substitute": "

" + }, + { + "pattern": "", + "flags": "g", + "substitute": "

" + }, + { + "pattern": "!\\[(.*?)\\]\$(.*?)(?:\\s+\"(.*)\")?\${0,}{caption=1([^\\}]*)}", + "flags": "gmi", + "substitute": "

", + "decode": true + }, + { + "pattern": "]*) {0,}\/{0,}> {0,}{caption=1([^\\}]*)}", + "flags": "g", + "substitute": "

", + "decode": true + }, + { + "pattern": "

", + "flags": "g", + "substitute": "

Picture _PAGE_LEVEL_._INDEX_: $2

", + "store": { + "substitute": "Pic. _PAGE_LEVEL_._INDEX_ $2", + "variable_name": "pictures" + } + }, + { + "pattern": "]*)> {0,}{style {1,}([^}]*)}", + "flags": "g", + "substitute": "", + "decode": true + } + ] + } + } +} diff --git a/docs/1-frameworks.md b/docs/1-frameworks.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/2-widgets.md b/docs/2-widgets.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/overview.md b/docs/README.md similarity index 99% rename from docs/overview.md rename to docs/README.md index f0441da..3373968 100644 --- a/docs/overview.md +++ b/docs/README.md @@ -79,7 +79,7 @@ This documentation explains the framework created by IoT.bzh by rewriting the Tizen Application Framework. Be aware of the previous foreword. - + Overview -------- @@ -87,7 +87,7 @@ The figure below shows the major components of the framework and their interactions going through the following scenario: APPLICATION installs an other application and then launch it. -![AppFW-APP_install_sequences][AppFW-APP_install_sequences] +![AppFW-APP_install_sequences][AppFW-APP_install_sequences]{style width:70%} Let follow the sequence of calls: diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md new file mode 100644 index 0000000..7357214 --- /dev/null +++ b/docs/SUMMARY.md @@ -0,0 +1,11 @@ +# Summary + +* [Overview](README.md) +* [Quick tutorial](quick-tutorial.md) +* [The frameworks](1-frameworks.md) + * [The application framework](application-framework.md) + * [The security framework](security-framework.md) +* [The afm daemons](afm-daemons.md) +* [Widgets of the framework](2-widgets.md) + * [Overview of widgets](widgets.md) + * [The configuration file](config.xml.md) \ No newline at end of file diff --git a/docs/_layouts/ebook/page.html b/docs/_layouts/ebook/page.html new file mode 100644 index 0000000..bf325e9 --- /dev/null +++ b/docs/_layouts/ebook/page.html @@ -0,0 +1,36 @@ +{% extends "layout.html" %} + +{% block title %}{{ page.title }}{% endblock %} +{% block description %}{{ page.description }}{% endblock %} + +{% block style %} + {### Include theme css before plugins css ###} + {% if not fileExists(config.styles.print) %} + {% if options.format %} + + {% else %} + + {% endif %} + {% endif %} + + {{ super() }} + + {### Custom stylesheets for the book ###} + + {% for type, style in config.styles %} + {% if fileExists(style) and (type == "ebook" or type == "print" or type == options.format) %} + + {% endif %} + {% endfor %} +{% endblock %} + +{% block body %} +

+ {% block page %} +

+ {{ page.content|safe }} +

+ {% endblock %} +

+{% endblock %} diff --git a/docs/_layouts/ebook/pdf_footer.html b/docs/_layouts/ebook/pdf_footer.html new file mode 100644 index 0000000..679e562 --- /dev/null +++ b/docs/_layouts/ebook/pdf_footer.html @@ -0,0 +1,13 @@ +{% extends "./page.html" %} +{% block body %} + + + + +{% endblock %} diff --git a/docs/_layouts/ebook/pdf_header.html b/docs/_layouts/ebook/pdf_header.html new file mode 100644 index 0000000..ef49641 --- /dev/null +++ b/docs/_layouts/ebook/pdf_header.html @@ -0,0 +1,13 @@ +{% extends "./page.html" %} +{% block body %} +

+ IoT.Bzh + {{ config.title }} +

+ + + + +{% endblock %} \ No newline at end of file diff --git a/docs/_layouts/ebook/summary.html b/docs/_layouts/ebook/summary.html new file mode 100644 index 0000000..be328a4 --- /dev/null +++ b/docs/_layouts/ebook/summary.html @@ -0,0 +1,58 @@ +{% extends "./page.html" %} + +{% block title %}{{ "SUMMARY"|t }}{% endblock %} + +{% macro articles(_articles) %} + {% for article in _articles %} +

+ + {% if article.path or article.url %} + {% if article.path %} + {{ article.title }} + {% else %} + {{ article.title }} + {% endif %} + {% else %} + {{ article.title }} + {% endif %} + {% if 1 %} + {{ article.level }} + {% endif %} + + {% if article.articles.length > 0 %} +

+ {{ articles(article.articles) }} + + {% endif %} +

+ {% endfor %} +{% endmacro %} + +{% block page %} +

+
{{ part.title }}
+
+ + {{ "GLOSSARY"|t }} + +

{{ page.title }}

{{ "SUMMARY"|t }}

{{ part.title }}