Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 0 additions & 24 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,30 +53,6 @@ The `test` folder contains

In order to carry out the front-end testing the staging server was deployed at (`tests/helpers.js@8`). Whenever code changes are pushed to the Github, the `push` hook calls the `POST http://vidi.alexshumilov.ru:8082/deploy` URL and the application is built (`git pull && grunt`). So, when puppeteer tests are launched, the staging server is already updated.

## Ignoring certain URLs in Service Worker

The Vidi service worker now accepts the URL regexp that will allow certain URLs to be ignored. Please consider the demo script that first tells service worker to ignore all URLs that have `jsonplaceholder.typicode` in it and then it actually requests the https://jsonplaceholder.typicode.com/todos/1 URL - the request is performed without service worker.

```javascript
/**
* Talking to the service worker in test purposes
*/
setTimeout(() => {
if (navigator.serviceWorker.controller) {
navigator.serviceWorker.controller.postMessage({
action: `addUrlIgnoredForCaching`,
payload: `jsonplaceholder.typicode`
});

setTimeout(() => {
fetch('https://jsonplaceholder.typicode.com/todos/1').then(() => {}).then(() => {});
}, 3000);
} else {
throw new Error(`Unable to invoke the service worker controller`);
}
}, 3000);
```

## Documentation

The documentation in the `docs` folder is built using [https://www.sphinx-doc.org/en/master/](sphinx)). The documentation is regularly built and accessible on https://vidi.readthedocs.io/
Expand Down
7 changes: 0 additions & 7 deletions docs/_subs/CHANGELOG.rst

This file was deleted.

7 changes: 0 additions & 7 deletions docs/_subs/CONTRIBUTING.rst

This file was deleted.

10 changes: 0 additions & 10 deletions docs/_subs/GIT.rst

This file was deleted.

7 changes: 0 additions & 7 deletions docs/_subs/README.rst

This file was deleted.

7 changes: 0 additions & 7 deletions docs/_subs/WARNING_OLD_DOC.rst

This file was deleted.

4 changes: 2 additions & 2 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@

# General information about the project.
project = u'Vidi'
copyright = u'2023, MapCentia'
copyright = u'2025, MapCentia'

# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
Expand Down Expand Up @@ -141,7 +141,7 @@

# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
# using the given strftime format.
#html_last_updated_fmt = '%b %d, %Y'
html_last_updated_fmt = '%b %d, %Y'

# If true, SmartyPants will be used to convert quotes and dashes to
# typographically correct entities.
Expand Down
48 changes: 48 additions & 0 deletions docs/fix_headers.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
#!/usr/bin/env python3
import os
import re
import argparse

def fix_underlines(directory, length=75):
"""
Fix all RST files in directory to have consistent underlining of specified length
"""
count = 0
for root, dirs, files in os.walk(directory):
for file in files:
if file.endswith('.rst'):
filepath = os.path.join(root, file)
with open(filepath, 'r', encoding='utf-8') as f:
content = f.read()

# Store original content to check if changes were made
original_content = content

# Fix level 1 headings (====)
content = re.sub(r'(.*)\n=+\n', r'\1\n' + '=' * length + '\n', content)

# Fix level 2 headings (----)
content = re.sub(r'(.*)\n-+\n', r'\1\n' + '-' * length + '\n', content)

# Only write if changes were made
if content != original_content:
with open(filepath, 'w', encoding='utf-8') as f:
f.write(content)
print(f"Fixed: {filepath}")
count += 1

print(f"Completed: {count} files modified")

if __name__ == "__main__":
parser = argparse.ArgumentParser(description='Fix RST header underlining to consistent length')
parser.add_argument('directory', help='Directory containing RST files to process')
parser.add_argument('--length', '-l', type=int, default=50,
help='Length of underlining (default: 50)')

args = parser.parse_args()

if not os.path.isdir(args.directory):
print(f"Error: {args.directory} is not a valid directory")
exit(1)

fix_underlines(args.directory, args.length)
66 changes: 50 additions & 16 deletions docs/index.rst
Original file line number Diff line number Diff line change
@@ -1,40 +1,74 @@
#################################################################

Vidi brugerdokumentation
#################################################################
========================

Denne dokumentation er til brug for brugere af web-applikationen Vidi. Dokumentationen er opdelt i sektioner, så du kan finde det du leder efter.

Det kan anbefales at benytte søgefunktionen i venstre side af skærmen, hvis du leder efter noget specifikt.

Denne dokumentation er under konstant udvikling, og der vil løbende komme nye sektioner til. Hvis du har forslag til emner der mangler, er du velkommen til at kontakte os.



Grundliggende
-----------------

Hvis du har brug for at komme i gang med Vidi fra bunden af, er her et godt sted at starte.

.. toctree::
:maxdepth: 1
:maxdepth: 2
:glob:

pages/gettingstarted/*
pages/gettingstarted/index


*****************************************************************
Standardværktøjer
*****************************************************************
-----------------

Vidi indeholder en del værktøjer som altid er slået til. Disse værktøjer er lavet til at at gøre arbejdet nemmere. Du kan læse mere om de enkelse værktøjer herunder.

.. toctree::
:maxdepth: 1
:maxdepth: 2
:glob:

pages/standard/*
pages/standard/index

*****************************************************************
Extensions
*****************************************************************
-----------------

Ud over standardværktøjerne, er der udviddet funktionalitet som du kan læse mere om herunder.
Ud over standardværktøjerne, er det flere udvidelser som løser specifikke opgaver.

.. toctree::
:maxdepth: 1
:glob:
:maxdepth: 2

pages/extensions/*
pages/extensions/index

Ikke-standard extensions
------------------------

.. Include generic links to repo
Ud over standardværktøjerne, er der lavet ekstra funktionalitet som du kan læse mere om herunder.

.. toctree::
:maxdepth: 2

pages/custom_extensions/index

Udviklerdokumentation
---------------------

Vidi kan konfigureres og udvides. Herunder kan du finde dokumentation om hvordan du kan tilpasse Vidi til dine behov.

.. toctree::
:maxdepth: 2

pages/developer/index

Vidiprojektet
-----------------

Her kan du finde mere information om selve Vidi-projektet, og hvordan du kan bidrage til det.

.. toctree::
:maxdepth: 2

.. include:: ./_subs/GIT.rst
pages/vidi/index
12 changes: 6 additions & 6 deletions docs/locales/en/LC_MESSAGES/pages.po
Original file line number Diff line number Diff line change
Expand Up @@ -2074,7 +2074,7 @@ msgstr ""
#: ../../pages/standard/92_gc2_meta_information.rst:481
msgid ""
"Laget kan låses. Det låses op, hvis laget er registreret som \"barn\" til"
" et andet lag gennem :ref:`gc2mata_references`, hvorpå der aktiveres et "
" et andet lag gennem :ref:`gc2meta_references`, hvorpå der aktiveres et "
"filter."
msgstr ""

Expand Down Expand Up @@ -2103,7 +2103,7 @@ msgstr ""
#: ../../pages/standard/92_gc2_meta_information.rst:505
msgid ""
"Medtag feltet i feature-info. Gælder kun ved brugen af standard pop-up "
"templaten. (se :ref:`gc2mata_infopopup`)"
"templaten. (se :ref:`gc2meta_infopopup`)"
msgstr ""

#: ../../pages/standard/92_gc2_meta_information.rst:510
Expand All @@ -2114,7 +2114,7 @@ msgstr ""
msgid ""
"Medtag feltet i mouse-over. Gælder kun ved brugen af standard mouse-over-"
"templaten. Men skal klikkes af, hvis feltet overhovedet skal med i UTF "
"Grid'et. (se :ref:`gc2mata_mouseover`)"
"Grid'et. (se :ref:`gc2meta_mouseover`)"
msgstr ""

#: ../../pages/standard/92_gc2_meta_information.rst:516
Expand Down Expand Up @@ -2158,7 +2158,7 @@ msgstr ""
#: ../../pages/standard/92_gc2_meta_information.rst:591
msgid ""
"Hvis der anvendes en brugerdefineret pop-up template, har denne "
"indstilling ingen effekt (se :ref:`gc2mata_infopopup`)"
"indstilling ingen effekt (se :ref:`gc2meta_infopopup`)"
msgstr ""

#: ../../pages/standard/92_gc2_meta_information.rst:556
Expand All @@ -2169,7 +2169,7 @@ msgstr ""
msgid ""
"Hvis feltet indeholder et link til et billede eller mp4-video kan der her"
" vælges typen. Ved brug af standard templaten bliver billedet eller "
"videoen sat ind (se :ref:`gc2mata_infopopup`)"
"videoen sat ind (se :ref:`gc2meta_infopopup`)"
msgstr ""

#: ../../pages/standard/92_gc2_meta_information.rst:566
Expand Down Expand Up @@ -2622,7 +2622,7 @@ msgstr ""
msgid ""
"APIet kan bruges i de forskellige templates og funktioner, der kan "
"defineres forskellige steder i en Vidi opsætning. Fx i "
":ref:`gc2mata_infopopup` templates og funktioner."
":ref:`gc2meta_infopopup` templates og funktioner."
msgstr ""

#: ../../pages/standard/96_api.rst:23
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -717,7 +717,7 @@ msgstr ""
#: 36157096796041d68cde2e25169b7be6
msgid ""
"Laget kan låses. Det låses op, hvis laget er registreret som \"barn\" til"
" et andet lag gennem :ref:`gc2mata_references`, hvorpå der aktiveres et "
" et andet lag gennem :ref:`gc2meta_references`, hvorpå der aktiveres et "
"filter."
msgstr ""

Expand Down Expand Up @@ -752,7 +752,7 @@ msgstr ""
#: ed3d3c6df22a4dab8dbefaa43a27ecfc
msgid ""
"Medtag feltet i feature-info. Gælder kun ved brugen af standard pop-up "
"templaten. (se :ref:`gc2mata_infopopup`)"
"templaten. (se :ref:`gc2meta_infopopup`)"
msgstr ""

#: ../../pages/standard/92_gc2_meta_information.rst:510
Expand All @@ -765,7 +765,7 @@ msgstr ""
msgid ""
"Medtag feltet i mouse-over. Gælder kun ved brugen af standard mouse-over-"
"templaten. Men skal klikkes af, hvis feltet overhovedet skal med i UTF "
"Grid'et. (se :ref:`gc2mata_mouseover`)"
"Grid'et. (se :ref:`gc2meta_mouseover`)"
msgstr ""

#: ../../pages/standard/92_gc2_meta_information.rst:516
Expand Down Expand Up @@ -820,7 +820,7 @@ msgstr ""
#: e9d58c74fc1b4c998a79537b536c2ed7
msgid ""
"Hvis der anvendes en brugerdefineret pop-up template, har denne "
"indstilling ingen effekt (se :ref:`gc2mata_infopopup`)"
"indstilling ingen effekt (se :ref:`gc2meta_infopopup`)"
msgstr ""

#: ../../pages/standard/92_gc2_meta_information.rst:556
Expand All @@ -833,7 +833,7 @@ msgstr ""
msgid ""
"Hvis feltet indeholder et link til et billede eller mp4-video kan der her"
" vælges typen. Ved brug af standard templaten bliver billedet eller "
"videoen sat ind (se :ref:`gc2mata_infopopup`)"
"videoen sat ind (se :ref:`gc2meta_infopopup`)"
msgstr ""

#: ../../pages/standard/92_gc2_meta_information.rst:566
Expand Down
2 changes: 1 addition & 1 deletion docs/locales/en/LC_MESSAGES/pages/standard/96_api.po
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ msgstr ""
msgid ""
"APIet kan bruges i de forskellige templates og funktioner, der kan "
"defineres forskellige steder i en Vidi opsætning. Fx i "
":ref:`gc2mata_infopopup` templates og funktioner."
":ref:`gc2meta_infopopup` templates og funktioner."
msgstr ""

#: ../../pages/standard/96_api.rst:23 637991e9d02e4c778d0916f572f24e7c
Expand Down
11 changes: 11 additions & 0 deletions docs/pages/custom_extensions/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
.. _non_standard_extensions:

Ikke-standard extensions
===========================================================================

Herunder findes dokumentation på nogle af de extensions, som ikke følger med Vidi som standard. Skal en af disse anvendes kræves det, at den bliver installeret.

.. toctree::
:maxdepth: 2

otp
Loading