Add documentation covering drawing templates

opengisch · Dec 16, 2024 · 733269c · 733269c
1 parent ad17064
commit 733269c
Show file tree

Hide file tree

Showing 4 changed files with 28 additions and 0 deletions.
diff --git a/documentation/assets/images/drawing_templates.png b/documentation/assets/images/drawing_templates.png
diff --git a/documentation/how-to/pictures.en.md b/documentation/how-to/pictures.en.md
@@ -72,6 +72,17 @@ QField have an in-app drawing and sketching functionality enabling you to direct
 
 ![type:video](../assets/videos/drawing-sketch-feature2.webm)
 
+### Drawing templates
+
+On top of annotating captured images, QField supports drawing from image templates. The following two methods are available to add templates:
+
+- The first method is to create a `drawing_templates` folder located alongside a project file and populate it with images. Whenever that project is loaded, QField will register all images within that folder as drawing templates.
+- Alternatively, you can add images into the `drawing_templates` folder found inside your QField app folder. If you are not familiar with that app folder, its location is shown at the bottom of the About QField overlay.
+
+Templates shipped alongside projects as well as the QField app folder will be shown when users choose 'Draw a sketch' within attachments widget's 3-dot menu.
+
+!![picture path](../assets/images/drawing_templates.png "")
+
 ## Geotagging
 :material-tablet: Fieldwork
 

diff --git a/mkdocs.yml b/mkdocs.yml
@@ -119,6 +119,9 @@ nav:
       - success-stories/rwanda-rural-water.md
       - success-stories/vanilla-survey.md
       - success-stories/heritage-impact-assessment.md
+  - QField API:
+      - qfield-api/index.md
+
 # Extensions
 markdown_extensions:
   - admonition
@@ -172,8 +175,20 @@ plugins:
       cards_layout_options:
         background_color: "#72ad2e"
         color: "#FFFFFF"
+  - mkdoxy:
+      projects:
+        qfield-api:
+          src-dirs: "../../cpp/QField/src/core ../../cpp/QField/src/core/utils ../../cpp/QField/src/core/positioning ../../cpp/QField/src/qml"
+          full-doc: True
+          doxy-cfg:
+            FILE_PATTERNS: "*.cpp *.h* *.qml"
+            FILTER_PATTERNS: "*.qml=doxyqml"
+            RECURSIVE: False
+            EXTENSION_MAPPING: "qml=C++"
   - i18n:
       build_only_locale: !ENV [BUILD_ONLY_LOCALE]
+      default_language: en
+      fallback_to_default: 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:

diff --git a/requirements.txt b/requirements.txt
@@ -4,3 +4,5 @@ fancyboxmd==1.1.0
 mkdocs-material===9.5.17
 mkdocs-static-i18n==1.2.0
 mkdocs-video==1.5.0
+doxyqml
+mkdoxy