About Getting Started - Revision history

Peter Boot at 21:13, 29 March 2009

2009-03-29T21:13:18Z

← Older revision		Revision as of 21:13, 29 March 2009
Line 1:		Line 1:
	[[Category:Recommended Practice]]		[[Category:Recommended Practice]]
	Here we document, for the time being, arguments and decisions about the contents, the audience, the writing style etc. of the 'Getting started' document. Here is the outline of the Getting Started Document: [[Getting Started]]		Here we document, for the time being, arguments and decisions about the contents, the audience, the writing style etc. of the 'Getting started' document. Here is the outline of the Getting Started Document: [[Getting Started]]. Here are comments on the drafts: [[Getting Started Comments]]

	==Purpose==		==Purpose==

Piotr Banski: +category

2009-02-01T23:05:33Z

+category

← Older revision		Revision as of 23:05, 1 February 2009
Line 1:		Line 1:
			[[Category:Recommended Practice]]
	Here we document, for the time being, arguments and decisions about the contents, the audience, the writing style etc. of the 'Getting started' document. Here is the outline of the Getting Started Document: [[Getting Started]]		Here we document, for the time being, arguments and decisions about the contents, the audience, the writing style etc. of the 'Getting started' document. Here is the outline of the Getting Started Document: [[Getting Started]]

DavidSewell: /* Technical setup */ Sebastian's preview

2008-12-12T19:03:33Z

Technical setup: Sebastian's preview

← Older revision		Revision as of 19:03, 12 December 2008
Line 34:		Line 34:
	==Technical setup==		==Technical setup==
	* The document is stored in Subversion in SourceForge. The relevant folder is [https://tei.svn.sourceforge.net/svnroot/tei/trunk/Documents/GettingStarted https://tei.svn.sourceforge.net/svnroot/tei/trunk/Documents/GettingStarted]. There is a main document (gettingstarted.xml) that includes the separate sections using XInclude. This makes it easier for multiple people to work on the document simultaneously. Editors without SourceForge access can mail updated sections to Peter, who will then add them in SoureForge.		* The document is stored in Subversion in SourceForge. The relevant folder is [https://tei.svn.sourceforge.net/svnroot/tei/trunk/Documents/GettingStarted https://tei.svn.sourceforge.net/svnroot/tei/trunk/Documents/GettingStarted]. There is a main document (gettingstarted.xml) that includes the separate sections using XInclude. This makes it easier for multiple people to work on the document simultaneously. Editors without SourceForge access can mail updated sections to Peter, who will then add them in SoureForge.
			* Sebastian Rahtz has set up a cron job to generate [http://tei.oucs.ox.ac.uk/GettingStarted/html/ a current HTML view] of the source files (assuming they have been committed to the SourceForge repository)
	* all sections carry xml:id-attributes. As we should assume new sections will be added or sections will be moved around, top-level sections are identified using two-letter abbreviations.		* all sections carry xml:id-attributes. As we should assume new sections will be added or sections will be moved around, top-level sections are identified using two-letter abbreviations.
	* names of elements, attributes, etc are tagged using the appropriate elements from the documentation tagset (<att>, <gi>, <ident>)		* names of elements, attributes, etc are tagged using the appropriate elements from the documentation tagset (<att>, <gi>, <ident>)

DavidSewell: /* Style */ minor English-usage tweak in section about English usage :-)

2008-11-25T02:05:53Z

Style: minor English-usage tweak in section about English usage :-)

← Older revision		Revision as of 02:05, 25 November 2008
Line 27:		Line 27:
	==Style==		==Style==
	* We should try to be as clear and simple as possible. In a way, council members are not the best persons to write this document, as they may be too familiar with the technicalities to avoid terminology not immediately clear to beginners. We should be prepared to have this document reviewed by people less experienced in TEI and XML than we are.		* We should try to be as clear and simple as possible. In a way, council members are not the best persons to write this document, as they may be too familiar with the technicalities to avoid terminology not immediately clear to beginners. We should be prepared to have this document reviewed by people less experienced in TEI and XML than we are.
	* ~~Evidently~~, divisions of this document authored by non-native speakers of English should be reviewed by native speakers.		* Obviously, divisions of this document authored by non-native speakers of English should be reviewed by native speakers.

	==Media use==		==Media use==

Peter Boot: /* Technical setup */

2008-09-12T17:03:18Z

Technical setup

