aboutsummaryrefslogtreecommitdiffstats
path: root/content/tocs/apis_services
diff options
context:
space:
mode:
authorStephane Desneux <stephane.desneux@iot.bzh>2017-06-26 17:43:59 +0200
committerStephane Desneux <stephane.desneux@iot.bzh>2017-06-26 17:43:59 +0200
commitdd54a533478aa65bbc87062ff87afd0cad575460 (patch)
tree1b0024cb1854ad0e9a118d939f385d824445e0d8 /content/tocs/apis_services
parent00ebd2eaa87bec05deae4a3240f388cfe71a3f92 (diff)
webdocs: rename 'contain' to 'content'
Change-Id: I75f933607df22cebae8b31882cc86489c95a9f18 Signed-off-by: Stephane Desneux <stephane.desneux@iot.bzh>
Diffstat (limited to 'content/tocs/apis_services')
-rw-r--r--content/tocs/apis_services/fetched_files.yml187
-rw-r--r--content/tocs/apis_services/toc_dev_en.yml84
2 files changed, 271 insertions, 0 deletions
diff --git a/content/tocs/apis_services/fetched_files.yml b/content/tocs/apis_services/fetched_files.yml
new file mode 100644
index 0000000..24d3194
--- /dev/null
+++ b/content/tocs/apis_services/fetched_files.yml
@@ -0,0 +1,187 @@
+##############################################################################################################
+# 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% %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 : "GERRIT_FETCH"
+git_commit : "AGL_GERRIT_BRANCH"
+
+repositories:
+-
+ git_name : src/app-framework-main
+ git_commit: master
+ src_prefix : docs
+ dst_prefix: af-main
+ documents:
+ - source: 0-introduction.md
+ label: Introduction
+ - source: 1-afm-daemons.md
+ label: The afm daemons
+ - source: 2-widgets.md
+ label: Widgets
+ - source: 2.1-widgets.md
+ label: Overview of widgets
+ - source: 2.2-config.xml.md
+ label: Widget configuration file
+ - source: 3-permissions.md
+ label: Permissions
+ - source: 4-quick-tutorial.md
+ label: Quick Tutorial
+ - source: pictures/afm-daemons.svg
+ - source: pictures/AppFW-APP_install_sequences.svg
+ - source: pictures/make-units.svg
+ - source: pictures/Security_model_history.svg
+ - source: pictures/triskel_iot_bzh.svg
+
+-
+ git_name : src/app-framework-binder
+ git_commit: master
+ src_prefix : docs
+ dst_prefix: af-binder
+ documents:
+ - source: afb-overview.md
+ label: Binder Overview
+ - source: afb-binding-writing.md
+ label: How to write a binding ?
+ - source: afb-binding-references.md
+ label: Binding references
+ - source: afb-migration-v1-to-v2.md
+ label: Migration from v1 to v2
+ - source: afb-events-guide.md
+ label: Binder events guide
+ - source: afb-application-writing.md
+ label: Binder Application writing guide
+ - source: afb-daemon-vocabulary.md
+ label: Binder daemon vocabulary
+ - source: afb-desktop-package.md
+ label: Installing the binder on a desktop
+ - source: afb-daemon-options.md
+ label: Options of afb-daemon
+ - source: pictures/AFB_for_services.svg
+ - source: pictures/basis.svg
+ - source: pictures/interconnection.svg
+ - source: pictures/signaling-basis.svg
+ - source: pictures/tic-tac-toe.svg
+ - source: pictures/triskel_iot_bzh.svg
+
+-
+ url_fetch: AGL_GITHUB_FETCH
+ url_edit: AGL_GITHUB_EDIT
+ git_name: "%project_source%/docs-agl"
+ git_commit: "AGL_GITHUB_BRANCH"
+ src_prefix: docs/app-framework
+ dst_prefix: af-binder
+ documents:
+ - source: index.md
+ destination: resources.md
+ label: Resources
+-
+ url_fetch: AGL_GITHUB_FETCH
+ url_edit: AGL_GITHUB_EDIT
+ git_name: "%project_source%/docs-agl"
+ git_commit: "AGL_GITHUB_BRANCH"
+ src_prefix: docs/signaling
+ dst_prefix: signaling
+ documents:
+ - source: architecture.md
+ destination: architecture.md
+ label: Signaling Architecture
+ - source: low-level-can-service-guide.md
+ destination: low-level-can-service-guide.md
+ label: Low level CAN service Guide
+ - source: high-level-viwi-service.md
+ destination: high-level-viwi-service.md
+ label: High level ViWi service Guide
+ - source: index.md
+ destination: resources.md
+ label: Resources
+ - source: images/agent-arch.svg
+ - source: images/agent-sample.svg
+ - source: images/cloud-arch.svg
+ - source: images/can-generator.svg
+ - source: images/distributed-arch.svg
+ - source: images/distributed-arch.png
+ - source: images/signal-service-arch.svg
+ - source: images/OpenXC_to_AGL.png
+ - source: images/CAN_level_mapping.png
+ - source: images/CAN_bindings_communication.png
+ - source: images/high-level-arch.png
+-
+ url_fetch: http://iot.bzh/download/public/2016/%source%
+ dst_prefix: iotbzh2016
+ documents:
+ - source: signaling/AGL-AppFW-CAN-Signaling-Benchmark.pdf
+ - source: signaling/AGL-Message-Signaling-Developer-Guidelines.pdf
+-
+ url_fetch: AGL_GITHUB_FETCH
+ url_edit: AGL_GITHUB_EDIT
+ git_name: "%project_source%/docs-agl"
+ git_commit: "AGL_GITHUB_BRANCH"
+ src_prefix: docs/audio
+ dst_prefix: audio
+ documents:
+ - source: index.md
+ destination: resources.md
+ label: Resources
+-
+ url_fetch : GERRIT_FETCH
+ git_commit : master
+ git_name : apps/homescreen
+ src_prefix : homescreen/docs
+ dst_prefix : homescreen
+ documents:
+ - source: homescreen_api.md
+ label: HomeScreen API
+ - source: pictures/api_getAllSurfacesOfProcess.png
+ destination: pictures/api_getAllSurfacesOfProcess.png
+ - source: pictures/api_getSurfaceStatus_1.png
+ destination: pictures/api_getSurfaceStatus_1.png
+ - source: pictures/api_getSurfaceStatus_2.png
+ destination: pictures/api_getSurfaceStatus_2.png
+ - source: pictures/api_getSurfaceStatus_3.png
+ destination: pictures/api_getSurfaceStatus_3.png
+ - source: pictures/api_hardKeyPressed.png
+ destination: pictures/api_hardKeyPressed.png
+ - source: pictures/api_renderSurfaceToArea.png
+ destination: pictures/api_renderSurfaceToArea.png
+ - source: pictures/api_renderSurfaceToAreaAllowed.png
+ destination: pictures/api_renderSurfaceToAreaAllowed.png
+ - source: pictures/api_requestSurfaceIdToFullScreen.png
+ destination: pictures/api_requestSurfaceIdToFullScreen.png
+ - source: pictures/api_surfaceVisibilityChanged.png
+ destination: pictures/api_surfaceVisibilityChanged.png
+
diff --git a/content/tocs/apis_services/toc_dev_en.yml b/content/tocs/apis_services/toc_dev_en.yml
new file mode 100644
index 0000000..083a9a7
--- /dev/null
+++ b/content/tocs/apis_services/toc_dev_en.yml
@@ -0,0 +1,84 @@
+#######################################################################
+# 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/AppDefaults.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: Developer Guides
+template: generated_index.html
+children:
+-
+ name: Application Framework
+ children:
+ - url: reference/af-main/0-introduction.html
+ - url: reference/af-main/1-afm-daemons.html
+ - url: reference/af-main/2-widgets.html
+ - url: reference/af-main/2.1-widgets.html
+ - url: reference/af-main/2.2-config.xml.html
+ - url: reference/af-main/3-permissions.html
+ - url: reference/af-main/4-quick-tutorial.html
+-
+ name: Application Framework Binder
+ children:
+ - url: reference/af-binder/afb-overview.html
+ - url: reference/af-binder/afb-binding-writing.html
+ - url: reference/af-binder/afb-binding-references.html
+ - url: reference/af-binder/afb-migration-v1-to-v2.html
+ - url: reference/af-binder/afb-events-guide.html
+ - url: reference/af-binder/afb-application-writing.html
+ - url: reference/af-binder/afb-daemon-vocabulary.html
+ - url: reference/af-binder/afb-desktop-package.html
+ - url: reference/af-binder/afb-daemon-options.html
+
+-
+ name: Message Signaling
+ children:
+ - url: reference/signaling/architecture.html
+ - url: reference/signaling/low-level-can-service-guide.html
+ - url: reference/signaling/high-level-viwi-service.html
+ - name: Developer Guidelines
+ url: reference/iotbzh2016/signaling/AGL-Message-Signaling-Developer-Guidelines.pdf
+ - name: CAN Signaling Benchmark
+ url: reference/iotbzh2016/signaling/AGL-AppFW-CAN-Signaling-Benchmark.pdf
+ - url: reference/signaling/resources.html
+-
+ name: Audio Framework
+ children:
+ - url: reference/audio/resources.html
+-
+ name: HomeScreen
+ children:
+ - url: reference/homescreen/homescreen_api.html
+
+