Skip to content

Commit

Permalink
Doc update for ICAT
Browse files Browse the repository at this point in the history
  • Loading branch information
rubenvdlinde committed Aug 8, 2024
1 parent 94d731f commit 68cde7a
Show file tree
Hide file tree
Showing 9 changed files with 41 additions and 23 deletions.
6 changes: 4 additions & 2 deletions docs/beheerders/catalogi.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
# Catalogi
# Catalogus

Een catalogus is een verzameling van publicaties. Publicaties behoren dus altijd tot één catalogus en iedere catalogus tot één organisatie. Het is echter wel mogelijk om in één catalogus meerdere metadatatypen te ondersteunen. Binnen de softwarecatalogus worden bijvoorbeeld publiccodes (componenten, code, etc.) als diensten beschikbaar gesteld en binnen de Woo meerdere KOOP/TOOI-typen.
Een catalogus is een verzameling van [publicaties](../gebruikers/publicaties.md). Ze vormen doorgaans een logische versameling rondom een onderwer (bijvoorbeeld WOO) maar kunnen ook worden gebruikt om onderscheid te maken in toegans rechten.

Publicaties behoren dus altijd tot één catalogus en iedere catalogus tot één organisatie. Het is echter wel mogelijk om in één catalogus meerdere [publicatie typen](../beheerders/metadata.md) te ondersteunen. Binnen de softwarecatalogus worden bijvoorbeeld publiccodes (componenten, code, etc.) als diensten beschikbaar gesteld en binnen de WOO meerdere KOOP/TOOI-typen.

