/
mkdocs.yml
474 lines (456 loc) · 16.8 KB
/
mkdocs.yml
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
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
# Project information
site_url: https://docs.qfield.org/
site_author: OPENGIS.ch
site_name: QField Ecosystem Documentation
docs_dir: documentation # because of a bug in transifex-client the repo dir name cannot contain the doc dir name (e.g. qfield-docs and docs)
# Repository
repo_name: opengisch/qfield-docs
repo_url: https://github.com/opengisch/qfield-docs
# edit_uri: https://github.com/opengisch/qfield-docs/tree/master/documentation/
edit_uri_template: 'blob/master/documentation/{path}'
# Copyright
copyright: Copyright © 2023 <a href="https://OPENGIS.ch">OPENGIS.ch</a> - <a
href="https://creativecommons.org/licenses/by-sa/4.0/" target="_blank">CC-BY-SA
4.0</a>
# Configuration
theme:
name: material
custom_dir: theme_overrides/
features:
- navigation.tabs
# - navigation.instant # Not compatible with i18n plugin
- navigation.expand
- navigation.indexes
- navigation.top
- search.suggest
- search.highlight
- content.action.edit
logo: assets/images/qfield_logo_white.svg
favicon: assets/images/favicon.ico
palette:
- scheme: default
primary: light green
toggle:
icon: octicons/moon-24
name: Switch to dark mode
- scheme: slate
primary: blue
toggle:
icon: octicons/sun-24
name: Switch to light mode
# Page tree
nav:
- Home: index.md
- Get started:
- get-started/index.md
- get-started/concepts.md
- get-started/storage.md
- Tutorials:
- QFieldCloud:
- get-started/tutorials/get-started-qfc.md
- get-started/tutorials/advanced-setup-qfc.md
- QFieldSync:
- get-started/tutorials/get-started-qfs.md
- get-started/faq.md
- get-started/sample-projects.md
- get-started/support.md
- get-started/sponsor.md
- get-started/license.md
- get-started/contribute.md
- get-started/third-part-tutorials.md
- How-to guides:
- how-to/index.md
- how-to/projects.md
- how-to/map-interaction.md
- how-to/measuring-tool.md
- how-to/digitize.md
- how-to/attributes-form.md
- how-to/pictures.md
- how-to/search.md
- how-to/standalone-datasets.md
- how-to/map-styling.md
- how-to/map-themes.md
- how-to/gnss.md
- how-to/navigation.md
- how-to/tracking.md
- how-to/sensors.md
- how-to/bookmarks.md
- how-to/print-to-pdf.md
- how-to/authentication.md
- how-to/temporal-filtering.md
- how-to/variables.md
- how-to/hiding-legend-nodes.md
- how-to/live-default-value.md
- how-to/outside-layers.md
- how-to/movable-project.md
- how-to/pg-service.md
- Technical reference:
- reference/index.md
- reference/data-format.md
- QFieldCloud:
- reference/qfieldcloud/concepts.md
- reference/qfieldcloud/projects.md
- reference/qfieldcloud/permissions.md
- reference/qfieldcloud/jobs.md
- reference/qfieldcloud/secrets.md
- reference/qfieldcloud/specs.md
- reference/qfieldcloud/api.md
- reference/qfieldcloud/system.md
- reference/qfieldcloud/sdk.md
- Success stories:
- success-stories/index.md
- success-stories/ecological-surveying.md
- success-stories/geologic-mapping.md
- success-stories/lulc-mapping-fiji.md
- success-stories/mapping-breeding-birds-in-the-Wadden-Sea.md
- success-stories/mosquito-malario-ground-truth-data-collection.md
- success-stories/river-state-survey.md
- success-stories/rwanda-rural-water.md
- success-stories/vanilla-survey.md
- success-stories/heritage-impact-assessment.md
# Extensions
markdown_extensions:
- admonition
- footnotes
- pymdownx.details
- def_list
- attr_list
- pymdownx.inlinehilite
- pymdownx.highlight
- pymdownx.superfences
- pymdownx.keys
- pymdownx.tabbed:
alternate_style: true
- fancyboxmd
- pymdownx.emoji:
emoji_index: !!python/name:material.extensions.emoji.twemoji
emoji_generator: !!python/name:material.extensions.emoji.to_svg
- toc:
permalink: true
# Css
extra_css:
- stylesheets/extra.css
- stylesheets/jquery.fancybox.min.css
- stylesheets/swagger-ui.css
# Extra javascript
extra_javascript:
- javascript/jquery.min.js
- javascript/jquery.fancybox.min.js
- javascript/swagger-ui-bundle.js
- javascript/swagger-ui-standalone-preset.js
extra:
# Remove "Made with Material for MkDocs" from footer
generator: false
social:
- icon: fontawesome/brands/github
link: https://github.com/opengisch
- icon: fontawesome/brands/twitter
link: https://twitter.com/opengisch
- icon: fontawesome/brands/linkedin
link: https://www.linkedin.com/company/opengisch/
- icon: fontawesome/solid/paper-plane
link: mailto:info@opengis.ch
plugins:
- mkdocs-video
- search
- social:
# See https://squidfunk.github.io/mkdocs-material/setup/setting-up-social-cards/
cards_layout_options:
background_color: "#72ad2e"
color: "#FFFFFF"
- i18n:
default_language_only: !ENV [DEFAULT_LANGUAGE_ONLY, true]
# FIX ME: Add autodetection to translation rates so that only languages
# with >30% translations are built. See https://www.transifex.com/opengisch/qfield-documentation/dashboard/
languages:
- locale: en
default: true
name: English
site_name: QField Ecosystem Documentation
site_description: >-
Welcome to the QField ecosystem documentation - a suite of products designed
to make fieldwork seamless and efficient. Whether you're a new user or
an experienced pro, you'll find everything you need to know about using
QField and its related tools.
- locale: de
name: Deutsch
site_name: QField Ökosystem Dokumentation
site_description: >-
Willkommen in der Dokumentation des QField-Ökosystems, einer Suite von
Produkten, die Feldarbeit nahtlos und effizient gestalten. Egal, ob du
ein neuer Benutzer oder ein Profi bist, hier findest du alles, was du
über die Verwendung von QField und den damit verbundenen Tools wissen
musst.
nav_translations:
Home: Startseite
Get started: Erste Schritte
Tutorials: Tutorials
QFieldCloud: QFieldCloud
QFieldSync: QFieldSync
How-to guides: Anleitungen
Technical reference: Technische Hinweise
Success stories: Success stories
palette:
- scheme: default
primary: light green
toggle:
icon: octicons/moon-24
name: Switch to dark mode
- scheme: slate
primary: blue
toggle:
icon: octicons/sun-24
name: Switch to light mode
# Page tree
- locale: fr
name: Français
site_name: Documentation de l'écosystème QField
site_description: >-
Bienvenue dans l'écosystème QField - une suite logicielle pour rendre
le travail de terrain simple et rapide. Utilisateur débutant ou confirmé,
vous trouverez tout ce dont vous avez besoin pour utiliser QField et les
outils associés.
nav_translations:
Home: Accueil
Get started: Mise en route
Tutorials: Tutoriels
QFieldCloud: QFieldCloud
QFieldSync: QFieldSync
How-to guides: Tutoriels
Technical reference: Documentation technique
Success stories: Projets témoin
palette:
- scheme: default
primary: light green
toggle:
icon: octicons/moon-24
name: Switch to dark mode
- scheme: slate
primary: blue
toggle:
icon: octicons/sun-24
name: Switch to light mode
# Page tree
- locale: it
name: Italiano
site_name: Documentazione dell'ecosistema QField
site_description: >-
Benvenuti nella documentazione dell'ecosistema QField, una suite di prodotti
progettati per rendere il lavoro sul campo semplice ed efficiente. Che
tu sia un nuovo utente o un professionista esperto, troverai tutto ciò
che devi sapere sull'utilizzo di QField e dei suoi strumenti correlati.
nav_translations:
Home: Home
Get started: Inizia
Tutorials: Esercitazioni
QFieldCloud: QFieldCloud
QFieldSync: QFieldSync
How-to guides: Guide Passo-Passo
Technical reference: Documentazione tecnica di riferimento
Success stories: Storie di successo
palette:
- scheme: default
primary: light green
toggle:
icon: octicons/moon-24
name: Passare alla modalità scura
- scheme: slate
primary: blue
toggle:
icon: octicons/sun-24
name: Passare alla modalità chiara
# Page tree
- locale: ja
name: 日本語
site_name: QFieldエコシステムドキュメント
site_description: >-
QFieldエコシステムのドキュメントへようこそ。QFieldエコシステムは、フィールドワークをシームレスかつ効率的にするために設計された製品群です。このページでは、QField
のすべての製品について、包括的でわかりやすいドキュメントを提供しています。初めてお使いになる方でも、経験豊富なプロの方でも、QFieldとその関連ツールの使用に関して知っておくべきことが全て網羅されています。
nav_translations:
Home: Home
Get started: スタート・ガイド
Tutorials: Tutorials
QFieldCloud: QFieldCloud
QFieldSync: QFieldSync
How-to guides: ハウツー・ガイド
Technical reference: 技術参考情報
Success stories: Success stories
palette:
- scheme: default
primary: light green
toggle:
icon: octicons/moon-24
name: Switch to dark mode
- scheme: slate
primary: blue
toggle:
icon: octicons/sun-24
name: Switch to light mode
# Page tree
- locale: pt
name: Portuguese
site_name: Documentação do Ecossistema QField
site_description: >-
Bem-vindo à documentação do ecossistema QField - um conjunto de produtos
projetados para tornar o trabalho de campo contínuo e eficiente. Caso
seja um novo utilizador ou um profissional experiente, encontrará tudo
o que precisa de saber sobre o uso do QField e as suas respetivas ferramentas.
nav_translations:
Home: Home
Get started: Primeiros passos
Tutorials: Tutorials
QFieldCloud: QFieldCloud
QFieldSync: QFieldSync
How-to guides: Guias de instruções
Technical reference: Referência técnica
Success stories: Histórias de sucesso
palette:
- scheme: default
primary: light green
toggle:
icon: octicons/moon-24
name: Switch to dark mode
- scheme: slate
primary: blue
toggle:
icon: octicons/sun-24
name: Switch to light mode
# Page tree
- locale: es
name: Español
site_name: Documentación del ecosistema QField
site_description: >-
Bienvenido a la documentación del ecosistema QField: un conjunto de productos
diseñados para hacer que el trabajo de campo sea fluido y eficiente. Ya
sea un usuario nuevo o un profesional experimentado, encontrará todo lo
que necesita saber sobre el uso de QField y sus herramientas relacionadas.
nav_translations:
Home: Inicio
Get started: Empezar
Tutorials: Tutoriales
QFieldCloud: QFieldCloud
QFieldSync: QFieldSync
How-to guides: Guías de uso
Technical reference: Referencia técnica
Success stories: Historias de éxito
palette:
- scheme: default
primary: light green
toggle:
icon: octicons/moon-24
name: Cambiar a modo oscuro
- scheme: slate
primary: blue
toggle:
icon: octicons/sun-24
name: Cambiar a modo claro
# Page tree
- locale: zh
name: 简体中文
site_name: QField生态系统文档
site_description: >-
欢迎访问QField生态系统文档--一套旨在使野外工作无缝、高效的产品。在本网页中，我们为所有产品提供了全面且易于理解的文档。无论您是新用户还是经验丰富的专家，您都会找到使用QField及其相关工具所需的一切信息。
nav_translations:
Home: Home
Get started: 基础入门
Tutorials: Tutorials
QFieldCloud: QFieldCloud
QFieldSync: QFieldSync
How-to guides: 操作指南
Technical reference: 技术参考
Success stories: 成功案例
palette:
- scheme: default
primary: light green
toggle:
icon: octicons/moon-24
name: Switch to dark mode
- scheme: slate
primary: blue
toggle:
icon: octicons/sun-24
name: Switch to light mode
# Page tree
- locale: fi
name: Finnish
site_name: QField Ecosystem Documentation
site_description: >-
Welcome to the QField ecosystem documentation - a suite of products designed
to make fieldwork seamless and efficient. Whether you're a new user or
an experienced pro, you'll find everything you need to know about using
QField and its related tools.
# TRANSLATE ME
nav_translations:
Home: Home
Get started: Aloita
Tutorials: Tutorials
QFieldCloud: QFieldCloud
QFieldSync: QFieldSync
How-to guides: Kuinka teen oppaat
Technical reference: Tekniset viitteet
Success stories: Success stories
palette:
- scheme: default
primary: light green
toggle:
icon: octicons/moon-24
name: Switch to dark mode
- scheme: slate
primary: blue
toggle:
icon: octicons/sun-24
name: Switch to light mode
# Page tree
- locale: ro
name: Romanian
site_name: Documentarea ecosistemului QField
site_description: >-
Bun venit la documentația ecosistemului QField! QField este o suită de
produse concepute pentru a face munca de teren mai ușoară și mai eficientă.
Indiferent dacă ești un utilizator nou sau un profesionist experimentat,
vei găsi tot ce trebuie să știi despre utilizarea QField și a instrumentelor
sale conexe.
# ar: Arabic
# bg: Bulgarian
# ca: Catalan
# hr: Croatian
# cs: Czech
# nl: Dutch
# et: Estonian
# gl: Galician
# he: Hebrew
# hu: Hungarian
# id: Indonesian
# rw: Kinyarwanda
# lt: Lithuanian
# fa: Persian
# pl: Polish
# pt_BR: Portuguese (Brazil)
# rm: Romansh
# ru: Russian
# ru_UA: Russian (Ukraine)
# sl: Slovenian
# tr: Turkish
# uk: Ukranian
# vi: Vietnamese
nav_translations:
Home: Home
Get started: Get started
Tutorials: Tutorials
QFieldCloud: QFieldCloud
QFieldSync: QFieldSync
How-to guides: How-to guides
Technical reference: Referință tehnică
Success stories: Success stories
palette:
- scheme: default
primary: light green
toggle:
icon: octicons/moon-24
name: Switch to dark mode
- scheme: slate
primary: blue
toggle:
icon: octicons/sun-24
name: Switch to light mode
# Page tree