From 96baf20ed87b231082751481c1dbcfd737851ff2 Mon Sep 17 00:00:00 2001
From: Stephane Desneux <stephane.desneux@iot.bzh>
Date: Tue, 15 Nov 2016 02:10:13 +0100
Subject: webdocs: allow fetching PDFs; update documentation in _tocs files

Change-Id: I9b677f0ad3b161ffb12471a989f5e8ca455baab2
Signed-off-by: Stephane Desneux <stephane.desneux@iot.bzh>
---
 site/_tocs/architecture/fetched_files.yml | 64 +++++++++++++++++--------------
 site/_tocs/architecture/toc_dev_en.yml    | 41 ++++++++++++++++----
 2 files changed, 70 insertions(+), 35 deletions(-)

(limited to 'site/_tocs/architecture')

diff --git a/site/_tocs/architecture/fetched_files.yml b/site/_tocs/architecture/fetched_files.yml
index a16a6ee..4d21b8a 100644
--- a/site/_tocs/architecture/fetched_files.yml
+++ b/site/_tocs/architecture/fetched_files.yml
@@ -1,19 +1,41 @@
-# REFERENCE ENTRY:
+##############################################################################################################
+# GLOBAL DOCUMENT
+#   <any REPOSITORY option>: global setting
+#   repositories: array of objects with documents to fetchd
+#
+# REPOSITORY ENTRY:
 # -
-#   url_fetch : gitweb fetch URL (format string with token %repo% %uri%
-#      GERRIT_FETCH=  "https://gerrit.automotivelinux.org/gerrit/gitweb?p=%repo%;a=blob_plain;f=%source%;hb=%commit%"
-#      GITHUB_FETCH= "https://raw.githubusercontent.com/%repo%/%commit%/%source%"
-#   repository: git repository name
-#      GITHUB_EDIT= "https://raw.github.com/%repo%/blob/%commit%/%source%"
-#   git_commit: git commit when not default
-#   destination_prefix: optional destination prefix 
-#   documents:
-#     -
-#       source  : "source patch within url_fetch"
-#       destination  : "optional: destination path default=path.join(destination_prefix+source)"
-#       label: "optional: friendly name for submenu default=basename(source) overloaded by file content"
-#       title: "optional: info about document (default label, overloaded by file content)"
+#   url_fetch : gitweb fetch URL (format string with token %repo% %commit% %source%, defined in configuration)
+#   url_edit  : gitweb edut URL (format string with token %repo% %commit% %source%, defined in configuration)
+#   git_name: repository name (%repo%)
+#   git_commit: git reference: revision, SHA1, branch... (%commit%)
+#   src_prefix: prefix prepended to %source%
+#   dst_prefix: prefix prepended to destination name
+#   documents: array of documents to fetch
+#
+# DOCUMENT ENTRY:
+#   source: subpath within repository (%source%)
+#   destination: local destination filename
+#   label|title: name within TOC
+#   edit|editURI: specific edition URI
 #
+# EXAMPLE:
+# ------------------------------------
+# url: "GERRIT_FETCH"
+# git_commit: "master"
+# repositories: 
+# -
+#    git_name: src/foo
+#    src_prefix: docs
+#    dst_prefix: foodocs
+#    documents:
+#       - source: intro.md
+#         label: Introduction
+#       - source: topic/README.md
+#         destination: topic.md
+#         label: My Topic
+# ------------------------------------
+##############################################################################################################
 
 url_fetch  : "GITHUB_FETCH"
 url_edit   : "GITHUB_EDIT"
@@ -77,17 +99,3 @@ repositories:
           label: Threat Analysis
         - source: 06-attack-surfaces.md
           label: Attack Surfaces
--
-    git_name : automotive-grade-linux/docs-agl
-    src_prefix : docs
-    dst_prefix: components
-    documents:
-        - source: app-framework/index.md
-          destination: app-framework.md
-          label: Application Framework
-        - source: signaling/index.md
-          destination: signaling.md
-          label: Message signaling
-        - source: audio/index.md
-          destination: audio.md
-          label: Audio Framework
diff --git a/site/_tocs/architecture/toc_dev_en.yml b/site/_tocs/architecture/toc_dev_en.yml
index 05f8416..64d452e 100644
--- a/site/_tocs/architecture/toc_dev_en.yml
+++ b/site/_tocs/architecture/toc_dev_en.yml
@@ -1,12 +1,45 @@
+#######################################################################
 # WARNING: 
 #  - TOC should reference .HTML and .md (Index OK but Error 404)
 #  - do not forget to run 'docbuild --tocs' after any changes 
+#
+# 
+############################ SYNTAX ###################################
+# GLOBAL OPTIONS:
+#    name: TOC (page) title
+#    template: name of template to use for this page - use 'generated_index.html' if unknown
+#    children: array of TOC entries
+#
+# TOC Entry:
+#     name: TOC entry (level 1)
+#     children:
+#         - 
+#            name: optional name for TOC entry (default: use URL FrontMatter info)
+#            url: <subdir as defined with FETCH_DIR in conf/AppDefault.js:
+#         -
+#            name: ...
+#            url: ...
+#         ...
+#
+# EXAMPLE:
+# -------------------------------
+# name: Developer Guides
+# template: generated_index.html
+# children:
+# -
+#   name: Application Framework
+#   children:
+#       - url: reference/af-main/overview.html
+#       - url: reference/af-main/afm-system-daemon.html
+#       - url: reference/af-main/afm-user-daemon.html
+# -------------------------------
+#######################################################################
 
 name: Architecture Guides
 template: generated_index.html
 children:
 -
-    name: AGL Specifications 1.0
+    name: AGL Specifications
     children:
         - url: reference/specs/01-overview.html
         - url: reference/specs/02-architecture.html
@@ -21,12 +54,6 @@ children:
         - url: reference/security/04-adversaries.html
         - url: reference/security/05-threat-analysis.html
         - url: reference/security/06-attack-surfaces.html
--
-    name: Components
-    children:
-        - url: reference/components/app-framework.html
-        - url: reference/components/signaling.html
-        - url: reference/components/audio.html
 
 
  
-- 
cgit