fix: fix paths to scripts and misc files

do some restructuring of directories

Author: Valentin Deyringer

.github/workflows/generate-author-guide.yml

@@ -14,30 +14,30 @@ jobs:
         with:
           python-version: '3.10'
       - name: merge usage documentation files into one
-        run: python docs/md_merge.py --input docs/user --lang en --output docs --name author_guide.md
+        run: python scripts/md_merge.py --input user --lang en --output . --name author_guide.md
       - name: convert markdown to docx
         uses: docker://pandoc/latex:2.19
         with:
           args: >-
-            docs/author_guide.md
+            author_guide.md
             -f markdown
             -t docx
-            -o docs/author_guide.docx
-            --lua-filter=docs/filters.lua
-            --defaults=docs/defaults.yaml
+            -o author_guide.docx
+            --lua-filter=etc/filters.lua
+            --defaults=etc/defaults.yaml
       - name: convert docx to PDF/UA
         uses: jmservera/[email protected]
         with:
           command:
             libreoffice --headless --terminate_after_init
-            && cp docs/customModule.xba ${HOME}/.config/libreoffice/4/user/basic/Standard/
+            && cp etc/customModule.xba ${HOME}/.config/libreoffice/4/user/basic/Standard/
             && sed -i '4i\ <library:element library:name="customModule"/>' ${HOME}/.config/libreoffice/4/user/basic/Standard/script.xlb
             && sed -i '3i<item oor:path="/org.openoffice.Office.Common/Save/Document"><prop oor:name="WarnAlienFormat" oor:op="fuse"><value>false</value></prop></item>' ${HOME}/.config/libreoffice/4/user/registrymodifications.xcu
-            && libreoffice --headless --invisible "macro:///Standard.customModule.UpdateIndexes(${GITHUB_WORKSPACE}/docs/author_guide.docx)"
+            && libreoffice --headless --invisible "macro:///Standard.customModule.UpdateIndexes(${GITHUB_WORKSPACE}/author_guide.docx)"
             && sed -i '3i<item oor:path="/org.openoffice.Office.Common/Filter/PDF/Export"><prop oor:name="PDFUACompliance" oor:op="fuse"><value>true</value></prop></item>' ${HOME}/.config/libreoffice/4/user/registrymodifications.xcu
-            && libreoffice --headless --convert-to pdf:writer_pdf_Export --outdir docs docs/author_guide.docx
+            && libreoffice --headless --convert-to pdf:writer_pdf_Export --outdir . author_guide.docx
       - name: upload the author guide
         uses: actions/upload-artifact@v3
         with:
-          name: author-guide.pdf
-          path: docs/author_guide.pdf
+          name: author_guide.pdf
+          path: author_guide.pdf

.github/workflows/github-pages.yml

@@ -17,17 +17,17 @@ jobs:
         with:
           python-version: '3.10'
       - name: merge usage documentation files into one
-        run: python docs/md_merge.py --input docs/user --lang en --output docs --name author_guide.md
+        run: python scripts/md_merge.py --input user --lang en --output . --name author_guide.md
       - name: convert markdown to html
         uses: docker://pandoc/latex:2.19
         with:
           args: >-
-            docs/author_guide.md
+            author_guide.md
             -f markdown
             -t html
             -o public/index.html
-            --lua-filter=docs/filters.lua
-            --defaults=docs/defaults.yaml
+            --lua-filter=etc/filters.lua
+            --defaults=etc/defaults.yaml
       - name: deploy to GitHub pages
         uses: JamesIves/github-pages-deploy-action@v4
         with:

README.md

@@ -9,30 +9,34 @@ Additionally, an author guide is generated as PDF document.
 The author guide is a concatenation of the usage documentation files compiled into an accessible PDF document.
 To generate this document the following steps are necessary:
 
-* Merge the usage documentation files (`*-usage.en.md`) using the script `md_merge.py`.
+* Merge the usage documentation files (`*-usage.en.md`) using the
+  [md_merge.py](https://github.com/secvisogram/secvisogram-documentation/blob/main/scripts/md_merge.py) script.
 
-  `python docs/md_merge.py --input docs/user --lang en --output docs --name author_guide.md`
+  `python scripts/md_merge.py --input user --lang en --output . --name author_guide.md`
 
   This script allows for selecting a specific language, see the `--lang` flag.
   See [below](#translating-the-documentation) for details on how to translate the documentation.
 
 * Convert the resulting markdown file into docx format.
 
-  `pandoc docs/author_guide.md -f markdown -t docx -o docs/author_guide.docx -V block-headings --table-of-contents --lua-filter=docs/filters.lua --defaults=docs/defaults.yaml`
+  `pandoc author_guide.md -f markdown -t docx -o author_guide.docx --lua-filter=etc/filters.lua --defaults=etc/defaults.yaml`
 
 * Populate the documents' table of contents with a custom macro.
 
   `libreoffice --headless --invisible "macro:///Standard.customModule.UpdateIndexes(/absolute/path/to/author_guide.docx)"`
 
-  This requires the [custom macro](https://github.com/secvisogram/secvisogram-documentation/blob/main/customModule.xba) to be available in libreoffice.
+  This requires the absolute path to the generated docx file and the
+  [custom macro](https://github.com/secvisogram/secvisogram-documentation/blob/main/etc/customModule.xba) to be
+  available in libreoffice.
 
 * Convert the docx file into an accessible PDF with libreoffice.
 
-  `libreoffice --headless --convert-to pdf:writer_pdf_Export --outdir docs docs/author_guide.docx`
+  `libreoffice --headless --convert-to pdf:writer_pdf_Export --outdir . author_guide.docx`
 
   To generate an accessible PDF this requires Universal Access Compliance to be enabled in libreoffice.
 
-The title and author of the resulting document can be changed in `defaults.yaml`.
+The title and author of the resulting document can be changed in
+[etc/defaults.yaml](https://github.com/secvisogram/secvisogram-documentation/blob/main/etc/defaults.yaml).
 
 A GitHub action is used to automate these steps and publish the English author guide as an artifact.
 See the [generate-author-guide.yml](https://github.com/secvisogram/secvisogram-documentation/blob/main/.github/workflows/generate-author-guide.yml) workflow.