Recommended Practices - Revision history

Syd at 18:50, 10 March 2017

2017-03-10T18:50:59Z

← Older revision		Revision as of 18:50, 10 March 2017
Line 1:		Line 1:
	[[Category:SIG:Scholarly Publishing]]		[[Category:SIG:Scholarly Publishing]]
	==Introduction==		==Introduction==

			''This is an interesting document, but who are its authors, and for whom are its recommendations made? And is there an ODD associated with it?'' --[[User:LouBurnard\|LouBurnard]] 09:36, 3 March 2011 (EST)

			: As in the page history, it was written by [[User:Reedkm\|Reedkm]], who I happen to know to be Kenneth Reed, formerly the convenor of the SIG on Scholarly Publishing. He meant it as the basis for a Customization to be developed by the SIG, as mentioned in a message to the SIG's email list. I'm unsure of whether an ODD exists in any form. ([[User:Kshawkin\|Kshawkin]] 17:51, 11 September 2012 (EDT))

	This document describes the specifications for the encoding of textual matter in accordance with the [http://www.tei-c.org/ Text Encoding Initiative]’s [http://www.tei-c.org/Guidelines/P5/ Guidelines for Text Encoding and Interchange (P5)]		This document describes the specifications for the encoding of textual matter in accordance with the [http://www.tei-c.org/ Text Encoding Initiative]’s [http://www.tei-c.org/Guidelines/P5/ Guidelines for Text Encoding and Interchange (P5)]
Line 19:		Line 23:

	This is a working document and as such assumes that further explication will be added as the need arises. Not every element nor attribute has been covered in this document, and the TEI online documentation should be able to assist in clarification. When in doubt, the authors of this document will provide updates to ensure best practices.		This is a working document and as such assumes that further explication will be added as the need arises. Not every element nor attribute has been covered in this document, and the TEI online documentation should be able to assist in clarification. When in doubt, the authors of this document will provide updates to ensure best practices.

	''This is an interesting document, but who are its authors, and for whom are its recommendations made? And is there an ODD associated with it?'' --[[User:LouBurnard\|LouBurnard]] 09:36, 3 March 2011 (EST)

	: As in the page history, it was written by [[User:Reedkm\|Reedkm]], who I happen to know to be Kenneth Reed, formerly the convenor of the SIG on Scholarly Publishing. He meant it as the basis for a Customization to be developed by the SIG, as mentioned in a message to the SIG's email list. I'm unsure of whether an ODD exists in any form. ([[User:Kshawkin\|Kshawkin]] 17:51, 11 September 2012 (EDT))

	== Unicode Characters ==		== Unicode Characters ==

Kshawkin: /* Introduction */ response to Lou asking about the context of this page

2012-09-11T21:51:02Z

Introduction: response to Lou asking about the context of this page

← Older revision		Revision as of 21:51, 11 September 2012
Line 21:		Line 21:

	''This is an interesting document, but who are its authors, and for whom are its recommendations made? And is there an ODD associated with it?'' --[[User:LouBurnard\|LouBurnard]] 09:36, 3 March 2011 (EST)		''This is an interesting document, but who are its authors, and for whom are its recommendations made? And is there an ODD associated with it?'' --[[User:LouBurnard\|LouBurnard]] 09:36, 3 March 2011 (EST)

			: As in the page history, it was written by [[User:Reedkm\|Reedkm]], who I happen to know to be Kenneth Reed, formerly the convenor of the SIG on Scholarly Publishing. He meant it as the basis for a Customization to be developed by the SIG, as mentioned in a message to the SIG's email list. I'm unsure of whether an ODD exists in any form. ([[User:Kshawkin\|Kshawkin]] 17:51, 11 September 2012 (EDT))

	== Unicode Characters ==		== Unicode Characters ==
	XML documents following these recommended practices should be stored in UTF-8 format. All non-ASCII characters should either be stored using the appropriate Unicode character or a hexadecimal entity reference to the character. Entity references are especially useful in cases of ambiguity, where a character is easily confused with another when viewed in the font in use in the XML editor.		XML documents following these recommended practices should be stored in UTF-8 format. All non-ASCII characters should either be stored using the appropriate Unicode character or a hexadecimal entity reference to the character. Entity references are especially useful in cases of ambiguity, where a character is easily confused with another when viewed in the font in use in the XML editor.

LouBurnard at 14:36, 3 March 2011

2011-03-03T14:36:20Z

← Older revision		Revision as of 14:36, 3 March 2011
Line 20:		Line 20:
	This is a working document and as such assumes that further explication will be added as the need arises. Not every element nor attribute has been covered in this document, and the TEI online documentation should be able to assist in clarification. When in doubt, the authors of this document will provide updates to ensure best practices.		This is a working document and as such assumes that further explication will be added as the need arises. Not every element nor attribute has been covered in this document, and the TEI online documentation should be able to assist in clarification. When in doubt, the authors of this document will provide updates to ensure best practices.

			''This is an interesting document, but who are its authors, and for whom are its recommendations made? And is there an ODD associated with it?'' --[[User:LouBurnard\|LouBurnard]] 09:36, 3 March 2011 (EST)
	== Unicode Characters ==		== Unicode Characters ==
	XML documents following these recommended practices should be stored in UTF-8 format. All non-ASCII characters should either be stored using the appropriate Unicode character or a hexadecimal entity reference to the character. Entity references are especially useful in cases of ambiguity, where a character is easily confused with another when viewed in the font in use in the XML editor.		XML documents following these recommended practices should be stored in UTF-8 format. All non-ASCII characters should either be stored using the appropriate Unicode character or a hexadecimal entity reference to the character. Entity references are especially useful in cases of ambiguity, where a character is easily confused with another when viewed in the font in use in the XML editor.

Piotr Banski: + cat

2010-10-19T08:20:10Z

+ cat

← Older revision		Revision as of 08:20, 19 October 2010
Line 1:		Line 1:
			[[Category:SIG:Scholarly Publishing]]
	==Introduction==		==Introduction==

Kshawkin: /* Unicode Characters */ restated to be more technically correct. I assumed decimal references are explicitly excluded, but I might have read the original too literally.

2010-06-07T02:15:10Z

Unicode Characters: restated to be more technically correct. I assumed decimal references are explicitly excluded, but I might have read the original too literally.

← Older revision		Revision as of 02:15, 7 June 2010
Line 20:		Line 20:

	== Unicode Characters ==		== Unicode Characters ==
	~~Unicode characters~~ should be ~~used throughout the document for all~~ non-ASCII ~~character references. For instance, all diacritics, quotation marks, and em dashes~~ should be Unicode ~~characters~~. ~~'''Note:''' This does not preclude~~ the use ~~of hex values. Please do use hex values if there is any confusion about~~ the ~~character~~.		XML documents following these recommended practices should be stored in UTF-8 format. All non-ASCII characters should either be stored using the appropriate Unicode character or a hexadecimal entity reference to the character. Entity references are especially useful in cases of ambiguity, where a character is easily confused with another when viewed in the font in use in the XML editor.

	The only ~~exceptions~~ are the five reserved XML entities:		Do not use decimal entity references or mnemonic entity references. The only allowed mnemonic entity references are the five reserved XML entities:

	quot double quotation mark		quot (double quotation mark)

	amp ampersand		amp (ampersand)

	apos apostrophe		apos (apostrophe)

	lt less-than sign		lt (less-than sign)

	gt greater-than sign		gt (greater-than sign)

	= TEI Structure =		= TEI Structure =

Reedkm: /* Unicode Characters */

2010-06-02T19:33:13Z

Unicode Characters

← Older revision		Revision as of 19:33, 2 June 2010
Line 25:		Line 25:

	quot double quotation mark		quot double quotation mark

	amp ampersand		amp ampersand

	apos apostrophe		apos apostrophe

	lt less-than sign		lt less-than sign

	gt greater-than sign		gt greater-than sign

Reedkm at 17:34, 2 June 2010

2010-06-02T17:34:01Z

Show changes

Reedkm: /* div */

2010-06-02T16:21:57Z

div

← Older revision		Revision as of 16:21, 2 June 2010
Line 1,237:		Line 1,237:
	<ref type="indexItem" target="indexItem1"></ref>Abolition</item>		<ref type="indexItem" target="indexItem1"></ref>Abolition</item>
	</pre>		</pre>



	~~==div==~~

	The <tt><front></tt>, <tt><body></tt>, and <tt><back></tt> elements all use the nested <tt><div></tt> structure to organize primary sections as well as child sections. The <tt><div></tt> elements are identified by a unique <tt>@xml:id</tt>, and also have an <tt>@n</tt> attribute to aid in reference. A <tt>@type</tt> attribute is also used to describe the kind of division. <tt>@type</tt> includes the following values:

	~~<table border="1">~~
	~~<tr>~~
	~~<th>Value</th>~~
	~~<th>Description</th>~~
	~~</tr>~~
	~~<tr>~~
	~~<td>copyright</td>~~
	~~<td>copyright information</td>~~
	~~</tr>~~
	~~<tr>~~
	~~<td>dedication</td>~~
	~~<td>dedication</td>~~
	~~</tr>~~
	~~<tr>~~
	~~<td>contents</td>~~
	~~<td>table of contents</td>~~
	~~</tr>~~
	~~<tr>~~
	~~<td>frontispiece</td>~~
	~~<td>frontispiece</td>~~
	~~</tr>~~
	~~<tr>~~
	~~<td>acknowledgments</td>~~
	~~<td>acknowledgments</td>~~
	~~</tr>~~
	~~<tr>~~
	~~<td>preface</td>~~
	~~<td>preface</td>~~
	~~</tr>~~
	~~<tr>~~
	~~<td>introduction</td>~~
	~~<td>frontmatter or body introduction</td>~~
	~~</tr>~~
	~~<tr>~~
	~~<td>epigraph</td>~~
	~~<td>epigraph</td>~~
	~~</tr>~~
	~~<tr>~~
	~~<td>halftitle</td>~~
	~~<td>halftitle</td>~~
	~~</tr>~~
	~~<tr>~~
	~~<td>volume</td>~~
	~~<td>volume</td>~~
	~~</tr>~~
	~~<tr>~~
	~~<td>part</td>~~
	~~<td>part</td>~~
	~~</tr>~~
	~~<tr>~~
	~~<td>chapter</td>~~
	~~<td>chapter</td>~~
	~~</tr>~~
	~~<tr>~~
	~~<td>appendix</td>~~
	~~<td>appendix</td>~~
	~~</tr>~~
	~~<tr>~~
	~~<td>endnotes</td>~~
	~~<td>endnote section</td>~~
	~~</tr>~~
	~~<tr>~~
	~~<td>glossary</td>~~
	~~<td>glossary</td>~~
	~~</tr>~~
	~~<tr>~~
	~~<td>bibliography</td>~~
	~~<td>bibliography</td>~~
	~~</tr>~~
	~~<tr>~~
	~~<td>index</td>~~
	~~<td>index</td>~~
	~~</tr>~~
	~~<tr>~~
	~~<td>colophon</td>~~
	~~<td>colophon</td>~~
	~~</tr>~~
	~~<tr>~~
	~~<td>illustrations</td>~~
	~~<td>illustrations</td>~~
	~~</tr>~~
	~~<tr>~~
	~~<td>maps</td>~~
	~~<td>maps</td>~~
	~~</tr>~~
	~~<tr>~~
	~~<td>ahead</td>~~
	~~<td>ahead</td>~~
	~~</tr>~~
	~~<tr>~~
	~~<td>bhead</td>~~
	~~<td>bhead</td>~~
	~~</tr>~~
	~~<tr>~~
	~~<td>chead</td>~~
	~~<td>chead</td>~~
	~~</tr>~~
	~~<tr>~~
	~~<td>fmhead</td>~~
	~~<td>frontmatter head</td>~~
	~~</tr>~~
	~~<tr>~~
	~~<td>bmhead</td>~~
	~~<td>backmatter head</td>~~
	~~</tr>~~
	~~<tr>~~
	~~<td>halftitle</td>~~
	~~<td>halftitle</td>~~
	~~</tr>~~
	~~<tr>~~
	~~<td>other</td>~~
	~~<td>other</td>~~
	~~</tr>~~
	~~</table>~~

	~~The examples for <tt><div></tt> elements can be found in other relevant sections.~~

Reedkm: /* text */

2010-06-02T16:21:44Z

text

← Older revision		Revision as of 16:21, 2 June 2010
Line 1,238:		Line 1,238:
	</pre>		</pre>

	~~==text==~~

	The <teiHeader> is followed directly by the mandatory <text> element, which contains the textual matter being encoded. The <text> element is broken down into three subelements: <front> for frontmatter, <body> for the main body of the work, and <back> for backmatter. Only the <body> element is required. Additionally, groups of discrete texts can be packaged together in one document using the <group> element as a parent for the separate <text> elements.

	==div==		==div==

Reedkm: /* Introduction */

2010-06-02T16:20:50Z

Introduction

← Older revision		Revision as of 16:20, 2 June 2010
Line 1:		Line 1:
	~~==Introduction==~~
	~~These recommended practices are for publishers intending to use TEI P5 as their encoding schema. They are intended to highlight features necessary for publishing both journal articles and books.~~

	==General Recommendations==		==General Recommendations==