Help:Inhoud: verschil tussen versies

Huidige versie van 3 dec 2021 om 10:11

Deze pagina biedt hulp voor auteurs van deze wiki. Voor informatie over de opbouw van de site, bezoek de project informatie pagina.

Hoe werkt?

maken nieuwe pagina

Je kunt op twee manieren een nieuwe pagina maken:

Vanuit de url balk door de nieuwe pagina in plaats van de oude te plaatsen. Er staat nu iets van http://developers.wiki.kennisnet.nl/index.php/Help:Inhoud, vervang de Help:Inhoud door de gewenste namespace en titel.
Door een wikilink naar de nieuwe pagina te maken en vervolgens daar op te klikken.

maken van links

In deze wiki bestaan een aantal typen links:

externe links: [http://www.kennisnet.nl Kennisnet] wordt Kennisnet.
interne links: [[Edurep:Hoofdpagina|De Edurep hoofdpagina]] wordt De Edurep hoofdpagina.
interne link naar een Standaard: {{Standaard|NL LOM}} wordt NL LOM.
externe link naar de Servicedesk: {{servicedesk}} wordt servicedesk.
interne link naar bestand (naar pagina): [[:Bestand:Overleg-symbol.png|pagina naar symbol]] wordt pagina naar symbol
interne link naar bestand (rechtstreeks): [[Media:Overleg-symbol.png|symbol]] wordt symbol

gebruik van sjablonen

Sjablonen worden gebruikt om een veelgebruikt pagina element te standaardiseren en eenvoudig te herbruiken. Een voorbeeld hiervan is de eerdergenoemde link naar een Standaard. Bekijk de verzameling sjablonen om een idee te krijgen wat mogelijk is.

Elk opmaak slabloon beschrijft hoe het sjabloon gebruikt dient te worden met een voorbeeld. Wanneer je alsnog twijfelt over het correcte gebruik van het sjabloon, bekijk de bron en bekijk onderaan de pagina een van de pagina's waarop het sjabloon reeds is gebruikt voor een voorbeeld.

toekennen van een categorie

Het is de bedoeling dat elke pagina (niet-subpagina) een of meer categoriën krijgt. Voor artikelen betekent dit meestal dat de pagina een categorie krijgt van de dienst en een categorie voor het documenttype. Subpagina's hebben geen categorie omdat ze altijd gelinkt worden van een ouderpagina.

Een categorie wordt toegekend onderaan de tekst van het artikel door een interne link te maken naar de categorie. Bijvoorbeeld het toekennen van een artikel aan de Kennisnet Federatie categorie: [[Categorie:Kennisnet Federatie]]

een eenvoudige tabel

Een basis tabel is vrij makkelijk om te maken, een "-" definieert een rij, en elke kolom wordt gerepresenteerd door een "|" op een nieuwe regel. Gebruik een "!" in plaats van een "|" om een header te definieren:

 {| class="wikitable"
 |-
 ! kolom 1
 ! kolom 2
 |-
 | content x
 | content y
 |-
 |}

wordt:

kolom 1	kolom 2
content x	content y

Bekijk de Mediawiki documentatie voor meer informatie.

het kleuren van broncode

Wanneer er bepaalde broncode in een artikel wordt vermeld, kan dit gekleurd worden weergegeven volgens de stijl van de taal in kwestie. Een overzicht van ondersteunde talen is te vinden op de extensie homepage. Gebruik de enclose="div" om een pagewrap te forceren. Om bijvoorbeeld een stuk xml te "highlighten", gebruik:

<syntaxhighlight lang="xml" enclose="div">
<voorbeeld>
  <code lang="none">1</code>
</voorbeeld>
</syntaxhighlight>

Dit wordt dan als volgt afgebeeld:

<voorbeeld>
  <code lang="none">1</code>
</voorbeeld>

Verschillende Talen

In deze wiki is het mogelijk om artikelen in het Engels te maken. Het uitgangspunt is echter Nederlands, dit betekent dat voor elk Engels artikel eerst een Nederlandse versie moet bestaan.

Alleen artikelen binnen de Kennisnet Federatie ondersteunen Engelse artikelen.

Om een Engels artikel te maken, zet men het volgende bovenaan in de Nederlandse versie. Na opslaan verschijnt er nu een link naar de Engelse variant van de pagina.

{{Talen}}

Bovenaan de Engels variant zet men het volgende sjabloon om een Engelse titel mogelijk te maken:

{{PageTitleCustom|title=Authentication|name=Kennisnet Federation|image=true|imageurl=KNF:Hoofdpagina/en}}

Uploaden Bestanden

Elke geregistreerde gebruiker mag ook bestanden uploaden ter referentie in de Wiki. Niet alle typen bestanden mogen momenteel geüpload worden. Merk je dat een bestand niet upload en denk je wel dat dit zou moeten kunnen? Laat dit dan even aan de beheerder weten.

Om te voorkomen dat het een grote puinhoop wordt in de bestandenlijst, verzoek ik elke uploader om de bestandscategorie van de diensten toe te voegen. Voor Edurep is dit [[Categorie:Bestanden Edurep]], voor Standaarden is dit [[Categorie:Bestanden Standaarden]], etc.

Inloggen

Je kunt als Kennisnet medewerker inloggen met je Kennisnet gebruikersnaam en wachtwoord. Je accountnaam op deze wiki is hetzelfde als je inlognaam (achternaamXX), zonder domein of emailadres.

Iets anders wat betreft tekst formatting

Niet alle mogelijke Mediawiki formatting staat hier beschreven. Echter, Mediawiki zelf heeft hier een uitgebreid overzicht van gemaakt.

Transclude

Met transcludes kun je pagina's of delen van pagina's includen in een andere pagina.

Wellicht heb je meerdere API versies met overal dezelfde beschrijving van foutmeldingen. Je kunt dan 1 foutmeldingen pagina maken en die op elke API pagina includen zodat je bij updates slechts 1 pagina hoeft te updaten.

In de Edurep namespace wordt veel gebruik gemaakt van transcludes, bijvoorbeeld:

Edurep:Foutmeldingen/SRU wordt gebruikt in:

Namespaces en Rechten

Elke pagina wordt aangemaakt in een specifieke "namespace"; de groep waarbinnen de pagina valt. Je kunt de namespace herkennen aan het woord van voor de dubbele punt staat in url van de pagina titel. De namespace van deze pagina is Help maar deze wiki kent bijvoorbeeld ook de Standaarden en de Eduroam namespaces.

Als gebruiker heb je rechten om in bepaalde namespaces bewerkingen te maken. Pas als je rechten hebt om in artikelen in een namespace te bewerken, verschijnt de "Bewerken" knop in de artikel opties. Zoniet dan kun je alleen de bron bekijken.

Subpagina's

Een subpagina is net als een namespace of een categorie een manier om informatie op de wiki te structureren. Subpagina's worden gebruikt bij een artikel waar relatief veel direct gerelateerde informatie is. Een duidelijk voorbeeld hiervan is de NL LOM, waarbij informatie over individuele velden als subpagina's zijn beschreven. De hoofdpagina is in dit geval "NL LOM" terwijl een subpagina bijvoorbeeld de volgende titel heeft "NL LOM/lom.general.title".

Op een subpagina wordt in de titel van het de pagina teruggelinkt naar de ouderpagina. Op de hoofdpagina kan regulier een interne link naar een subpagina worden geplaatst, maar je kan ook een automatisch overzicht van subpagina's genereren met het volgende commando: {{Special:PrefixIndex/{{FULLPAGENAME}}/}}.

@@ Regel 5: / Regel 5: @@
 === maken nieuwe pagina ===
 Je kunt op twee manieren een nieuwe pagina maken:
-# Vanuit de url balk door de nieuwe pagina in plaats van de oude te plaatsen.
+# Vanuit de url balk door de nieuwe pagina in plaats van de oude te plaatsen. Er staat nu iets van ''<nowiki>http://developers.wiki.kennisnet.nl/index.php/Help:Inhoud</nowiki>'', vervang de ''Help:Inhoud'' door de gewenste namespace en titel.
-# Door een wikilink naar de nieuwe pagina te maken en vervolgens er naar toe gaan.
+# Door een wikilink naar de nieuwe pagina te maken en vervolgens daar op te klikken.
 === maken van links ===
-In deze wiki bestaan drie typen links:
+In deze wiki bestaan een aantal typen links:
 * externe links: <nowiki>[http://www.kennisnet.nl Kennisnet]</nowiki> wordt [http://www.kennisnet.nl Kennisnet].
 * interne links: <nowiki>[[Edurep:Hoofdpagina|De Edurep hoofdpagina]]</nowiki> wordt [[Edurep:Hoofdpagina|De Edurep hoofdpagina]].
 * interne link naar een Standaard: <nowiki>{{Standaard|NL LOM}}</nowiki> wordt {{Standaard|NL LOM}}.
+* externe link naar de Servicedesk: <nowiki>{{servicedesk}}</nowiki> wordt {{servicedesk}}.
+* interne link naar bestand (naar pagina): <nowiki>[[:Bestand:Overleg-symbol.png|pagina naar symbol]]</nowiki> wordt [[:Bestand:Overleg-symbol.png|pagina naar symbol]]
+* interne link naar bestand (rechtstreeks): <nowiki>[[Media:Overleg-symbol.png|symbol]]</nowiki> wordt [[Media:Overleg-symbol.png|symbol]]
+=== gebruik van sjablonen ===
+Sjablonen worden gebruikt om een veelgebruikt pagina element te standaardiseren en eenvoudig te herbruiken. Een voorbeeld hiervan is de eerdergenoemde [[Sjabloon:Standaard|link naar een Standaard]]. Bekijk de [[:Categorie:Opmaak Sjablonen|verzameling sjablonen]] om een idee te krijgen wat mogelijk is.
+Elk opmaak slabloon beschrijft hoe het sjabloon gebruikt dient te worden met een voorbeeld. Wanneer je alsnog twijfelt over het correcte gebruik van het sjabloon, bekijk de bron en bekijk onderaan de pagina een van de pagina's waarop het sjabloon reeds is gebruikt voor een voorbeeld.
+=== toekennen van een categorie ===
+Het is de bedoeling dat elke pagina (niet-subpagina) een of meer categoriën krijgt. Voor artikelen betekent dit meestal dat de pagina een categorie krijgt van de [[:Categorie:Diensten|dienst]] en een categorie voor het [[:Categorie:Documenttypes|documenttype]]. Subpagina's hebben geen categorie omdat ze altijd gelinkt worden van een ouderpagina.
+Een categorie wordt toegekend onderaan de tekst van het artikel door een interne link te maken naar de categorie. Bijvoorbeeld het toekennen van een artikel aan de Kennisnet Federatie categorie: <nowiki>[[Categorie:Kennisnet Federatie]]</nowiki>
+=== een eenvoudige tabel ===
+Een basis tabel is vrij makkelijk om te maken, een "-" definieert een rij, en elke kolom wordt gerepresenteerd door een "|" op een nieuwe regel. Gebruik een "!" in plaats van een "|" om een header te definieren:
+<pre>
+ {| class="wikitable"
+ |-
+ ! kolom 1
+ ! kolom 2
+ |-
+ | content x
+ | content y
+ |-
+ |}
+</pre>
+wordt:
+{| class="wikitable"
+|-
+! kolom 1
+! kolom 2
+|-
+| content x
+| content y
+|-
+|}
+Bekijk de [http://www.mediawiki.org/wiki/Help:Tables Mediawiki documentatie] voor meer informatie.
+=== het kleuren van broncode ===
+Wanneer er bepaalde broncode in een artikel wordt vermeld, kan dit gekleurd worden weergegeven volgens de stijl van de taal in kwestie. Een overzicht van [http://www.mediawiki.org/wiki/Extension:SyntaxHighlight_GeSHi#Supported_languages ondersteunde talen] is te vinden op de extensie homepage. Gebruik de enclose="div" om een pagewrap te forceren. Om bijvoorbeeld een stuk xml te "highlighten", gebruik:
+<pre><nowiki>
+<syntaxhighlight lang="xml" enclose="div">
+<voorbeeld>
+  <code lang="none">1</code>
+</voorbeeld>
+</syntaxhighlight>
+</nowiki></pre>
+Dit wordt dan als volgt afgebeeld:
+<syntaxhighlight lang="xml">
+<voorbeeld>
+  <code lang="none">1</code>
+</voorbeeld>
+</syntaxhighlight>
+=== Verschillende Talen ===
+In deze wiki is het mogelijk om artikelen in het Engels te maken. Het uitgangspunt is echter Nederlands, dit betekent dat voor elk Engels artikel eerst een Nederlandse versie moet bestaan.
+{{Info|Alleen artikelen binnen de Kennisnet Federatie ondersteunen Engelse artikelen.}}
+Om een Engels artikel te maken, zet men het volgende bovenaan in de Nederlandse versie. Na opslaan verschijnt er nu een link naar de Engelse variant van de pagina.
+ <nowiki>{{Talen}}</nowiki>
+Bovenaan de Engels variant zet men het volgende sjabloon om een Engelse titel mogelijk te maken:
+ <nowiki>{{PageTitleCustom|title=Authentication|name=Kennisnet Federation|image=true|imageurl=KNF:Hoofdpagina/en}}</nowiki>
+=== Uploaden Bestanden ===
+Elke geregistreerde gebruiker mag ook bestanden uploaden ter referentie in de Wiki. Niet alle typen bestanden mogen momenteel geüpload worden. Merk je dat een bestand niet upload en denk je wel dat dit zou moeten kunnen? Laat dit dan even aan de beheerder weten.
+Om te voorkomen dat het een grote puinhoop wordt in de bestandenlijst, verzoek ik elke uploader om de bestandscategorie van de diensten toe te voegen. Voor Edurep is dit <nowiki>[[Categorie:Bestanden Edurep]]</nowiki>, voor Standaarden is dit <nowiki>[[Categorie:Bestanden Standaarden]]</nowiki>, etc.
+=== Inloggen ===
+Je kunt als Kennisnet medewerker inloggen met je Kennisnet gebruikersnaam en wachtwoord. Je accountnaam op deze wiki is hetzelfde als je inlognaam (achternaamXX), zonder domein of emailadres.
+=== Iets anders wat betreft tekst formatting ===
+Niet alle mogelijke Mediawiki formatting staat hier beschreven. Echter, Mediawiki zelf heeft hier een [http://www.mediawiki.org/wiki/Help:Formatting uitgebreid overzicht] van gemaakt.
+=== Transclude ===
+Met [https://www.mediawiki.org/wiki/Transclusion transcludes] kun je pagina's of delen van pagina's includen in een andere pagina.
+Wellicht heb je meerdere API versies met overal dezelfde beschrijving van foutmeldingen. Je kunt dan 1 foutmeldingen pagina maken en die op elke API pagina includen zodat je bij updates slechts 1 pagina hoeft te updaten.
+In de Edurep namespace wordt veel gebruik gemaakt van transcludes, bijvoorbeeld:
+* [[Edurep:Foutmeldingen/SRU]] wordt gebruikt in:
+** [[Edurep:LOM_SearchRetrieve#Foutmeldingen]]
+** [[Edurep:SMO_SearchRetrieve#Foutmeldingen]]
+** [[CS:Entry_SearchRetrieve#Foutmeldingen]]
+== Namespaces en Rechten ==
+Elke pagina wordt aangemaakt in een specifieke "namespace"; de groep waarbinnen de pagina valt. Je kunt de namespace herkennen aan het woord van voor de dubbele punt staat in url van de pagina titel. De namespace van deze pagina is Help maar deze wiki kent bijvoorbeeld ook de Standaarden en de Eduroam namespaces.
+Als gebruiker heb je rechten om in bepaalde namespaces bewerkingen te maken. Pas als je rechten hebt om in artikelen in een namespace te bewerken, verschijnt de "Bewerken" knop in de artikel opties. Zoniet dan kun je alleen de bron bekijken.
+== Subpagina's ==
+Een subpagina is net als een namespace of een categorie een manier om informatie op de wiki te structureren. Subpagina's worden gebruikt bij een artikel waar relatief veel direct gerelateerde informatie is. Een duidelijk voorbeeld hiervan is de {{Standaard|NL LOM}}, waarbij informatie over individuele velden als subpagina's zijn beschreven. De hoofdpagina is in dit geval "NL LOM" terwijl een subpagina bijvoorbeeld de volgende titel heeft "NL LOM/lom.general.title".
+Op een subpagina wordt in de titel van het de pagina teruggelinkt naar de ouderpagina. Op de hoofdpagina kan regulier een interne link naar een subpagina worden geplaatst, maar je kan ook een automatisch overzicht van subpagina's genereren met het volgende commando: <nowiki>{{Special:PrefixIndex/{{FULLPAGENAME}}/}}</nowiki>.