Difference between revisions of "Set-up"
(Created page with "===Uitgangspunten=== • Alle documentatie wordt geschreven in het Engels. • Alle documentatie komt in een wiki. • De documentatie bevat zoveel mogelijk knip-en-plakbare...") |
|||
| Line 1: | Line 1: | ||
| − | === | + | ===Basic principles=== |
| − | + | * All documentation will be written in English. | |
| − | + | * All documentation will be put into a wiki. | |
| − | + | * All documentation contains as many copy-paste examples as possible. | |
| − | + | * All documentation will refer to as many files illustrating and displaying the discussed phenomenon as possible. | |
| − | + | * Due to the confidentiality of the AF project, and also because the project has almost come to an end, we temporarily won't involve AF. | |
| − | ==XML | + | ==XML encoding at the Huygens ING== |
| − | + | Contains a systematical description of encoding, including descriptions on the reasons and backgrounds. Corresponding elements can be described together. The description must contain as much encoding examples as possible. The desired (general) reproduction will be described and illustrated as well. When possible, a live link to a working edition should be provided. | |
| − | + | '''Content''' | |
| − | + | # [[About XM|XML, XML schema’s, XML namespaces]] | |
| − | + | # [[Subversion]] | |
| − | + | # [[Global division of the XML/TEI file|Globale indeling XML/TEI bestand]] | |
| − | + | # [[TEI Header]] | |
| − | + | # [[Textual hierarchy|Teksthiërarchie]] | |
| − | + | # [[Transcription|Transcriptie]] | |
| − | + | # [[Annotation|Annotatie]] | |
| − | + | # [[Translation|Vertaling]] | |
| − | + | # Tekstvergelijking | |
| − | + | # [[Secondary files|Secundaire bestanden]] | |
| − | + | '''Maintained by''': Peter | |
| − | + | Containing: | |
| − | + | * General parts of 'Encoding Mondrian' | |
| − | + | * General parts of 'Afspraken codering dagboeken AF' | |
| − | + | * General parts of 'Richtlijnen MVN digitaal' | |
| − | + | '''Wiki''': [[XML Huygens]] | |
| − | + | ||
| − | + | ==XML encoding for specific project== | |
| + | Every project will have its own document that shows where the project deviates from the common standard and that explains why certain choices are made. Can also contain more general considerations anticipating the justification for the final product. | ||
| + | |||
| + | '''Content''': | ||
Bevat projectspecifieke invullingen en aanpassingen van de algemene afspraken over XML-codering, bijvoorbeeld over: | Bevat projectspecifieke invullingen en aanpassingen van de algemene afspraken over XML-codering, bijvoorbeeld over: | ||
| − | + | Contains interpretations and adaptations of the common agreements on XML endocing specific to the project, about for example: | |
| − | + | * The number of XML files (1 file for the whole project, 1 file per letter etc.) | |
| − | + | * Naming files | |
| − | + | * Whether or not to use certain attributes | |
| + | * Specific values of attributes | ||
| + | |||
| + | '''Maintained by''': Peter and the project leader of the specific project | ||
| − | + | '''Wikis''': | |
| + | * [[XML Mondrian Guidelines]] | ||
| + | * [[XML MVN Guidelines]] | ||
| − | + | '''Containing''': | |
| − | + | * Specific parts of 'Encoding Mondrian' | |
| − | + | * Specific parts of 'Afspraken codering dagboeken AF' | |
| − | + | * Specific parts of 'Richtlijnen MVN digitaal' | |
| − | + | * Parts of 'Tekstbezorging en annotatie (Mondriaan)' | |
==Concrete codeerrichtlijn== | ==Concrete codeerrichtlijn== | ||
Revision as of 12:33, 9 February 2017
Contents
Basic principles
- All documentation will be written in English.
- All documentation will be put into a wiki.
- All documentation contains as many copy-paste examples as possible.
- All documentation will refer to as many files illustrating and displaying the discussed phenomenon as possible.
- Due to the confidentiality of the AF project, and also because the project has almost come to an end, we temporarily won't involve AF.
XML encoding at the Huygens ING
Contains a systematical description of encoding, including descriptions on the reasons and backgrounds. Corresponding elements can be described together. The description must contain as much encoding examples as possible. The desired (general) reproduction will be described and illustrated as well. When possible, a live link to a working edition should be provided.
Content
- XML, XML schema’s, XML namespaces
- Subversion
- Globale indeling XML/TEI bestand
- TEI Header
- Teksthiërarchie
- Transcriptie
- Annotatie
- Vertaling
- Tekstvergelijking
- Secundaire bestanden
Maintained by: Peter
Containing:
- General parts of 'Encoding Mondrian'
- General parts of 'Afspraken codering dagboeken AF'
- General parts of 'Richtlijnen MVN digitaal'
Wiki: XML Huygens
XML encoding for specific project
Every project will have its own document that shows where the project deviates from the common standard and that explains why certain choices are made. Can also contain more general considerations anticipating the justification for the final product.
Content: Bevat projectspecifieke invullingen en aanpassingen van de algemene afspraken over XML-codering, bijvoorbeeld over: Contains interpretations and adaptations of the common agreements on XML endocing specific to the project, about for example:
- The number of XML files (1 file for the whole project, 1 file per letter etc.)
- Naming files
- Whether or not to use certain attributes
- Specific values of attributes
Maintained by: Peter and the project leader of the specific project
Wikis:
Containing:
- Specific parts of 'Encoding Mondrian'
- Specific parts of 'Afspraken codering dagboeken AF'
- Specific parts of 'Richtlijnen MVN digitaal'
- Parts of '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.
