From c0fafcb577abb8108490540f7ecfe949a92c7fd0 Mon Sep 17 00:00:00 2001 From: Clément Bénier Date: Sun, 24 Feb 2019 20:05:22 +0100 Subject: reset tocs MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Clément Bénier --- content/tocs/apis_services/fetched_files.yml | 420 +++++++++++++++++++++++++++ content/tocs/apis_services/toc_dev_en.yml | 181 ++++++++++++ 2 files changed, 601 insertions(+) create mode 100644 content/tocs/apis_services/fetched_files.yml create mode 100644 content/tocs/apis_services/toc_dev_en.yml (limited to 'content/tocs/apis_services') diff --git a/content/tocs/apis_services/fetched_files.yml b/content/tocs/apis_services/fetched_files.yml new file mode 100644 index 0000000..f1709a0 --- /dev/null +++ b/content/tocs/apis_services/fetched_files.yml @@ -0,0 +1,420 @@ +############################################################################################################## +# GLOBAL DOCUMENT +# : 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 + src_prefix: docs + dst_prefix: af-main + documents: + - source: 0-introduction.md + label: Introduction + - source: 0-kristi-introduction.md + label: API Reference + - 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 + src_prefix: docs + dst_prefix: af-binder + documents: + - source: index.md + label: Binder index + - source: afb-overview.md + label: Overview + - source: afb-binding-writing.md + label: How to write a binding ? + - source: afb-binding-references.md + label: Binding references + - source: reference-v3/types-and-globals.md + label: Types and globals + - source: reference-v3/func-api.md + label: Functions of class afb_api + - source: reference-v3/func-req.md + label: Functions of class afb_req + - source: reference-v3/func-event.md + label: Functions of class afb_event + - source: reference-v3/func-daemon.md + label: Functions of class afb_daemon + - source: reference-v3/func-service.md + label: Functions of class afb_service + - source: reference-v3/macro-log.md + label: Macros for logging + - source: afb-migration-to-binding-v3.md + label: Migration to bindings v3 + - 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-debugging.md + label: Debugging binder and bindings + - source: afb-daemon-options.md + label: Options of afb-daemon + - source: protocol-x-afb-ws-json1.md + label: WebSocket protocol x-afb-ws-json1 + - source: annexes.md + label: Annexes + - source: REVISIONS.md + label: Document revision + - source: legacy/afb-migration-v1-to-v2.md + label: LEGACY Migration from v1 to v2 + - source: legacy/afb-binding-v2-references.md + label: LEGACY Binding V2 references + - 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 + +- + git_name: apps/agl-service-can-low-level + src_prefix: docs + dst_prefix: signaling + documents: + - source: 1-Architecture.md + destination: low-can-architecture.md + label: Architecture presentation + - source: 2-Installation.md + destination: low-can-installation-guide.md + label: Installation Guide + - source: 3-Usage.md + destination: low-can-usage-guide.md + label: Usage Guide + - source: images/CAN_bindings_communication.png + - source: images/CAN_level_mapping.png + - source: images/OpenXC_to_AGL.png + +- + git_name: apps/app-afb-test + src_prefix: docs + dst_prefix: afb-test + documents: + - source: 0_Installation.md + destination: Installation.md + label: Installation + - source: 1_Write_the_tests.md + destination: write-the-tests.md + label: Write the tests + - source: 2_The_test_widget.md + destination: the-test-widget.md + label: The test widget + - source: 3_Launch_the_tests.md + destination: launch-the-tests.md + label: Launch the tests + - source: 4_Tests_Examples.md + destination: tests-examples.md + label: Tests examples + - source: Reference/0_BindingTestFunctions.md + destination: binding-test-functions.md + label: Binding Test Functions + - source: Reference/1_BindingAssertFunctions.md + destination: binding-assert-functions.md + label: Binding Assert Functions + - source: Reference/2_TestFrameworkFunctions.md + destination: test-framework-functions.md + label: Test Framework Functions + - source: Reference/LuaUnitAssertionFunctions/0_GeneralAssertions.md + destination: general-assertions.md + label: General Assertions + - source: Reference/LuaUnitAssertionFunctions/1_ValueAssertions.md + destination: value-assertions.md + label: Value Assertions + - source: Reference/LuaUnitAssertionFunctions/2_ScientificAssertions.md + destination: scientific-assertions.md + label: Scientific Assertions + - source: Reference/LuaUnitAssertionFunctions/3_StringAssertions.md + destination: string-assertions.md + label: String Assertions + - source: Reference/LuaUnitAssertionFunctions/4_ErrorAssertions.md + destination: error-assertions.md + label: Error Assertions + - source: Reference/LuaUnitAssertionFunctions/5_TypeAssertions.md + destination: type-assertions.md + label: Type Assertions + - source: Reference/LuaUnitAssertionFunctions/6_TableAssertions.md + destination: table-assertions.md + label: Table Assertions + +- + url_fetch: GITHUB_FETCH + url_edit: GITHUB_EDIT + git_name: iotbzh/high-level-viwi-service + git_commit: master + src_prefix: docs + dst_prefix: signaling + documents: + - source: 1-Architecture.md + destination: high-viwi-architecture.md + label: Architecture presentation + - source: 2-Install-Usage.md + destination: high-viwi-install-usage-guide.md + label: Installation and Usage Guide + - source: images/high-level-arch.png +- + git_name: apps/agl-service-signal-composer + src_prefix: docs/part-1/ + dst_prefix: signaling + documents: + - source: 1-Architecture.md + destination: signal-composer-architecture.md + label: Architecture presentation + - source: 2-Configuration.md + destination: signal-composer-configuration.md + label: Configuration + - source: 3-Plugins.md + destination: signal-composer-plugins.md + label: Plugins + - source: 4-SignalComposerAPI.md + destination: signal-composer-api.md + label: Signal Composer API + - source: pictures/Global_Signaling_Architecture.png + - source: pictures/iotbzh_logo_small.png +- + url_fetch: GITHUB_FETCH + url_edit: GITHUB_EDIT + git_name: iotbzh/agl-documentation + git_commit: master + documents: + - source: candevstudio/docs/1_Usage.md + - source: candevstudio/docs/2_can_device_socketcan_backend.md + - source: candevstudio/docs/3_Add_CAN_Device.md + - source: candevstudio/docs/4_Configure_CanRawSender_Node.md + - source: candevstudio/docs/5_Using_CanRawView.md + - source: candevstudio/docs/pictures/CANdevStudio.png + - source: candevstudio/docs/pictures/canrawsender.png + - source: candevstudio/docs/pictures/canrawviewer.png + +- + url_fetch: AGL_GITHUB_FETCH + url_edit: AGL_GITHUB_EDIT + git_name: automotive-grade-linux/docs-sources + 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: automotive-grade-linux/docs-sources + git_commit: AGL_GITHUB_BRANCH + src_prefix: docs/signaling + dst_prefix: signaling + documents: + - source: architecture.md + destination: architecture.md + label: Signaling Architecture + - 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 +- + url_fetch: https://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: automotive-grade-linux/docs-sources + git_commit: AGL_GITHUB_BRANCH + src_prefix: docs/audio + dst_prefix: audio + documents: + - source: 4a-framework.md + destination: 4a-framework.md + label: 4a-framework + - source: bluez-alsa.md + destination: bluez-alsa.md + label: bluez-alsa +- + git_name: apps/agl-service-audio-4a + src_prefix: docs + dst_prefix: audio + documents: + - source: 4a-framework/README.md + label: Architecture + - source: 4a-framework/concepts.md + label: Concepts + - source: 4a-framework/components.md + label: Components + - source: 4a-framework/images/4a-architecture.svg + - source: 4a-framework/images/apps-architecture.svg + - source: 4a-framework/images/agl-audio-arch.png + - source: high-level-api/README.md + label: Abstract + - source: high-level-api/kickstart.md + label: Kickstart + - source: high-level-api/reference.md + label: Reference + - source: high-level-api/TipsAndTricks/AdjustVolumes.md + label: Adjust volumes + - source: high-level-api/TipsAndTricks/4aTools.md + label: 4a-tools + - source: high-level-api/TipsAndTricks/Devices.md + label: Devices + - source: high-level-api/TipsAndTricks/HALs.md + label: HALs + - source: high-level-api/TipsAndTricks/images/changeSound.png + - source: high-level-api/TipsAndTricks/images/MixerBaseMenu.png +- + git_name: src/pulseaudio-module-4a + dst_prefix: audio + documents: + - source: README.md + destination: pulseaudio-module-4a.md + label: Pulseaudio - 4A Integration Module +- + git_name: apps/agl-service-homescreen + src_prefix: doc/ + dst_prefix: hmi-framework/ + documents: + - source: ApplicationGuide.md + destination: 3_1-HomeScreen-Guide.md + label: Home Screen Developper Guide + - source: parts/software-stack.png + - source: parts/initialize-set-event-handler.svg + - source: parts/tap_shortcut.svg + - source: parts/showWindow.svg + - source: parts/on_screen_message.svg + - source: parts/showOnScreen.svg + - source: parts/showNotification.svg + - source: parts/showInformation.svg +- + git_name: apps/agl-service-windowmanager + src_prefix: doc/ + dst_prefix: hmi-framework/ + documents: + - source: ApplicationGuide.md + destination: 3_2-WindowManager-Guide.md + label: Window Manager Developper Guide + - source: parts/state_change_example.png + - source: parts/wm_software_stack.png + - source: parts/wm_layer_stack.png + - source: parts/wm_area.png + - source: parts/request_role.png + - source: parts/hmi_framework_designed_seq_toyota.png + - source: parts/deactivate_window.png + - source: parts/example_split.png +- + git_name: apps/agl-service-soundmanager + src_prefix: doc/ + dst_prefix: hmi-framework/ + documents: + - source: ApplicationGuide.md + destination: 3_3-SoundManager-Guide.md + label: Sound Manager Developper Guide + - source: Display_Audio_Transition1.md + destination: Display_Audio_Transition1.md + label: Sound Manager Developper Guide 2 + - source: Display_Audio_Transition2.md + destination: Display_Audio_Transition2.md + label: Sound Manager Developper Guide 3 + - source: parts/seq_startup.svg + - source: parts/am-component.png + - source: parts/seq_registration.svg + - source: parts/seq_connectsoundroute.svg + - source: parts/seq_startsoundstreaming.svg + - source: parts/seq_requestsoundmode.svg + - source: parts/seq_setmutestate.svg + - source: parts/seq_changevolume.svg + - source: parts/seq_stopsoundstreaming.svg + - source: parts/seq_disconnectsoundroute.svg + - source: parts/software-stack.png + - source: parts/seq_releasesoundmode.svg + - source: parts/typical-usecase.png + - source: parts/am-component.png +- + 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..023e699 --- /dev/null +++ b/content/tocs/apis_services/toc_dev_en.yml @@ -0,0 +1,181 @@ +####################################################################### +# 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: