Set-up

Uitgangspunten

• Alle documentatie wordt geschreven in het Engels. • Alle documentatie komt in een wiki. • De documentatie bevat zoveel mogelijk knip-en-plakbare voorbeelden. • De documentatie verwijst zoveel mogelijk naar bestanden waarin het betreffende verschijnsel wordt geïllustreerd, inclusief de weergave ervan. • Vanwege de vertrouwelijkheid van het AF project, en omdat het project bijna is afgerond, laten we AF hier voorlopig buiten.

XML-codering bij Huygens ING

Hier gaat het om een systematische beschrijving van de codering, inclusief beschrijving van de redenen en achtergronden. Bijeenbehorende elementen kunnen samen worden beschreven. De beschrijving wordt zoveel mogelijk voorzien van codeervoorbeelden. De gewenste (algemene) weergave wordt hier ook beschreven, in tekst en voorzien van illustraties / live link naar de werkende editie als die beschikbaar zijn.

Inhoud 1. XML, XML schema’s, XML namespaces 2. Subversion 3. Globale indeling XML/TEI bestand 4. TEI header 5. Teksthiërarchie 6. Transcriptie 7. Annotatie 8. Vertaling 9. Tekstvergelijking 10. Secundaire bestanden

Onderhouden door: Peter

Wat komt hierin terecht: algemene delen van Encoding Mondrian algemene delen van Afspraken codering dagboeken AF algemene delen van Richtlijnen MVN digitaal

XML-codering bij specifiek project

Per project komt er zo’n document. Het geeft aan waar een project van de algemene standaard afwijkt of de algemene standaard uitbreidt. De beschrijving is geeft ook een toelichting waarom bepaalde keuzen zijn gemaakt. Kan ook meer algemene overwegingen bevatten die vooruitlopen op de voor het eindproduct te schrijven verantwoording.

Inhoud Bevat projectspecifieke invullingen en aanpassingen van de algemene afspraken over XML-codering, bijvoorbeeld over: • aantal XML bestanden (1 bestand voor project of 1 bestand per brief, etc.) • naamgeving van bestanden • wel of niet te gebruiken attributen • specifieke attribuutwaarden

Onderhouden door: Peter en PL van project

Wat komt hierin terecht: Specifieke delen van Encoding Mondrian Specifieke delen van Afspraken codering dagboeken AF Specifieke delen van Richtlijnen MVN digitaal Delen van Tekstbezorging en annotatie (Mondriaan)

Concrete codeerrichtlijn

Inhoud: Per tekstueel verschijnsel geeft dit document de bedoelde codering, met afwijkingen voor bepaalde projecten. Verwijst zoveel mogelijk naar de systematische documenten (1 en 2).

Onderhouden door: allen

Wat komt hierin: Aanwijzingen transcriptie (Mondriaan)

Handleidingen

Inhoud: Handleidingen Subversion, oXygen, en eventueel andere hulpmiddelen

Onderhouden door: auteurs/allen

Opzet XML documentatie Huygens

Inhoud: Dit document Handleiding onderhouden wiki-pagina’s

Onderhouden door: Peter

Adhoc documenten

Voor zover betrekking hebbend op gebruik XML.

Inhoud: Zoals bijvoorbeeld Marlein’s inventarisatie, Overzicht te coderen elementen. Een ad-hoc document is geen vervanging voor systematische documentatie. In het algemeen zal een ad-hoc document tijdelijk van aard zijn. Het kan wel van belang zijn o het te delen met anderen.