diff --git a/README.md b/README.md index 52c386289..c0d279d75 100644 --- a/README.md +++ b/README.md @@ -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/ diff --git a/docs/_subs/CHANGELOG.rst b/docs/_subs/CHANGELOG.rst deleted file mode 100644 index 534ed99c6..000000000 --- a/docs/_subs/CHANGELOG.rst +++ /dev/null @@ -1,7 +0,0 @@ -.. _CHANGELOG: - - -Changelog -================================================================= - -.. mdinclude:: ../../CHANGELOG.md \ No newline at end of file diff --git a/docs/_subs/CONTRIBUTING.rst b/docs/_subs/CONTRIBUTING.rst deleted file mode 100644 index 4a637d93c..000000000 --- a/docs/_subs/CONTRIBUTING.rst +++ /dev/null @@ -1,7 +0,0 @@ -.. _CONTRIBUTING: - - -Contributing -================================================================= - -.. mdinclude:: ../../CONTRIBUTING.md \ No newline at end of file diff --git a/docs/_subs/GIT.rst b/docs/_subs/GIT.rst deleted file mode 100644 index c1b8e3545..000000000 --- a/docs/_subs/GIT.rst +++ /dev/null @@ -1,10 +0,0 @@ -.. _GIT: - -Mere om Vidi-projektet -""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" - -Her er links til mere generel information - -* :ref:`README` -* :ref:`CHANGELOG` -* :ref:`CONTRIBUTING` \ No newline at end of file diff --git a/docs/_subs/README.rst b/docs/_subs/README.rst deleted file mode 100644 index 0cc7f3fe4..000000000 --- a/docs/_subs/README.rst +++ /dev/null @@ -1,7 +0,0 @@ -.. _README: - - -Readme -================================================================= - -.. mdinclude:: ../../README.md \ No newline at end of file diff --git a/docs/_subs/WARNING_OLD_DOC.rst b/docs/_subs/WARNING_OLD_DOC.rst deleted file mode 100644 index 9b6fe97a7..000000000 --- a/docs/_subs/WARNING_OLD_DOC.rst +++ /dev/null @@ -1,7 +0,0 @@ -.. _OLDWARNING: - -.. warning:: Indhold fra denne side er overført direkte fra ældre wiki, og kan derfor være uddateret. Billeder er linket udenfor dette bibliotek. - - Du er velkommen til at hjælpe med at holde dokumentationen opdateret. Læs mere her - - :ref:`CONTRIBUTING` \ No newline at end of file diff --git a/docs/conf.py b/docs/conf.py index 003db7cb3..69a82b709 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -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 @@ -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. diff --git a/docs/fix_headers.py b/docs/fix_headers.py new file mode 100644 index 000000000..67b17376b --- /dev/null +++ b/docs/fix_headers.py @@ -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) \ No newline at end of file diff --git a/docs/index.rst b/docs/index.rst index ef8d44176..0d7b384e0 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -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 diff --git a/docs/locales/en/LC_MESSAGES/pages.po b/docs/locales/en/LC_MESSAGES/pages.po index b1b150984..e52888a91 100644 --- a/docs/locales/en/LC_MESSAGES/pages.po +++ b/docs/locales/en/LC_MESSAGES/pages.po @@ -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 "" @@ -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 @@ -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 @@ -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 @@ -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 @@ -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 diff --git a/docs/locales/en/LC_MESSAGES/pages/standard/92_gc2_meta_information.po b/docs/locales/en/LC_MESSAGES/pages/standard/92_gc2_meta_information.po index 01bb33a96..db1b11963 100644 --- a/docs/locales/en/LC_MESSAGES/pages/standard/92_gc2_meta_information.po +++ b/docs/locales/en/LC_MESSAGES/pages/standard/92_gc2_meta_information.po @@ -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 "" @@ -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 @@ -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 @@ -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 @@ -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 diff --git a/docs/locales/en/LC_MESSAGES/pages/standard/96_api.po b/docs/locales/en/LC_MESSAGES/pages/standard/96_api.po index ab410757b..b7c432d89 100644 --- a/docs/locales/en/LC_MESSAGES/pages/standard/96_api.po +++ b/docs/locales/en/LC_MESSAGES/pages/standard/96_api.po @@ -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 diff --git a/docs/pages/custom_extensions/index.rst b/docs/pages/custom_extensions/index.rst new file mode 100644 index 000000000..b6b3074ad --- /dev/null +++ b/docs/pages/custom_extensions/index.rst @@ -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 \ No newline at end of file diff --git a/docs/pages/custom_extensions/otp.rst b/docs/pages/custom_extensions/otp.rst new file mode 100644 index 000000000..6819f0714 --- /dev/null +++ b/docs/pages/custom_extensions/otp.rst @@ -0,0 +1,110 @@ + +.. _extensions_otp: + +Rutevejledning (otp) +=========================================================================== + +.. topic:: Overview + + :Forfattere: `mapcentia `_ + +.. contents:: + :depth: 3 + +Installation +--------------------------------------------------------------------------- + +Denne extension kræver yderligere installation som ikke er beskrevet her. + +Funktionen skal medtages i :ref:`configjs_extensions` + +.. code-block:: js + + extensions: { + browser: [ + {"otp": ["index"]}, + ], + }, + +Konfiguration +--------------------------------------------------------------------------- + +Der er ikke nogen konfiguration for denne extension. Den vil automatisk blive tilføjet til værktøjslinjen. + +Følgende parametre kan anvendes i :ref:`configjs_extensionconfig`: + +.. list-table:: + :widths: 30 20 50 + :header-rows: 1 + + * - Parameter + - Default value + - Description + * - ``routes`` + - ``["default"]`` + - En liste med de grafer, som brugeren skal kunne vælge imellem i Vidi. + * - ``defaults`` + - + - Angiver start-værdier for de forskellige indstillinger i Vidi. + * - ``defaults.startTime`` + - ``30`` + - Angiver start-tidspunktet i minutter fra nu. + * - ``defaults.endTime`` + - ``50`` + - Angiver slut-tidspunktet i minutter fra nu. + * - ``defaults.intervals`` + - ``[600, 1200, 1800]`` + - Tidsintervaller i sekunder. + * - ``defaults.startColor`` + - ``"#ff0000"`` + - Farve for startpunkt. + * - ``defaults.endColor`` + - ``"#00ff00"`` + - Farve for slutpunkt. + * - ``defaults.opacity`` + - ``0.7`` + - Gennemsigtighed for ruter. + * - ``defaults.arriveBy`` + - ``false`` + - Hvis sat til ``true``, beregnes rejsen baglæns fra ankomsttidspunktet. + * - ``defaults.route`` + - ``"default"`` + - Standard-grafen, som skal anvendes. + * - ``defaults.maxWalkDistance`` + - ``500`` + - Maksimal gåafstand i meter. + * - ``parameters`` + - ``{}`` + - Ekstra URL parametre, som skal sendes med til OTP serveren. + * - ``helpText`` + - ``""`` + - Tekst, som skal vises i modulets hjælpefunktion. + +Eksempel på konfiguration: + +.. code-block:: json + + "otp": { + "routes": ["default", "nt", "midttrafik", "sydtrafik"], + "defaults": { + "startTime": 30, + "endTime": 50, + "intervals": [600, 1200, 1800], + "startColor": "#ff0000", + "endColor": "#00ff00", + "opacity": 0.7, + "arriveBy": false, + "route": "default", + "maxWalkDistance": 500 + }, + "parameters": { + "offRoadDistanceMeters": "75", + "precisionMeters": "100" + }, + "helpText": "Hjælp til OTP" + } + +Brug +--------------------------------------------------------------------------- + +Brugen beskrives her. \ No newline at end of file diff --git a/docs/pages/standard/96_api.rst b/docs/pages/developer/api.rst similarity index 82% rename from docs/pages/standard/96_api.rst rename to docs/pages/developer/api.rst index 0acde3718..962811ac2 100644 --- a/docs/pages/standard/96_api.rst +++ b/docs/pages/developer/api.rst @@ -1,29 +1,22 @@ -.. _api: +.. _developer_api: -################################################################# Vidi API -################################################################# +=========================================================================== .. topic:: Overview - :Date: |today| - :Vidi-version: MASTER :Forfattere: `mapcentia `_ .. contents:: :depth: 4 -***************************************************************** -Brug -***************************************************************** - -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. +APIet kan bruges i de forskellige templates og funktioner, der kan defineres forskellige steder i en Vidi opsætning. Fx i :ref:`gc2meta_infopopup` templates og funktioner. .. note:: APIet kan ikke bruges til indlejrede Vidi kort - dvs. på den webside som Vidi er indlejret på. Her henvises til :ref:`embed_api` Tænd lag (turnOn) -================================================================= +--------------------------------------------------------------------------- Med denne metode kan man tænde for et lag. Den tager et argument som er et fuldt lagnavn med evt. type præfiks: @@ -32,7 +25,7 @@ Med denne metode kan man tænde for et lag. Den tager et argument som er et fuld api.turnOn("schema.lag"); Sluk lag (turnOff) -================================================================= +--------------------------------------------------------------------------- Med denne metode kan man tænde for et lag. Den tager et argument som er et fuldt lagnavn med evt. type præfiks: @@ -41,7 +34,7 @@ Med denne metode kan man tænde for et lag. Den tager et argument som er et fuld api.turnOff("schema.lag"); Sæt filter på lag (filter) -================================================================= +--------------------------------------------------------------------------- Med denne metode kan der sættes et filter på et givnet lag. Første argument er et fuldt lagnavn (uden type præfiks) og andet argument er filter objektet: diff --git a/docs/pages/standard/90_build_configuration.rst b/docs/pages/developer/build_configuration.rst similarity index 75% rename from docs/pages/standard/90_build_configuration.rst rename to docs/pages/developer/build_configuration.rst index 319cc3cbc..4f2c4e9d5 100644 --- a/docs/pages/standard/90_build_configuration.rst +++ b/docs/pages/developer/build_configuration.rst @@ -1,34 +1,39 @@ .. _configjs: -################################################################# Systemkonfiguration -################################################################# +=========================================================================== .. topic:: Overview - :Date: |today| - :Vidi-version: 2022.9.0 :Forfattere: `giovanniborella `_ | `mapcentia `_ .. contents:: :depth: 4 -Vidi kan konfigureres under opstart. Denne konfiguration kan indeholde information om hvilke extensions, der skal indlæses, hvilke print-skabeloner der er tilgængelige med mere. +Vidi skal konfigureres inden opstart. Denne konfiguration kan indeholde information om hvilke extensions, der skal indlæses, hvilke print-skabeloner der er tilgængelige med mere. Laves der en ændring, skal vidi startes igen. Vidi styres af ``config.js``. Denne fil vil være at finde i ``./vidi/config/``. +Herunder er alle de nøgler der kan anvendes i ``config.js`` beskrevet. Bemærk at der kan være nøgler der ikke er beskrevet her, da de ikke er blevet tilføjet endnu. + .. _configjs_puppeteerprocesses: puppeteerProcesses -***************************************************************** +--------------------------------------------------------------------------- + +``puppeteerProcesses`` er en blok der indeholder opsætning af puppeteer-processer. + +``puppeteerProcesses`` indeholder to nøgler: ``min`` og ``max``. + +``min`` angiver hvor mange puppeteer-processer der skal være tilgængelige ved opstart. ``max`` angiver det maksimale antal processer der kan være tilgængelige. Denne blok styrer hvor mange arbejdere der kan være forbindet til print-køen. Hvis man sætter ``"min": 0`` vil der ikke køre processer i baggrunden, og der skal startes en puppeteer op fra bunden. Denn "cold-start" kan tage flere sekunder. -Antallet af varme puppeteer-instaser vil have en effekt på systemets RAM forbrug. +Antallet af varme puppeteer-instanser vil have en effekt på systemets RAM forbrug. .. code-block:: json @@ -40,7 +45,7 @@ Antallet af varme puppeteer-instaser vil have en effekt på systemets RAM forbru .. _configjs_print: print -***************************************************************** +--------------------------------------------------------------------------- Denne nøgle indeholder opsætningen af print. Den består af underdele som alle er obligatoriske. @@ -48,7 +53,7 @@ Denne nøgle indeholder opsætningen af print. Den består af underdele som alle .. _configjs_scales: scales -***************************************************************** +--------------------------------------------------------------------------- ``scales`` er en array af heltal der definérer hvilke zoom-forhold det er muligt at lave print i. @@ -61,7 +66,7 @@ Herunder er et eksempel på en opsætning der kun giver mulighed for print i ``1 .. _configjs_print_timeout: timeout -***************************************************************** +--------------------------------------------------------------------------- ``timeout`` er en integer der angiver hvor lang tid der må gå før print-processen stopper sig selv. Det kan være nødvendigt at øge denne værdi hvis man ønsker at printe i større formater som A1 eller over. @@ -70,7 +75,7 @@ timeout .. _configjs_configurl: configUrl -***************************************************************** +--------------------------------------------------------------------------- HTTP server hvor eksterne resourcer findes. Resourcer kan være: @@ -94,7 +99,7 @@ Der kan angives forskellige URLer til forskellige databaser. ``_default`` betyde .. _configjs_leftslidewidths: leftSlideWidths -***************************************************************** +--------------------------------------------------------------------------- Angivelse af bredder i det venstre slide-ud panel i default template. @@ -107,7 +112,7 @@ Tallene angiver brededer i hhv. phone, tablet og desktop. .. _configjs_df: df -***************************************************************** +--------------------------------------------------------------------------- Til WMS baggrundskort fra Datafordeler og Dataforsyningen kan der anvendes en proxy, som til dels fixer et problem med Datafordeler og til dels kan forsyne kaldene med brugernavn/kodeord eller token, så disse ikke bliver eksponeret til Vidi brugerne. @@ -136,7 +141,7 @@ Se i Kørselskonfigurationen :ref:`configjs_baselayers` hvordan WMS'er fra Dataf .. _configjs_extensions: extensions -***************************************************************** +--------------------------------------------------------------------------- For at tilføje en extension til Vidi, skal der tilføjes en blok i ``extensions``. Der skal angives hvilke filer der skal bygges ind i vidi. @@ -153,7 +158,29 @@ Da alle extensions er forskellige i opbygning, kan det være nødvendigt at tilf ] }, +.. _configjs_urlsIgnoredForCaching: + +urlsIgnoredForCaching +--------------------------------------------------------------------------- + +For at tilføje en extension til Vidi, skal der tilføjes en blok i ``extensions``. Der skal angives hvilke filer der skal bygges ind i vidi. + +Da alle extensions er forskellige i opbygning, kan det være nødvendigt at tilføje den til både ``browser`` og ``server``. Når den enkelte extension er bygget, kan den aktiveres i :ref:`configjs_enabledExtensions`. + +.. code-block:: json + + "urlsIgnoredForCaching": [ + { + "regExp": true, + "requested": "services.hxgncontent.com" + }, + { + "regExp": true, + "requested": "socket\\.io" + } + ], + Komplet eksempel -***************************************************************** +--------------------------------------------------------------------------- For at se et komplet eksempel på en konfiguration henvises til default config i repo. `Den kan du finde her `_ diff --git a/docs/pages/standard/95_embed.rst b/docs/pages/developer/embed.rst similarity index 93% rename from docs/pages/standard/95_embed.rst rename to docs/pages/developer/embed.rst index 8c5d03151..430b259d5 100644 --- a/docs/pages/standard/95_embed.rst +++ b/docs/pages/developer/embed.rst @@ -1,23 +1,19 @@ .. _embed: -################################################################# Indlejring af Vidi på andre hjemmesider -################################################################# +=========================================================================== .. topic:: Overview - :Date: |today| - :Vidi-version: UNRELEASED :Forfattere: `mapcentia `_ .. contents:: - :depth: 4 + :depth: 3 .. _embed_script: -***************************************************************** -Embed.js script -***************************************************************** +Installation +--------------------------------------------------------------------------- Vidi kan indlejres på en hjemmeside vha. embed.js scriptet. Dette script skal loades på hjemmesiden, hvor Vidi skal indlejres. @@ -31,9 +27,8 @@ Scriptet kan både placeres i toppen og bunden af hjemmesiden. .. _embed_div: -***************************************************************** Indlejring af Vidi -***************************************************************** +--------------------------------------------------------------------------- Indlejring af Vidi sker ved at placere et ``div`` element på hjemmeside, hvor Vidi ønskes placeret. En række ``data`` attributer styrer hvordan kortet vises. @@ -108,9 +103,8 @@ Følgende funktioner er skjulte, men kan sættes til "inline" hvis funktionerne .. _embed_api: -***************************************************************** Embed API -***************************************************************** +--------------------------------------------------------------------------- Embed scriptet udstiller et API, så det er muligt at ændre Vidi's tilstand og definere callback funtioner fra den hjemmeside det er indlejret på. diff --git a/docs/pages/standard/92_gc2_meta_information.rst b/docs/pages/developer/gc2.rst similarity index 94% rename from docs/pages/standard/92_gc2_meta_information.rst rename to docs/pages/developer/gc2.rst index ce02308b6..bb3c4bcce 100644 --- a/docs/pages/standard/92_gc2_meta_information.rst +++ b/docs/pages/developer/gc2.rst @@ -1,21 +1,17 @@ .. _gc2meta: -################################################################# Lagopsætning fra GC2 -################################################################# +=========================================================================== .. topic:: Overview - :Date: |today| - :Vidi-version: 2020.11.0 :Forfattere: `mapcentia `_ .. contents:: :depth: 4 -***************************************************************** GC2 Meta information -***************************************************************** +--------------------------------------------------------------------------- GC2 har et konfigurerbart Meta Data system med egenskaber tilknyttet de enkelte lag, som Vidi læser ved opstart. Egenskaberne omfatter fx om lag kan editeres, om et lag skal vises som tile- eller vektorlag osv. @@ -25,12 +21,13 @@ GC2 har et konfigurerbart Meta Data system med egenskaber tilknyttet de enkelte :name: cross-multi-select :figclass: align-center | + Herunder følger de forskellige egenskaber, der har betydning for Vidi. -.. _gc2mata_infopopup: +.. _gc2meta_infopopup: Info pop-up -================================================================= +--------------------------------------------------------------------------- **Pop-up template** @@ -38,7 +35,7 @@ Indeholdet i feature-info pop-up'en styres vha. en template, som anvender sproge Hvis der ikke angives en template, så anvendes en standard, som looper felterne igennem og lister dem. Den ser således ud: -.. code-block:: handlebars +.. code-block::