← Older revision		Revision as of 17:03, 12 September 2008
Line 33:		Line 33:

	==Technical setup==		==Technical setup==
	* The document is stored in Subversion in SourceForge. The relevant folder is [https://tei.svn.sourceforge.net/svnroot/tei/trunk/Documents/GettingStarted https://tei.svn.sourceforge.net/svnroot/tei/trunk/Documents/GettingStarted] There is a main document (gettingstarted.xml) that includes the separate sections using XInclude. This makes it easier for multiple people to work on the document simultaneously. Editors without SourceForge access can mail updated sections to Peter, who will then add them in SoureForge.		* The document is stored in Subversion in SourceForge. The relevant folder is [https://tei.svn.sourceforge.net/svnroot/tei/trunk/Documents/GettingStarted https://tei.svn.sourceforge.net/svnroot/tei/trunk/Documents/GettingStarted]. There is a main document (gettingstarted.xml) that includes the separate sections using XInclude. This makes it easier for multiple people to work on the document simultaneously. Editors without SourceForge access can mail updated sections to Peter, who will then add them in SoureForge.
	* all sections carry xml:id-attributes. As we should assume new sections will be added or sections will be moved around, top-level sections are identified using two-letter abbreviations.		* all sections carry xml:id-attributes. As we should assume new sections will be added or sections will be moved around, top-level sections are identified using two-letter abbreviations.
	* names of elements, attributes, etc are tagged using the appropriate elements from the documentation tagset (<att>, <gi>, <ident>)		* names of elements, attributes, etc are tagged using the appropriate elements from the documentation tagset (<att>, <gi>, <ident>)

Peter Boot: /* Technical setup */

2008-09-12T17:03:03Z

Technical setup

← Older revision		Revision as of 17:03, 12 September 2008
Line 33:		Line 33:

	==Technical setup==		==Technical setup==
	* The document is stored in Subversion in SourceForge. There is a main document (gettingstarted.xml) that includes the separate sections using XInclude. This makes it easier for multiple people to work on the document simultaneously. Editors without SourceForge access can mail updated sections to Peter, who will then add them in SoureForge.		* The document is stored in Subversion in SourceForge. The relevant folder is [https://tei.svn.sourceforge.net/svnroot/tei/trunk/Documents/GettingStarted https://tei.svn.sourceforge.net/svnroot/tei/trunk/Documents/GettingStarted] There is a main document (gettingstarted.xml) that includes the separate sections using XInclude. This makes it easier for multiple people to work on the document simultaneously. Editors without SourceForge access can mail updated sections to Peter, who will then add them in SoureForge.
	* all sections carry xml:id-attributes. As we should assume new sections will be added or sections will be moved around, top-level sections are identified using two-letter abbreviations.		* all sections carry xml:id-attributes. As we should assume new sections will be added or sections will be moved around, top-level sections are identified using two-letter abbreviations.
	* names of elements, attributes, etc are tagged using the appropriate elements from the documentation tagset (<att>, <gi>, <ident>)		* names of elements, attributes, etc are tagged using the appropriate elements from the documentation tagset (<att>, <gi>, <ident>)

Peter Boot: /* Technical setup */

2008-09-12T15:34:44Z

Technical setup

← Older revision		Revision as of 15:34, 12 September 2008
Line 38:		Line 38:
	* images are stored in a subfolder 'images' of the main Subversion folder		* images are stored in a subfolder 'images' of the main Subversion folder
	* abbreviations and other technical terms refer to entries in the Glossary using <ref> elements		* abbreviations and other technical terms refer to entries in the Glossary using <ref> elements
	* examples will be numbered by the stylesheet. We provide them with id attributes with values 'xaabbb', where 'x' is a literal, 'aa' is the section id and 'bbb' is an acronym for the example, unique in that section of the document		* examples will be numbered by the stylesheet. We provide them with id attributes with values 'xaabbb', where 'x' is a literal, 'aa' is the section id and 'bbb' is an acronym for the example, unique in that section of the document. Refer to the examples using <ptr>

Peter Boot: /* Technical setup */

2008-09-12T15:34:02Z

Technical setup

← Older revision		Revision as of 15:34, 12 September 2008
Line 37:		Line 37:
	* names of elements, attributes, etc are tagged using the appropriate elements from the documentation tagset (<att>, <gi>, <ident>)		* names of elements, attributes, etc are tagged using the appropriate elements from the documentation tagset (<att>, <gi>, <ident>)
	* images are stored in a subfolder 'images' of the main Subversion folder		* images are stored in a subfolder 'images' of the main Subversion folder
	* abbreviations refer to entries in the Glossary using <ref> elements		* abbreviations and other technical terms refer to entries in the Glossary using <ref> elements
			* examples will be numbered by the stylesheet. We provide them with id attributes with values 'xaabbb', where 'x' is a literal, 'aa' is the section id and 'bbb' is an acronym for the example, unique in that section of the document

Peter Boot: refs to glossary

2008-09-12T13:42:14Z

refs to glossary

← Older revision		Revision as of 13:42, 12 September 2008
Line 35:		Line 35:
	* The document is stored in Subversion in SourceForge. There is a main document (gettingstarted.xml) that includes the separate sections using XInclude. This makes it easier for multiple people to work on the document simultaneously. Editors without SourceForge access can mail updated sections to Peter, who will then add them in SoureForge.		* The document is stored in Subversion in SourceForge. There is a main document (gettingstarted.xml) that includes the separate sections using XInclude. This makes it easier for multiple people to work on the document simultaneously. Editors without SourceForge access can mail updated sections to Peter, who will then add them in SoureForge.
	* all sections carry xml:id-attributes. As we should assume new sections will be added or sections will be moved around, top-level sections are identified using two-letter abbreviations.		* all sections carry xml:id-attributes. As we should assume new sections will be added or sections will be moved around, top-level sections are identified using two-letter abbreviations.
	* names of elements, attributes, etc are tagged using the appropriate elements from the documentation tagset (att, gi, ident)		* names of elements, attributes, etc are tagged using the appropriate elements from the documentation tagset (<att>, <gi>, <ident>)
	* images are stored in a subfolder 'images' of the main Subversion folder		* images are stored in a subfolder 'images' of the main Subversion folder
			* abbreviations refer to entries in the Glossary using <ref> elements

Peter Boot at 11:27, 12 September 2008

2008-09-12T11:27:20Z

← Older revision		Revision as of 11:27, 12 September 2008
Line 1:		Line 1:
	Here we document, for the time being, arguments and decisions about the contents, the audience, the writing style etc. of the 'Getting started' document.		Here we document, for the time being, arguments and decisions about the contents, the audience, the writing style etc. of the 'Getting started' document. Here is the outline of the Getting Started Document: [[Getting Started]]

	==Purpose==		==Purpose==