aboutsummaryrefslogtreecommitdiffstats
path: root/content/tocs/apis_services/fetched_files.yml
blob: da0758bd69a16e9ece4cf3ea8d2b17a7342e0f43 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
##############################################################################################################
# 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

-
    git_name : apps/low-level-can-service
    git_commit: master
    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

-
    url_fetch: GITHUB_FETCH
    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
-
    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: 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: 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_name: apps/agl-service-homescreen-2017
    git_commit: "master"
    src_prefix: doc/
    dst_prefix: hmi-framework/
    documents:
        - source: ApplicationGuide.md
          destination: 3_1-HomeScreen-Guide.md
          label: Home Screen Developper Guide
        - source: parts/initialize.svg
        - source: parts/initialize-registercallback.svg
        - source: parts/initialize-set-event-handler.svg
        - source: parts/on_screen_message.svg
        - source: parts/software-stack.png
        - source: parts/tap_shortcut.svg
-
    url_fetch: "GERRIT_FETCH"
    git_name: apps/agl-service-windowmanager-2017
    git_commit: "master"
    src_prefix: doc/
    dst_prefix: hmi-framework/
    documents:
        - source: ApplicationGuide.md
          destination: 3_2-WindowManager-Guide.md
          label: Window Manager Developper Guide
-
    url_fetch: "GERRIT_FETCH"
    git_name: apps/agl-service-soundmanager-2017
    git_commit: "master"
    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
-
    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