{{_vidi_content.title}}

@@ -122,10 +119,10 @@ Anvendes ved brugen af :ref:`configjs_crossmultiselect` Anvendes ved brugen af :ref:`configjs_crossmultiselect` -.. _gc2mata_layertype: +.. _gc2meta_layertype: Layer type -================================================================= +--------------------------------------------------------------------------- **Type** @@ -138,10 +135,10 @@ Hvilken type skal laget have i Vidi? Enten Vector eller Tile. Tile er WMS fra Ma Hvilken type skal være valgt fra starten. -.. _gc2mata_tables: +.. _gc2meta_tables: Tables -================================================================= +--------------------------------------------------------------------------- **Zoom on select** @@ -151,10 +148,10 @@ Skal der zoomes ved valg af objekt i feature-info-tabellen? Hvis der zoomes, så kan maks zoom-level sættes. Jo højere tal jo længere ind zoomes der. Er speciel anvendelig ved punktlag, hvor der altid zoomes maks ind. Standard sat til 17. -.. _gc2mata_editor: +.. _gc2meta_editor: Editor -================================================================= +--------------------------------------------------------------------------- **Editable** @@ -166,10 +163,11 @@ Skal laget være editerbart? Både Tile og Vector kan editeres. Det anbefales do :name: cross-multi-select :figclass: align-center | -.. _gc2mata_tilesettings: + +.. _gc2meta_tilesettings: Tile settings -================================================================= +--------------------------------------------------------------------------- (Har kun betydning for lag af typen Tile) @@ -198,10 +196,10 @@ Eksempel på et style-objekt: "dashSpeed": 5 } -.. _gc2mata_vectorsettings: +.. _gc2meta_vectorsettings: Vector settings -================================================================= +--------------------------------------------------------------------------- (Har kun betydning for lag af typen Vector) @@ -331,10 +329,10 @@ Hvis der angives en tooltip template får hver vektorfeature et tooltip/label me {{plannavn}} {{plannr}} -.. _gc2mata_filters: +.. _gc2meta_filters: Filters -================================================================= +--------------------------------------------------------------------------- **Filter config** @@ -388,10 +386,10 @@ Hvad skal match være som standard: All eller Any Hvis denne egenskab er slået til kan filteropsætningen ikke ændres i Vidi. -.. _gc2mata_mouseover: +.. _gc2meta_mouseover: Mouse over -================================================================= +--------------------------------------------------------------------------- **Activate mouse over** @@ -415,10 +413,10 @@ Hvis der ikke angives en template, så anvendes en standard, som looper valgte f Ved mouse over på tile-lag anvendes et såkaldt UTF grid, som er en slags interaktivt lag, som loades bag tile-laget. Det kræver database og CPU resourcer at danne disse grids, så det er muligt at cache dem, således allerede brugte grids ikke skal gendannes. -.. _gc2mata_references: +.. _gc2meta_references: References -================================================================= +--------------------------------------------------------------------------- **Referenced by** @@ -449,10 +447,10 @@ I Vidi i laget-træet kan børne-lagene ses på forældre-laget: :figclass: align-center | -.. _gc2mata_layerstree: +.. _gc2meta_layerstree: Layer tree -================================================================= +--------------------------------------------------------------------------- **Sub group** @@ -460,7 +458,7 @@ Denne egenskab kan gruppere lag i en under-lag-grupper. Alle lag med samme Sub g Man kan have uendelig mange undergrupper og stien af undergrupper, hvor laget skal befinde sig skal angives således: -.. code-block:: json +.. code-block:: sub group 1|sub group 2|sub group 3|sub group 4 @@ -482,14 +480,13 @@ Her ses alle mulighederne: **Disable check box** -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 filter. +Laget kan låses. Det låses op, hvis laget er registreret som "barn" til et andet lag gennem :ref:`gc2meta_references`, hvorpå der aktiveres et filter. -***************************************************************** -GC2 Struktur-fanen -***************************************************************** +Tabelopsætning fra GC2 +=========================================================================== -I GC2's struktur-fane kan der laves en række indstillinger på feltniveau. +I GC2's struktur-fane for den enkelte tabel, kan der laves en række indstillinger på feltniveau. .. figure:: ../../_media/structure-overview.png :width: 700px @@ -499,25 +496,25 @@ I GC2's struktur-fane kan der laves en række indstillinger på feltniveau. | Alias -================================================================= +--------------------------------------------------------------------------- Giv feltet et alias, som vises i stedet for det tekniske feltnavn i Vidi. Kan indeholde specialtegn Vis i klik-info -================================================================= +--------------------------------------------------------------------------- -Medtag feltet i feature-info. Gælder kun ved brugen af standard pop-up templaten. (se :ref:`gc2mata_infopopup`) +Medtag feltet i feature-info. Gælder kun ved brugen af standard pop-up templaten. (se :ref:`gc2meta_infopopup`) .. _gc2structure_mouseover: Vis i mouse-over -================================================================= +--------------------------------------------------------------------------- -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`) +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:`gc2meta_mouseover`) Søgbar -================================================================= +--------------------------------------------------------------------------- Gør feltet søgbart i lagets fritekstsøgning. @@ -529,13 +526,13 @@ Gør feltet søgbart i lagets fritekstsøgning. | Deaktiver filtrering -================================================================= +--------------------------------------------------------------------------- Ekskluder feltet fra lag-filtrering. Autocomplete -================================================================= +--------------------------------------------------------------------------- Aktiver autocomplete på feltet i filtrering. @@ -549,41 +546,41 @@ Aktiver autocomplete på feltet i filtrering. .. _gc2structure_link: Gør til link -================================================================= +--------------------------------------------------------------------------- Hvis feltet indholder en web-adresse gøres det til et aktivt link i pop-up'en. .. note:: - Hvis der anvendes en brugerdefineret pop-up template, har denne indstilling ingen effekt (se :ref:`gc2mata_infopopup`) + Hvis der anvendes en brugerdefineret pop-up template, har denne indstilling ingen effekt (se :ref:`gc2meta_infopopup`) Content -================================================================= +--------------------------------------------------------------------------- -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`) +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:`gc2meta_infopopup`) .. note:: - Hvis der anvendes en brugerdefineret pop-up template, har denne indstilling ingen effekt (se :ref:`gc2mata_infopopup`) + Hvis der anvendes en brugerdefineret pop-up template, har denne indstilling ingen effekt (se :ref:`gc2meta_infopopup`) .. _gc2structure_link_prefix: Link prefix -================================================================= +--------------------------------------------------------------------------- Hvis :ref:`gc2structure_link` er tjekket af, kan der sættes en tekst-streng foran linket. Fx hvis ``https://`` mangler i linket (fx ``minside.dk/mitdok.pdf``) således det blivet et gyldigt link. .. note:: - Hvis der anvendes en brugerdefineret pop-up template, har denne indstilling ingen effekt (se :ref:`gc2mata_infopopup`) + Hvis der anvendes en brugerdefineret pop-up template, har denne indstilling ingen effekt (se :ref:`gc2meta_infopopup`) Link suffix -================================================================= +--------------------------------------------------------------------------- Som ved :ref:`gc2structure_link_prefix` men bare bagved. Fx hvis feltet kun indeholder en titel på et dokument: ``mitdok``, så kan ``https://minside.dk`` sættes som prefix og ``.pdf`` som suffix. og resultatet bliver ``https://minside.dk/mitdok.pdf``. .. note:: - Hvis der anvendes en brugerdefineret pop-up template, har denne indstilling ingen effekt (se :ref:`gc2mata_infopopup`) + Hvis der anvendes en brugerdefineret pop-up template, har denne indstilling ingen effekt (se :ref:`gc2meta_infopopup`) Template -================================================================= +--------------------------------------------------------------------------- Hvis værdien af et felt skal udtrykkes i pop-up og tabel ved andet end selve den rå værdi kan der indsættes en template for feltet. En template har adgang til alle objektets attributter. Fx kan der defineres en template, som skaber et link med link-tekst og ``title`` og ``aria-label`` attributter fra et andet felt. Fx: @@ -592,12 +589,12 @@ Hvis værdien af et felt skal udtrykkes i pop-up og tabel ved andet end selve de {{plannr}} {{plannavn}} .. note:: - Hvis der anvendes en brugerdefineret pop-up template, har denne indstilling ingen effekt (se :ref:`gc2mata_infopopup`) + Hvis der anvendes en brugerdefineret pop-up template, har denne indstilling ingen effekt (se :ref:`gc2meta_infopopup`) Se også :ref:`templates` Egenskaber -================================================================= +--------------------------------------------------------------------------- Her kan der defineres hvilke værdier, der kan være i feltet. Hvis dette defineres, vil der i Vidi's filter og editerings funktioner blive dannet en drop-down-liste, hvor værdierne kan vælges. Det vil altså ikke være muligt at indtaste vilkårlige værdier. @@ -637,6 +634,3 @@ Listen kan både bestå af tal og tekster. **Wild card** Der kan dannes en drop-down-liste af samtlige unikke værdier som allerede findes i feltet. Det gøres ved at indsætte ``*`` i feltet. - - - diff --git a/docs/pages/developer/index.rst b/docs/pages/developer/index.rst new file mode 100644 index 000000000..c3710da4b --- /dev/null +++ b/docs/pages/developer/index.rst @@ -0,0 +1,18 @@ +.. _developer: + +Udviklerdokumentation +=========================================================================== + +Herunder findes dokumentation på emner der er relevante for udviklere og systemadministratorer. + +.. toctree:: + :maxdepth: 1 + + build_configuration + run_configuration + embed + templates + standard_query_string + gc2 + serviceworker + api \ No newline at end of file diff --git a/docs/pages/standard/91_run_configuration.rst b/docs/pages/developer/run_configuration.rst similarity index 95% rename from docs/pages/standard/91_run_configuration.rst rename to docs/pages/developer/run_configuration.rst index 7c4798659..7bc0fabd5 100644 --- a/docs/pages/standard/91_run_configuration.rst +++ b/docs/pages/developer/run_configuration.rst @@ -1,13 +1,10 @@ .. _configjson: -################################################################# Kørselskonfiguration (configs) -################################################################# +=========================================================================== .. topic:: Overview - :Date: |today| - :Vidi-version: 2024.11.0 :Forfattere: `giovanniborella `_ | `mapcentia `_ .. contents:: @@ -26,7 +23,7 @@ Som kan læses sådan: .. _configjs_schemata: schemata -***************************************************************** +--------------------------------------------------------------------------- Her angives hvilke lag, der skal hente ind i lagtræet. Der er tre måder at angive på: @@ -52,7 +49,7 @@ De tre måder kan kombineres. .. _configjs_enabledextensions: enabledExtensions -***************************************************************** +--------------------------------------------------------------------------- Her angives hvilke extensions, som skal aktiveres. @@ -72,7 +69,7 @@ Her angives hvilke extensions, som skal aktiveres. .. _configjs_extensionconfig: extensionConfig -***************************************************************** +--------------------------------------------------------------------------- Her kan opsætningen af de enkelte extensions laves. Det er ikke alle extensions, som har sine egne indstillinger. @@ -120,7 +117,7 @@ Her følger hvordan de enkelte extensions kan opsættes (Pt. omfatter denne del .. _configjs_enabledprints: enabledPrints -***************************************************************** +--------------------------------------------------------------------------- Her angives hvilke print-templates der skal være adgang til. Angives flere end én kan brugeren vælge mellem dem i print-dialogen. @@ -131,7 +128,7 @@ Her angives hvilke print-templates der skal være adgang til. Angives flere end .. _configjs_enabledsearch: enabledSearch -***************************************************************** +--------------------------------------------------------------------------- Her angives hvilket søgemodul, der skal være aktiveret. Pt. er der to standard moduler: @@ -145,7 +142,7 @@ Her angives hvilket søgemodul, der skal være aktiveret. Pt. er der to standard .. _configjs_searchconfig: searchConfig -***************************************************************** +--------------------------------------------------------------------------- Her kan det valgte søgemodul konfigureres. @@ -177,30 +174,32 @@ De ekstra søgemoduler kan opsættes således: .. code-block:: json - searchConfig: { - extraSearches: [,{ - name: "stednavne_search", - db: "dk", - host: "https://dk.gc2.io", - heading: "Stednavne", - zoom: 20, // Zoomniveau, når der klikkes på et søgeresultat - index: { - name: "stednavne/navne_samlet", - field: "string", - key: "gid", - }, - relation: { - name: "stednavne.navne_samlet_geom", - key: "gid", - geom: "the_geom" - } - }] - }, + { + "searchConfig": { + "extraSearches": [{ + "name": "stednavne_search", + "db": "dk", + "host": "https://dk.gc2.io", + "heading": "Stednavne", + "zoom": 20, + "index": { + "name": "stednavne/navne_samlet", + "field": "string", + "key": "gid" + }, + "relation": { + "name": "stednavne.navne_samlet_geom", + "key": "gid", + "geom": "the_geom" + } + }] + } + } .. _configjs_template: template -***************************************************************** +--------------------------------------------------------------------------- Her angives hvilken template, som skal bruges. Angives det ikke, bruges standard-templaten ``default.tmpl``. Egne Templates kan placeres på egen server ved angivelse af :ref:`configUrl` indstillingen. @@ -212,7 +211,7 @@ Egne Templates kan placeres på egen server ved angivelse af :ref:`configUrl` kan undertrykkes ved udvalgte templates. Templates kan angives ved navn eller regular expression. @@ -427,7 +426,7 @@ startupModalSupressionTemplates .. _configjs_featureinfoonmap: featureInfoTableOnMap -***************************************************************** +--------------------------------------------------------------------------- Når denne er sat til ``true`` vises feature-info tabellerne i en popup på kortet i stedet for i sidepanelet. Det gør indstillingen veleget til embed template. Ved brug af "avanceret forespørgelse" vises tabellerne dog stadig i sidepanelet. @@ -441,15 +440,17 @@ Ved brug af "avanceret forespørgelse" vises tabellerne dog stadig i sidepanelet :align: center :name: feature-info-table-on-map :figclass: align-center + | .. note:: + Kan ikke anvendes i sammenhæng med :ref:`configjs_crossmultiselect` .. _configjs_crossmultiselect: crossMultiSelect -***************************************************************** +--------------------------------------------------------------------------- Når denne er sat til ``true`` vil feature info klik fange både raster- og vektor-lag og opstille de enkelte resultater i en "harmonika". Derved inddeles resultatet ikke efter hvilke lag de tilhører. Overskrifterne har to dele: @@ -468,15 +469,17 @@ Ovenstående sættes i GC2 Meta. :align: center :name: cross-multi-select :figclass: align-center + | .. note:: + Hvis extension ``editor`` er aktiv vil ``crossMultiSelect`` bliver sat til ``false``. .. _configjs_activatemaintab: activateMainTab -***************************************************************** +--------------------------------------------------------------------------- Sæt hvilket modul, som skal være aktivt fra starten. Mulighederne er: @@ -499,7 +502,7 @@ Sæt hvilket modul, som skal være aktivt fra starten. Mulighederne er: .. _configjs_cssfiles: cssFiles -***************************************************************** +--------------------------------------------------------------------------- Load eksterne CSS filer. Filerne skal placeres på en HTTP server, som forbindes til vha. :ref:`configUrl` @@ -513,7 +516,7 @@ Load eksterne CSS filer. Filerne skal placeres på en HTTP server, som forbindes .. _configjs_dontuseadvancedbaselayerswitcher: dontUseAdvancedBaseLayerSwitcher -***************************************************************** +--------------------------------------------------------------------------- Deaktiver dobbelt baggrundskort funktionen. @@ -521,10 +524,10 @@ Deaktiver dobbelt baggrundskort funktionen. "dontUseAdvancedBaseLayerSwitcher": true -.. _configjs_advancedbaselayerswitcher +.. _configjs_advancedbaselayerswitcher: advancedBaseLayerSwitcher -***************************************************************** +--------------------------------------------------------------------------- Opsætning af dobbelt baggrundskort funktionen. @@ -545,7 +548,7 @@ Opsætning af dobbelt baggrundskort funktionen. .. _configjs_infoclickcursorstyle: infoClickCursorStyle -***************************************************************** +--------------------------------------------------------------------------- Sæt hvilken CSS cursor style markøren skal have når feature-info modulet er aktivt. Default er "crosshair". @@ -558,7 +561,7 @@ Andre muligheder kan ses `her `. Hvis Vidi startes med et projekt link, vil denne konfiguration blive ignoreret. @@ -584,7 +587,7 @@ Liste over lag, som skal tændes fra starten. Lag angives schema qualified og me .. _configjs_removedisabledlayersfromLegend: removeDisabledLayersFromLegend -***************************************************************** +--------------------------------------------------------------------------- Hvis sættes til true, så fjernes lag fra signaturforklaringen, når laget slukkes. Ellers forbliver det på signaturen, men tjekboksen bliver tom. Default er "false". @@ -595,7 +598,7 @@ Hvis sættes til true, så fjernes lag fra signaturforklaringen, når laget sluk .. _configjs_autoPanPopup: autoPanPopup -***************************************************************** +--------------------------------------------------------------------------- Denne indstilling bevirker, at når en pop-up åbnes, så panoreres kort således, at pop-up'en kommer indenfor kortets udsnit. Bemærk, at indstillingen helst skal sættes til "false", hvis der anvendes vektor-lag med dynamisk loading af data, fordi panoreringen evt. kan bevirke reload af data og derefter lukkes pop-up'en Default er "false". @@ -606,9 +609,9 @@ Denne indstilling bevirker, at når en pop-up åbnes, så panoreres kort sålede .. _configjs_vectorTable: vectorTable -***************************************************************** +--------------------------------------------------------------------------- -Denne indstilling styrer om :ref:`vektorlag tabellen` skal vises til højre for eller i bunden af kortet. Endvidere kan højde/bredde styres. Hvis positionen er sat til ``right`` +Denne indstilling styrer om :ref:`vektorlag tabellen` skal vises til højre for eller i bunden af kortet. Endvidere kan højde/bredde styres. Hvis positionen er sat til ``right`` vil kun ``width`` have effekt og tabellen vil altid fylde højden ud. Hvis position er sat til ``bottom`` vil kun ``height`` have effekt og bredden bliver den samme som kortet. ``width`` kan både være relativ ``%`` og absolute ``px`` mens ``height`` kun kan angives som absolute ``px``. Hvis ikke denne indstilling sættes bruges default værdier som vist nedenunder. @@ -623,7 +626,7 @@ vil kun ``width`` have effekt og tabellen vil altid fylde højden ud. Hvis posit .. _configjs_initFunction: initFunction -***************************************************************** +--------------------------------------------------------------------------- Her kan angives en JavaScript funktion, som bliver kørt når Vidi er klar. Funktionen skal skrives som en linje tekst startende med `function()` og den efterfølgende blok er den, som bliver eksekveret: @@ -634,7 +637,7 @@ Her kan angives en JavaScript funktion, som bliver kørt når Vidi er klar. Funk .. _configjs_initZoomCenter: initZoomCenter -***************************************************************** +--------------------------------------------------------------------------- Hvis sat vil Vidi starte op på det angivet zoom/center. Denne indstilling vil have forrang over zoom/center sat i URL og projekt-link. Kan fx anvendes til at sikre, at alle indlejrede kort starter med samme zoom/center. @@ -648,7 +651,7 @@ Angives således `/z/x/y`. Dette svarer til det, der vises i Vidi URL'en. .. _configjs_popupdraggable: popupDraggable -***************************************************************** +--------------------------------------------------------------------------- Hvis sat til `true` kan man flytte feature-info pop-up'en på kortet. @@ -660,7 +663,7 @@ Hvis sat til `true` kan man flytte feature-info pop-up'en på kortet. .. _configjs_title: title -***************************************************************** +--------------------------------------------------------------------------- Sæt titel på siden (den der vises på browser-fanen). @@ -675,14 +678,15 @@ Sæt titel på siden (den der vises på browser-fanen). .. _configjs_baselayerdrawer: baselayerDrawer -***************************************************************** +--------------------------------------------------------------------------- Anvend baggrundskort "skuffe" i stedet for toggle knappen. Skuffen kan indeholde et vilkårlig antal muligheder. Udvælgelsen af baggrundskort til skuffen og thumbnails/ skal opsættes i :ref:`configjs_baselayers` .. figure:: ../../_media/baselayer-drawer.png :align: center - :name: feature-info-table-on-map + :name: baselayer-drawer :figclass: align-center + | .. code-block:: json @@ -695,7 +699,7 @@ Anvend baggrundskort "skuffe" i stedet for toggle knappen. Skuffen kan indeholde .. _configjs_showoffcanvas: showOffcanvas -***************************************************************** +--------------------------------------------------------------------------- Her kan angives, om menuen skal være vist fra starten. Værdierne kan være ``true``, ``false`` eller ``"mobile"``. Den sidste viser menuen, hvis skærmen er bred men ikke på fx en smal telefonskærm. @@ -708,7 +712,7 @@ Her kan angives, om menuen skal være vist fra starten. Værdierne kan være ``t .. _configjs_expandfirstinlayertree: expandFirstInLayerTree -***************************************************************** +--------------------------------------------------------------------------- Angiver om den første/øverste gruppe i lagtræet skal være foldet ud fra starten. @@ -720,7 +724,7 @@ Angiver om den første/øverste gruppe i lagtræet skal være foldet ud fra star .. _configjs_infocallback: infoCallback -***************************************************************** +--------------------------------------------------------------------------- En funktion som køres, når feature info rammer et eller flere lag. En liste af med de ramte lag sendes med. @@ -731,7 +735,7 @@ En funktion som køres, når feature info rammer et eller flere lag. En liste af .. _configjs_emptyinfocallback: emptyInfoCallback -***************************************************************** +--------------------------------------------------------------------------- En funktion som køres, når feature info IKKE rammer noget. @@ -742,7 +746,7 @@ En funktion som køres, når feature info IKKE rammer noget. .. _configjs_dateformats: dateFormats -***************************************************************** +--------------------------------------------------------------------------- Det er muligt at formatere datoer i templates (både popup- og felt-templates). Det gøres ved at kalde en template "helper" og angive et defineret datoformat. @@ -774,10 +778,9 @@ Hvis ens datoer ikke er et standardformat, men fx Plandata's, hvor datoer bliver Læs mere om :ref:`templates` -.. _configjs_dateformats: statelessDraw -***************************************************************** +--------------------------------------------------------------------------- Hvis man ikke vil have at tegninger "hænger ved" efter refresh af browser, kan denne option sættes til `true`. @@ -788,7 +791,7 @@ Hvis man ikke vil have at tegninger "hænger ved" efter refresh af browser, kan .. _configjs_openlayertreegroups: openLayerTreeGroups -***************************************************************** +--------------------------------------------------------------------------- Angiv hvilke grupper, som skal være foldet ud i lagtræet fra starten. @@ -799,7 +802,7 @@ Angiv hvilke grupper, som skal være foldet ud i lagtræet fra starten. .. _configjs_crs: crs -***************************************************************** +--------------------------------------------------------------------------- Angiv den kort projektion/grid, som skal anvendes. Default er `EPSG3857` and den eneste anden mulighed er `EPSG25832`, som er det danske UTM32 grid. @@ -807,9 +810,9 @@ Angiv den kort projektion/grid, som skal anvendes. Default er `EPSG3857` and den "crs": "EPSG25832" -################################################################# + Referencer -################################################################# +=========================================================================== En konfiguration kan henvise til andre konfigurationer og på den måde kan dele af en opsætning genbruges i flere konfigurationer. @@ -867,7 +870,7 @@ URL'en til konfigurationen fås ved at anvende knappen KOPIER LINK: .. figure:: ../../_media/json-refs.png :width: 400px :align: center - :name: feature-info-table-on-map + :name: json-refs :figclass: align-center .. note:: diff --git a/docs/pages/developer/serviceworker.rst b/docs/pages/developer/serviceworker.rst new file mode 100644 index 000000000..c983877dc --- /dev/null +++ b/docs/pages/developer/serviceworker.rst @@ -0,0 +1,43 @@ +.. _serviceworker: + +Serviceworker +=========================================================================== + +.. topic:: Overview + + :Forfattere: `mapcentia `_ + +.. contents:: + :depth: 4 + +Vidi benytter en serviceworker til at cache data og til at håndtere offline-tilstand. Dette gøres for at forbedre hastigheden ved indlæsning af Vidi og for at sikre, at Vidi kan bruges offline. + +Caching +--------------------------------------------------------------------------- + +For at forbedre hastigheden ved indlæsning af Vidi, caches mange eksterne kald. Dette gælder blandt andet for kald til bagggrundskort, så disse kommer hurtigere frem i kortet efterfølgende. + +Det er dog ikke altid ønskeligt, og det er derfor muligt at slå caching fra på enkelte adresser. Herunder er et script hvor man kan bruge i dev-tool for at teste: + +.. code-block:: js + + /** + * 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); + +For at gemme indstillingen globalt, kan man tilføje den ønskede payload til :ref:`configjs_urlsIgnoredForCaching` + diff --git a/docs/pages/standard/80_standard_query_string.rst b/docs/pages/developer/standard_query_string.rst similarity index 92% rename from docs/pages/standard/80_standard_query_string.rst rename to docs/pages/developer/standard_query_string.rst index 51a984b11..f409a0eed 100644 --- a/docs/pages/standard/80_standard_query_string.rst +++ b/docs/pages/developer/standard_query_string.rst @@ -1,13 +1,10 @@ .. _standardquerystring: -################################################################# Standard query string -################################################################# +=========================================================================== .. topic:: Overview - :Date: |today| - :Vidi-version: 2022.8.4 :Forfattere: `mapcentia `_ .. contents:: @@ -16,7 +13,7 @@ Standard query string Når Vidi starter kan man indsætte parametre i url'en som styre en række egenskaber. initialFilter -***************************************************************** +--------------------------------------------------------------------------- Denne parameter kan sætte filtre på lag således, at de er filtreret fra startet. Der kan sættes flere filtre på det samme lag og flere lag kan filtreres. Filtrede lag bliver aktiveret i vektor-udgave og der zoomes til filtrerede features på det sidst færdig-loadede lag. Hvis laget ikke er udgivet i vektor-udgave, vil tile-udgaven tænde og der zoomes ikke. diff --git a/docs/pages/standard/93_templates.rst b/docs/pages/developer/templates.rst similarity index 95% rename from docs/pages/standard/93_templates.rst rename to docs/pages/developer/templates.rst index 27f7895f6..745de54a2 100644 --- a/docs/pages/standard/93_templates.rst +++ b/docs/pages/developer/templates.rst @@ -1,22 +1,15 @@ .. _templates: -################################################################# Templates -################################################################# +=========================================================================== .. topic:: Overview - :Date: |today| - :Vidi-version: 2025.2.1 :Forfattere: `mapcentia `_ .. contents:: :depth: 4 - -Indledning -***************************************************************** - Vidi anvender såkaldte templates til styrings af layouts. Helt overordnet styres Vidis layout af en template, men også mindre dele styres af templates. Det er indholdet i feature-info pop-ups og visning af enkelte datafelter i fx konfliktsøgeren. @@ -36,7 +29,7 @@ I ovenstående template bliver ``{{plannr}}`` og ``{{vedtagetdato}}`` skiftet ud Der kan anvendes HTML i templates. Indbyggede hjælpefunktioner -***************************************************************** +--------------------------------------------------------------------------- I Vidi er der defineret nogle hjælpefunktioner, som kan anvendes i templates. En hjælpefunktion tager selve værdien og evt. nogle argumenter som input og returnere typisk en ændret værdi. diff --git a/docs/pages/extensions/extensions.rst b/docs/pages/extensions/directions.rst similarity index 80% rename from docs/pages/extensions/extensions.rst rename to docs/pages/extensions/directions.rst index b356719a0..ddee05cbc 100644 --- a/docs/pages/extensions/extensions.rst +++ b/docs/pages/extensions/directions.rst @@ -1,31 +1,22 @@ -.. _extensions: -.. |gc2| raw:: html - - GC2 +.. _extensions_directions: -***************************************************************** -Extensions -***************************************************************** +Rutevejledning (directions) +=========================================================================== .. topic:: Overview - :Date: |today| - :Vidi-version: UNRELEASED :Forfattere: `mapcentia `_ .. contents:: :depth: 3 -.. _extensions_directions: - -Rutevejledning -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - ``directions`` er en udvidelse til vidi der giver mulighed for at lave rutevejledning i kortet. Der laves en rutevejledning fra brugerens position til et punkt på kortet. Det er i øjeblikket kun muligt at lave rutevejledning med Google Maps. -Intallation -""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +Installation +--------------------------------------------------------------------------- + +``directions`` er en del af Vidi og kræver ikke yderligere installation. Funktionen skal medtages i :ref:`configjs_extensions` @@ -37,9 +28,13 @@ Funktionen skal medtages i :ref:`configjs_extensions` ], }, +Konfiguration +--------------------------------------------------------------------------- + +Der er ikke nogen konfiguration for denne extension. Den vil automatisk blive tilføjet til værktøjslinjen. Brug -""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" +--------------------------------------------------------------------------- .. figure:: ../../_media/extensions-directions-icon.png :align: center diff --git a/docs/pages/extensions/index.rst b/docs/pages/extensions/index.rst new file mode 100644 index 000000000..c9e8cfc1b --- /dev/null +++ b/docs/pages/extensions/index.rst @@ -0,0 +1,11 @@ +.. _extensions: + +Extensions +=========================================================================== + +Herunder findes dokumentation på de extensions, som følger med Vidi som standard. + +.. toctree:: + :maxdepth: 1 + + directions \ No newline at end of file diff --git a/docs/pages/extensions/non_standard.rst b/docs/pages/extensions/non_standard.rst deleted file mode 100644 index 81b80b60a..000000000 --- a/docs/pages/extensions/non_standard.rst +++ /dev/null @@ -1,63 +0,0 @@ -.. _non_standard_extensions: - -.. |gc2| raw:: html - - GC2 - -################################################################# -Ikke-standard extensions -################################################################# - -.. topic:: Overview - - :Date: |today| - :Author: `mapcentia `_ - -.. contents:: - :depth: 3 - -***************************************************************** -Introduktion -***************************************************************** - -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. - -***************************************************************** -Rejsetid (otp) -***************************************************************** - -Rejsetid extensionen opsættes i en kørselskonfiguration (config) under :ref:`configjs_extensionconfig` - -``routes`` er en liste med de grafer, som brugeren skal kunne vælge imellem i Vidi. - -``default`` angiver start-værdier for de forskellige indstillinger i Vidi. Alle behøves ikke udfyldes. Hvis der undlades indstillinger, bliver der anvendt værdier, som svarer til de nedenunser viste. - -``parameters`` angiver ekstra URL parametre, som skal sendes med til OTP serveren. Default bliver ingen parametre sat. - -``helpText`` angiver den tekst, som skal vises i modulets hjælpefunktion. Default er en tom tekst. - -.. code-block:: json - - { - "extensionConfig": { - "otp": { - "routes": ["default", "nt", "midttrafik", "sydtrafik"], - "defaults": { - "startTime": 30, - "endTime": 50, - "intervals": [600, 1200, 1800], - "startColor": "#ff0000", - "endColor": "#00ff00", - "opacity": 0.7, - "arriveBy": false, - "route": "default", - "maxWalkDistance": 500 - }, - "parameters": { - "offRoadDistanceMeters": "75", - "precisionMeters": "100" - }, - "helpText": "Hjælp til OTP" - } - } - } diff --git a/docs/pages/gettingstarted/gettingstarted.rst b/docs/pages/gettingstarted/gettingstarted.rst index 33d138f03..49655df3f 100644 --- a/docs/pages/gettingstarted/gettingstarted.rst +++ b/docs/pages/gettingstarted/gettingstarted.rst @@ -1,26 +1,14 @@ -.. _gettingstarted: -.. |gc2| raw:: html - - GC2 - -***************************************************************** -Kom godt i gang med Vidi -***************************************************************** +Hvad er Vidi? +=========================================================================== .. topic:: Overview - :Date: |today| - :Vidi-version: 2020.11.0 :Forfatter: `giovanniborella `_ .. contents:: :depth: 3 - -Hvad er Vidi? -================================================================= - Vidi er en HTML5 applikation til at vise og forespørge på kortdata fra |gc2|. Klienten læser information fra GC2's meta-api, og viser en moderne kort-browser med lag for den specificerede PostGreSQL @@ -36,7 +24,7 @@ Vidi er ikke bygget ind i GC2, men kræver sin egen installation. `Du kan prøve det live her `_ Kortvinduet ------------------------------------------------------------------ +--------------------------------------------------------------------------- .. figure:: ../../_media/gettingstarted-main.png :width: 400px @@ -49,7 +37,7 @@ Kortvinduet .. _gettingstarted_menu: Menu -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +--------------------------------------------------------------------------- .. figure:: ../../_media/gettingstarted-menu.png :width: 400px @@ -66,7 +54,7 @@ Menuen gemmer sig selv hvis kortvinduet er for smalt, men kan bringes frem igen .. _gettingstarted_navigate: Navigér -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +--------------------------------------------------------------------------- Panorer i kortet ved at klikke og trække med musen. Det er også muligt at bruge piletasterne på tastaturet. @@ -85,7 +73,7 @@ Man kan gå tilbage i kortudsnit ved at bruge ``Forrige udsnit``-knappen i værk .. _gettingstarted_controls: Værktøjslinjen ------------------------------------------------------------------ +--------------------------------------------------------------------------- .. figure:: ../../_media/gettingstarted-controls.png :align: center diff --git a/docs/pages/gettingstarted/index.rst b/docs/pages/gettingstarted/index.rst new file mode 100644 index 000000000..043c251e4 --- /dev/null +++ b/docs/pages/gettingstarted/index.rst @@ -0,0 +1,12 @@ +.. _gettingstarted: + +Kom godt i gang med Vidi +=========================================================================== + +Herunder er en kort introduktion til Vidi, og hvordan man bruge det forskellige værktøjer der er en del af visningen. + +.. toctree:: + :maxdepth: 1 + + gettingstarted + measure \ No newline at end of file diff --git a/docs/pages/standard/00_measure.rst b/docs/pages/gettingstarted/measure.rst similarity index 86% rename from docs/pages/standard/00_measure.rst rename to docs/pages/gettingstarted/measure.rst index ce58cfc07..f36c21090 100644 --- a/docs/pages/standard/00_measure.rst +++ b/docs/pages/gettingstarted/measure.rst @@ -1,22 +1,14 @@ .. _measure: -################################################################# -Måleværktøjer -################################################################# +Måleværktøj +=========================================================================== .. topic:: Overview - :Date: |today| - :Vidi-version: 2020.11.0 :Forfatter: `giovanniborella `_ .. contents:: - :depth: 3 - - -***************************************************************** -Måle-værktøjet -***************************************************************** + :depth: 2 .. include:: ../../_subs/NOTE_GETTINGSTARTED.rst @@ -32,8 +24,6 @@ Måleværktøjet vil være tilgængeligt i toolbaren. For at aktivere; klik på Start værktøjet ved klikke på "linealen" -Mål -================================================================= Når værktøjet er tændt er det muligt at tegne elementer ind på kortet. Elementerne er bundet op på den geografiske placering, så de vil blive selv om man panorerer i kortet. @@ -45,8 +35,8 @@ Når værktøjet er tændt er det muligt at tegne elementer ind på kortet. Elem Værktøjet er tændt, og klar til at lave elementer. -Mål ------------------------------------------------------------------ +Mål afstand eller areal +--------------------------------------------------------------------------- For at måles, gøres følgende: @@ -77,7 +67,7 @@ For at måles, gøres følgende: Ændre elementer ------------------------------------------------------------------ +--------------------------------------------------------------------------- Når værktøjet aktiveres er det muligt at ændre knudepunkter mm. for de tegnede mål. @@ -92,7 +82,7 @@ Når værktøjet aktiveres er det muligt at ændre knudepunkter mm. for de tegne Klik for ``Gem`` for at gemme, ``Fortryd`` for at annulere alle ændringer. Slet mål ------------------------------------------------------------------ +--------------------------------------------------------------------------- Når værktøjet aktiveres er det muligt at fjerne mål enkeltvis, eller alle på én gang. diff --git a/docs/pages/standard/05_draw.rst b/docs/pages/standard/draw.rst similarity index 88% rename from docs/pages/standard/05_draw.rst rename to docs/pages/standard/draw.rst index ee49e1fea..9b508b4b3 100644 --- a/docs/pages/standard/05_draw.rst +++ b/docs/pages/standard/draw.rst @@ -1,30 +1,19 @@ .. _draw: -################################################################# Tegn -################################################################# +=========================================================================== .. topic:: Overview - :Date: |today| - :Vidi-version: 2020.11.0 :Forfatter: `giovanniborella `_ .. contents:: :depth: 3 - -***************************************************************** -Tegn-værktøjet -***************************************************************** - .. include:: ../../_subs/NOTE_GETTINGSTARTED.rst Elementer vil også fremgå på PDF-print. -Typer -================================================================= - Når værktøjet er tændt er det muligt at tegne elementer ind på kortet. Elementerne er bundet op på den geografiske placering, så de vil blive selv om man panorerer i kortet. .. figure:: ../../_media/draw-on.png @@ -35,9 +24,6 @@ Når værktøjet er tændt er det muligt at tegne elementer ind på kortet. Elem Værktøjet er tændt, og klar til at lave elementer. -Tegn elementer ------------------------------------------------------------------ - For at tegne elementer, gøres følgende: * Linjer: @@ -79,7 +65,7 @@ For at tegne elementer, gøres følgende: * Indtast notat Ændre elementer ------------------------------------------------------------------ +--------------------------------------------------------------------------- Når værktøjet aktiveres er det muligt at ændre knudepunkter mm. for de tegnede elementer. @@ -94,7 +80,7 @@ Når værktøjet aktiveres er det muligt at ændre knudepunkter mm. for de tegne Klik for ``Gem`` for at gemme, ``Fortryd`` for at annulere alle ændringer. Slet elementer ------------------------------------------------------------------ +--------------------------------------------------------------------------- Når værktøjet aktiveres er det muligt at fjerne elementer enkeltvis, eller alle på én gang. @@ -105,12 +91,12 @@ Klik for ``Gem`` for at gemme, ``Fortryd`` for at annulere alle ændringer. .. warning:: Klikker man på ``Slet alle`` kan handlingen ikke fortrydes Stilart -================================================================= +=========================================================================== TBD Linjer ------------------------------------------------------------------ +--------------------------------------------------------------------------- Det er muligt at definere en ende på hver linje. Denne indstilling sættes inden man tegner sin linje. @@ -125,7 +111,7 @@ Der er også mulighed for at få vist mål på linjer, samt totalmål. Fra venstre mod højre: Pilehoved, Stop, firkant, punkt. Den sidste linje er sat op som vist i billedet. Oversigt ------------------------------------------------------------------ +--------------------------------------------------------------------------- Nederst vil der være en tabel over de tegnede geometrier. Ved at klikke på en række vil kortet flyve over til den relevante geometri. diff --git a/docs/pages/standard/index.rst b/docs/pages/standard/index.rst new file mode 100644 index 000000000..3d85f53da --- /dev/null +++ b/docs/pages/standard/index.rst @@ -0,0 +1,13 @@ +.. _standard: + +Standardværktøjer +=========================================================================== + +Herunder findes dokumentation på de værktøjer, som er tilgængelige i kortet. + +.. toctree:: + :maxdepth: 1 + + draw + project + print \ No newline at end of file diff --git a/docs/pages/standard/07_print.rst b/docs/pages/standard/print.rst similarity index 85% rename from docs/pages/standard/07_print.rst rename to docs/pages/standard/print.rst index 21e6c9df6..4b0a4fc95 100644 --- a/docs/pages/standard/07_print.rst +++ b/docs/pages/standard/print.rst @@ -1,13 +1,10 @@ .. _print: -################################################################# Print -################################################################# +=========================================================================== .. topic:: Overview - :Date: |today| - :Vidi-version: 2020.11.0 :Forfatter: `giovanniborella `_ .. include:: ../../_subs/NOTE_CONF.rst @@ -15,18 +12,10 @@ Print .. contents:: :depth: 3 - -***************************************************************** -Printværktøj -***************************************************************** - .. include:: ../../_subs/NOTE_GETTINGSTARTED.rst Når værktøjet vælges er det indledningsvis tændt. -Print -================================================================= - Når værktøjet er tændt vil man se en rød kasser der representerer udskriftsområdet. .. figure:: ../../_media/print-on.png @@ -38,7 +27,7 @@ Når værktøjet er tændt vil man se en rød kasser der representerer udskrifts Værktøjet er tændt, og klar til at printe Muligheder ------------------------------------------------------------------ +--------------------------------------------------------------------------- Efter print-området er dannet er det muligt i kortvinduet at: diff --git a/docs/pages/standard/06_project.rst b/docs/pages/standard/project.rst similarity index 89% rename from docs/pages/standard/06_project.rst rename to docs/pages/standard/project.rst index 6259f6b2e..60c66e02a 100644 --- a/docs/pages/standard/06_project.rst +++ b/docs/pages/standard/project.rst @@ -1,28 +1,17 @@ .. _project: -################################################################# -Projekter -################################################################# +Projekt +=========================================================================== .. topic:: Overview - :Date: |today| - :Vidi-version: 2021.9.0 :Forfatter: `giovanniborella `_ | `mapcentia `_ .. contents:: :depth: 1 - -***************************************************************** -Projekter -***************************************************************** - .. include:: ../../_subs/NOTE_GETTINGSTARTED.rst -Projekt -================================================================= - Projekt-værktøjet kan bruges til at gemme og distribuere øjebliksbilleder af kortets tilstand. Når der bliver lavet et projekt, gemmes kort-udstrækningen, tegnede elementer (:ref:`draw`), lag med mere - og kan bruges som en direkte genvej tilbage til hvor man arbejdede tidligere. @@ -58,24 +47,24 @@ Det er muligt at tilgå et projekt på flere måder: `http://mapgoviditest.geopartner.dk/api/static/vandvaerker/public/?state=state_snapshot_35f2ea90-5975-11eb-8a1b-e3cc28c27983&width=1920&height=1080`_ Skab projekt ------------------------------------------------------------------ +--------------------------------------------------------------------------- Når kortet er opsat med de relevante lag, baggrundskort, tegninger mv. Indtastes et projektnavn, og man trykker på ``Gem``-knappen. Knappen er "Disketten" vist på :numfig:`project-on` Genskab projekt ------------------------------------------------------------------ +--------------------------------------------------------------------------- For at gå til projektet, klik på "Play"-ikonet. Den gemte opsætning vil nu blive genskabt. Editér projekt ------------------------------------------------------------------ +--------------------------------------------------------------------------- Hvis man vil editere et projekt, starter man med at genskabe det - lave ændringerne i baggrundskort mv. og derefter gemme projektet påny. Det er også muligt at omdøbe projektet. Slet projekt ------------------------------------------------------------------ +--------------------------------------------------------------------------- For at slette et projekt bruges "Skraldespand"-ikonet. Der vil komme en pop-up for at bekræfte dit valg. Hvis et projekt slettes er det ikke muligt at genskabe det. diff --git a/docs/pages/vidi/CHANGELOG.rst b/docs/pages/vidi/CHANGELOG.rst new file mode 100644 index 000000000..418dad7b7 --- /dev/null +++ b/docs/pages/vidi/CHANGELOG.rst @@ -0,0 +1,5 @@ +:orphan: + +.. _CHANGELOG: + +.. mdinclude:: ../../../CHANGELOG.md \ No newline at end of file diff --git a/docs/pages/vidi/CONTRIBUTING.rst b/docs/pages/vidi/CONTRIBUTING.rst new file mode 100644 index 000000000..494a6d82e --- /dev/null +++ b/docs/pages/vidi/CONTRIBUTING.rst @@ -0,0 +1,5 @@ +:orphan: + +.. _CONTRIBUTING: + +.. mdinclude:: ../../../CONTRIBUTING.md \ No newline at end of file diff --git a/docs/pages/vidi/README.rst b/docs/pages/vidi/README.rst new file mode 100644 index 000000000..8c54fde9a --- /dev/null +++ b/docs/pages/vidi/README.rst @@ -0,0 +1,5 @@ +:orphan: + +.. _README: + +.. mdinclude:: ../../../README.md \ No newline at end of file diff --git a/docs/pages/vidi/index.rst b/docs/pages/vidi/index.rst new file mode 100644 index 000000000..9f5bf3ebd --- /dev/null +++ b/docs/pages/vidi/index.rst @@ -0,0 +1,14 @@ +.. _GIT: + +Mere om Vidi-projektet +=========================================================================== + +Her er links til mere generel information omkring Vidi-projektet. Siderne her er taget fra Github-projektet. + +.. toctree:: + :maxdepth: 2 + :glob: + + README + CHANGELOG + CONTRIBUTING \ No newline at end of file