> Catalogi zijn onderdeel van de [OpenCatalogi-Standaard](https://github.com/OpenCatalogi/.github/blob/main/docs/Standaard.md) en gebaseerd op het [catalogue object](https://conduction.stoplight.io/docs/open-catalogi/pk8bsjw0539dv-catalogue).
Expand Down
6 changes: 6 additions & 0 deletions docs/beheerders/organisaties.md
Original file line number Diff line number Diff line change
@@ -1 +1,7 @@
# Organisaties

In organisatie representeerd een volledige organistie of organisatorische eenheid. Hoewel de meeste organisaties één organisaite (namenlijk hun eigen) zullen beheren per open catalogi isntallatie zijn er senario's denkbaar waarin er meerdere organisaties in een installatie zitten. Meest voor de hand liggende zijn

- SAAS: Een leverancier bied de software aan als SAAS oplossing en keist vier een hosting voor al haar klanten
- Samenwerkings Verband: meerdere orgnaisaties hebben een gemeenschapenlijk ict ondersteuner, en deze odnersteuner kiest voor éém installatie
- Grote organsisaties: De organisatie is dusdanig groot dat het zinnig wordt om hem ook in de installatie op te splitsen in orgniasatorische eenheden
6 changes: 6 additions & 0 deletions docs/beheerders/themas.md
Original file line number Diff line number Diff line change
@@ -1 +1,7 @@
# Thema's

Een theme is een overkoepelende verbinding tussen [publicaties](../gebruikers/publicaties.md), in tegenstelling tot [catalogi](../beheerders/catalogi.md) kan een publicatie tot meerdere thema's behoren. Theme's zijn daarmee catalogi overstijgend maar in tegenstelling tot catalogi ook organisatie specifiek.

Daar waar een catalogus vaak een uistpraak doet over het soort of type van publicaties in de catalogus (doorgaan geordend in wetenlijke kaders zo als de WOO of WHO) doen theme's uispraken over onderwerpen die worden aangeraakt door publicaties.

Themea's kunnen door de organisatie zelf worden bepaald, en zullen vaak te maken hebben met actualiteit. Bijvoorbeeld de bouw van een nieuwe woonwijk in de gemeente. Gegevens uit verchillende catalogi en publicaite typen (bijvoorbeeld WOO verzoeken, onderzoeks verslagen, raadssstuken en gegevens sets) kunnen dan bij elkaar worden gebracht om voor de bezoekers inzichtenlijk te maken wat een organisatie allemaal heeft gedaan rondom dit thema.
Binary file added docs/gebruikers/image-1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/gebruikers/image-2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/gebruikers/image-3.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/gebruikers/image.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
28 changes: 24 additions & 4 deletions docs/gebruikers/publicaties.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,14 @@

> Publicaties zijn onderdeel van de (Open Catalogi Standaard)\[] en gebaseerd op het [publication object](https://conduction.stoplight.io/docs/open-catalogi/9bebd6bf4fe35-publication). Publicaties kennen eigenschappen zo als gedefineerd in een publicaite type en kunnen worden gekopeld aan bijlagen
Een publicatie representeerd iets wat je wilt publiceren, het beschrijft de handeling van publiceren en de spelregels waaronder iets gepubliceerd wordt.het is een soort "verpakking" of "omhulsel" dat zowel de kerngegevens (data) als aanvullende informatie over die gegevens (metadata) bevat.

Stel je voor dat je een foto hebt. De foto zelf is de data, terwijl de informatie zoals wanneer de foto is genomen, de resolutie van de foto, de camera-instellingen, en de locatie waar de foto is genomen, de metadata vormen. Een publicatie zou in dit geval zowel de foto als al deze aanvullende informatie samen in één pakketje verpakken, zodat je deze als een geheel kunt behandelen en doorzoeken.

Met andere woorden, een publiatie maakt het mogelijk om zowel de data als de bijbehorende metadata op een gestandaardiseerde manier te bewaren en te verwerken, zonder dat je deze informatie telkens apart hoeft te beheren. Dit is handig omdat je zo alle relevante informatie bij elkaar hebt, wat zorgt voor meer context en daarmee een betere interpretatie van de data.

Publicaties zijn altijd onderdeel van een collectie in de vorm van een [catalogus](../beheerders/catalogi.md) en behoren tot een [publicatie type](../beheerders/metadata.md) dit laatste zorgt ervoor dat ze voorspelbaar zijn. e.g. fotos hebben altijd een waarde resulutie.

## Publicaties toevoegen

Publicaties kunnen worden toegevoegd via:
Expand Down Expand Up @@ -38,10 +46,22 @@ Onder is een voorbeeld van een publicatie en de Actie-mogelijkheden.

<figure><img src="../.assets/oc_publicatie_acties.png" alt="" width="375"><figcaption></figcaption></figure>

## Eigenschappen
![alt text](image-1.png)

## Acties

@todo
![alt text](image.png)

## Bijlagen

In het merendeel van de gevallen wordt een publicatie opgemaakt om bestanden te delen (bijvoorbeeld vanuit een woo verzoek). Deze bestanden vormen de informatie in de publicaite en worden aan een publicatie gekoppels als bijlagen. Een bijlage kan zowel onderdeel zijn van de publicatie (er in worden geupload) als elders staan (er wordt naar verwezen).

Naast een bestand kan een bijlage (per verwijzing) bijvoorbeeld ook een website of artikel op een website zijn.

![alt text](image-3.png)

## Eigenschappen

## Bijlengen
Een tweede manier om informatie op te nemen in een publicaite is via eigenschappen. Eigenschappen zijn voor gedefineerde opties (via [publicatie type](../beheerders/metadata.md)) waar een waarde aan kan worden toegekend.

@todo
![alt text](image-2.png)
18 changes: 1 addition & 17 deletions src/views/directory/DirectoryList.vue
Original file line number Diff line number Diff line change
Expand Up @@ -42,30 +42,14 @@ import { navigationStore, directoryStore } from '../../store/store.js'
:key="`${listing}${i}`"
:name="listing.name ?? listing.title"
:active="directoryStore.listingItem?.id === listing?.id"
:details="'1h'"
:counter-number="45"
@click="directoryStore.setListingItem(listing)">
<template #icon>
<LayersOutline :class="directoryStore.listingItem?.id === listing?.id && 'selectedIcon'"
disable-menu
:size="44" />
</template>
<template #subname>
{{ listing?.title }}
</template>
<template #actions>
<NcActionButton @click="directoryStore.setListingItem(listing); navigationStore.setModal('editListing')">
<template #icon>
<Pencil :size="20" />
</template>
Bewerken
</NcActionButton>
<NcActionButton @click="directoryStore.setListingItem(listing); navigationStore.setDialog('deleteListing')">
<template #icon>
<Delete :size="20" />
</template>
Verwijderen
</NcActionButton>
{{ listing?.summary }}
</template>
</NcListItem>
</div>
Expand Down

0 comments on commit 68cde7a

Please sign in to comment.