Ways to Publish TEI on the Web - Revision history

Stuartyeates at 19:52, 24 April 2010

2010-04-24T19:52:58Z

Stuartyeates at 19:46, 24 April 2010

2010-04-24T19:46:59Z

Stuartyeates at 11:12, 24 April 2010

2010-04-24T11:12:14Z

Brettz9: minor clean-up

2010-04-24T06:39:28Z

minor clean-up

Brettz9: /* Ensuring Google can index your content */

2010-04-24T06:37:12Z

‎Ensuring Google can index your content

Brettz9: minor clean-up

2010-04-24T06:36:38Z

minor clean-up

Brettz9: more minor clean-up

2010-04-24T06:35:00Z

more minor clean-up

Brettz9: minor clean-up

2010-04-24T06:32:27Z

minor clean-up

Dmccreary: /* Presentation of content */

2010-04-24T01:05:58Z

‎Presentation of content

Dmccreary: /* Presentation of content */

2010-04-24T01:04:48Z

‎Presentation of content

@@ Line 42: / Line 42: @@
 ! Cons
 ! Skills needed
-! Searching possible
+! Intra-site searching possible
 ! Dynamic KWIC etc., possible
 ! Examples
@@ Line 70: / Line 70: @@
+|
 |-
-| Single web page from (single TEI file + single XSL file)
+| Single web page from (single TEI file + single XSL file); either pre-generated or dynamically
 | A web page like any other.
 | Because TEI is hidden, third party re-purposing or validation is impossible
@@ Line 78: / Line 78: @@
+|
 |-
-| Single web page from (single TEI file + single XSL file) + TEI file
+| Single web page from (single TEI file + single XSL file); either pre-generated or dynamically
-| A web page like any other, but a link to web
+| A web page like any other, but a link exposing the underlying TEI file
+|
 |  TEI, XSLT
@@ Line 86: / Line 86: @@
+|
 |-
-| Multiple web page from (multiple TEI files + xinclude + XSL file(s) ) + TEI files
+| Multiple web page from (multiple TEI files + xinclude + XSL file(s) )
-| A web page like any other, but a link to web
+| A web page like any other, but a link exposing the underlying TEI files
 | Multiple files enable large, complex structures and corpora
 |  TEI, XSLT, [[XPointer]]
@@ Line 110: / Line 110: @@
 | [http://history.state.gov/ U.S. State Department]
 |-
-| Multiple TEI files in post-relational (SQL) database + XSL conversion of fragments to HTML
+| Multiple TEI files in post-relational (postgres, mysql, etc) database + XSL conversion of fragments to HTML
 | Makes inter-linking with other information sources easy
 | Requires own server (real or virtual)

@@ Line 57: / Line 57: @@
 | Just need to import a CSS file into XHTML and write a rule for text to be displayed
 | Can not reorder tags/Meaningless to many search engines
-| CSS
+| TEI, CSS
 | No
 | No
@@ Line 64: / Line 64: @@
 | Single TEI file + XSL Processing Instruction (PI)
 | Very simple two-file solution
-| Some obscure XSLT features not supported by all browsers
+| Some obscure XSLT features not supported by all browsers, can be slow for large files.
-| XML, TEI, [[XSLT]]
+|  TEI, [[XSLT]]
 | No
 | No
@@ Line 73: / Line 73: @@
 | A web page like any other.
 | Because TEI is hidden, third party re-purposing or validation is impossible
-| XML, TEI, XSLT
+|  TEI, XSLT
 | No
 | No
@@ Line 81: / Line 81: @@
 | A web page like any other, but a link to web
+|
-| XML, TEI, XSLT
+|  TEI, XSLT
 | No
 | No
@@ Line 89: / Line 89: @@
 | A web page like any other, but a link to web
 | Multiple files enable large, complex structures and corpora
-| XML, TEI, XSLT, [[XPointer]]
+|  TEI, XSLT, [[XPointer]]
 | No
 | No
@@ Line 97: / Line 97: @@
 | Native XML database means no shredding XML into tables, and rapid fulltext query across some/all TEI files; built-in full-featured web server with URL rewriting for cool URLs; cross platform
 | Requires own server (real or virtual)
-| XML, TEI, XSLT
+|  TEI, XSLT
 | Yes
 | Yes
@@ Line 105: / Line 105: @@
 | Native XML database means no shredding XML into tables, and rapid fulltext query across some/all TEI files; built-in full-featured web server with URL rewriting for cool URLs; cross platform
 | Requires own server (real or virtual) or hosted eXist solution
-| XML, TEI, [[XQuery]]
+|  TEI, [[XQuery]]
 | Yes
 | Yes
 | [http://history.state.gov/ U.S. State Department]
 |-
 | Multiple TEI files in post-relational (SQL) database + XSL conversion of fragments to HTML
 | Makes inter-linking with other information sources easy
 | Requires own server (real or virtual)
-| XML, TEI, XSLT, SQL
+| TEI, XSLT, SQL
 | Yes
 | No (in theory yes, but hard)
@@ Line 122: / Line 121: @@
 | Can use XQuery for HTML rendering
 | XQuery must be embedded inside SQL.
-| XML, TEI, XQuery
+|  TEI, XQuery
 | Yes
 | No (in theory yes, but hard)

@@ Line 26: / Line 26: @@
 === Ensuring Google can index your content ===
 If the findability of your content on popular search engines is important to you, there are a couple of points to bear in mind.
-* Use short, sane URLs, unique before the options and search terms (for a counter-example see http://www.nzdl.org/niupepa which is not findable by Google). This means that if you're using a database to present your TEI, the core texts should be reachable by browsing simple URLs rather than entering search terms.
+* Use short, sane URLs, unique before the options and search terms (for a counter-example see http://www.nzdl.org/niupepa whose content is not findable by Google). This means that if you're using a database to present your TEI, the core texts should be reachable by browsing simple URLs rather than entering search terms, and should be findable at urls that are unique prior to any '?' in the URL.
 * Use quality meta-data in the generated HTML
 * If you have a page about "Nouns in Klingon" then the string "Nouns in Klingon" should occur in the HTML <title> tag, a dc.title <meta> tag and in a <nowiki><h1></nowiki>, <nowiki><h2></nowiki> or <nowiki><h3></nowiki> tag on the page. Preferably it should be mentioned in the text too.  It should appear in language you're wanting people to be able to search in (English, Klingon, etc.)
-* You should try not to move the content around. This will confuse both google and normal people who've bookmarked it.
+* You should try not to move the content around. This will confuse both google and normal people who've bookmarked it. See also [http://www.w3.org/TR/cooluris/ http://www.w3.org/TR/cooluris/]
 Here are two separate tables, one describing the form of the content presented on the web, the other describing how that might be hosted:

@@ Line 128: / Line 128: @@
 |}
-Remember that for polished websites at least some CSS (Cascading StyleSheets) skills are going to required. For pages with at least some dynamism (drop down menus, expanding sections, etc.), a little javascript skill goes a long way.
+Remember that for polished websites at least some CSS (Cascading StyleSheets) skills are going to required. For pages with at least some dynamism (drop down menus, expanding sections, etc.), a little JavaScript skill goes a long way.
 = Hosting of Content =
@@ Line 161: / Line 161: @@
 |}
-Many service-oriented TEI publishers have (at least) a pair of servers, with a development server that is used for testing new developments and can also be pressed into service to replace the primary (or live) server should it develop a fault. This gives these publishers fault-tolerance. Such systems are significantly easier to construct with the flexibility virtual servers.
+Many service-oriented TEI publishers have (at least) a pair of servers with a development server that is used for testing new developments and can also be pressed into service to replace the primary (or live) server should it develop a fault. This gives these publishers fault-tolerance. Such systems are significantly easier to construct with the flexibility virtual servers.
 [[Category:?]]

@@ Line 31: / Line 31: @@
 * You should try not to move the content around. This will confuse both google and normal people who've bookmarked it.
-Here are two separate tables, one describes the form of the content presented on the web, the other describes how that might be hosted:
+Here are two separate tables, one describing the form of the content presented on the web, the other describing how that might be hosted:
 = Presentation of content =

@@ Line 4: / Line 4: @@
 The root URL of your published TEI needs to be consistent, but to enable Google searching and to allow uses to re-find your content.  The URL can also be an important part of the branding of your effort.
-* Some efforts choose to be in sub-domains of academic institutions ( http://epidoc.cch.kcl.ac.uk/inscriptions/index.html , http://www.ota.ox.ac.uk/ , etc) these sub-domains are typically free and brand the published TEI with the institutions identity.
+* Some efforts choose to be in sub-domains of academic institutions ( http://epidoc.cch.kcl.ac.uk/inscriptions/index.html , http://www.ota.ox.ac.uk/ , etc.) these sub-domains are typically free and brand the published TEI with the institutions identity.
 * Others choose to have their own domains (http://papyri.info/idp_static/current/ http://www.freedict.org/) these are most commonly cross-institutional collaborations, these domains typically cost a small amount of money to register and maintain.
 * Some hosted services (e.g., Google sites) have their own fixed domain that users get little or no say in.
@@ Line 20: / Line 20: @@
 Advantages of the multiple file approach include:
 * Files sizes kept within the range of conventional editors
-* Finer-grained operations (updating, indexing, version control, etc) possible,
+* Finer-grained operations (updating, indexing, version control, etc.) possible,
 * Better for for multi-person teams as different people can work on different documents
 * Allows explicit division of TEI into logical units for processing and distribution.
@@ Line 27: / Line 27: @@
 If the findability of your content on popular search engines is important to you, there are a couple of points to bear in mind.
 * Use short, sane URLs, unique before the options and search terms (for a counter-example see http://www.nzdl.org/niupepa which is not findable by Google). This means that if you're using a database to present your TEI, the core texts should be reachable by browsing simple URLs rather than entering search terms.
-* Use quality meta-data in the generated the HTML
+* Use quality meta-data in the generated HTML
-* If you have a page about "Nouns in Klingon" then the string "Nouns in Klingon" should occur in the HTML <title> tag, a dc.title <meta> tag and in a <nowiki><h1></nowiki>, <nowiki><h2></nowiki> or <nowiki><h3></nowiki> tag on the page. Preferably it should be mentioned in the text too.  It should appear in language you're wanting people to be able to search in (English, Klingon, etc)
+* If you have a page about "Nouns in Klingon" then the string "Nouns in Klingon" should occur in the HTML <title> tag, a dc.title <meta> tag and in a <nowiki><h1></nowiki>, <nowiki><h2></nowiki> or <nowiki><h3></nowiki> tag on the page. Preferably it should be mentioned in the text too.  It should appear in language you're wanting people to be able to search in (English, Klingon, etc.)
 * You should try not to move the content around. This will confuse both google and normal people who've bookmarked it.
@@ Line 43: / Line 43: @@
 ! Skills needed
 ! Searching possible
-! Dynamic KWIC etc, possible
+! Dynamic KWIC etc., possible
 ! Examples
 |-
@@ Line 128: / Line 128: @@
 |}
-Remember that for polished websites at least some CSS (Cascading StyleSheets) skills are going to required. For pages with at least some dynamism (drop down menus, expanding sections, etc), a little javascript skill goes a long way.
+Remember that for polished websites at least some CSS (Cascading StyleSheets) skills are going to required. For pages with at least some dynamism (drop down menus, expanding sections, etc.), a little javascript skill goes a long way.
 = Hosting of Content =

@@ Line 3: / Line 3: @@
 ===Domains===
-The root url of your published TEI needs to be consistent, but to enable google searching and to allow uses to re-find your content.  The URL can also be an important part of the branding of your effort.
+The root URL of your published TEI needs to be consistent, but to enable Google searching and to allow uses to re-find your content.  The URL can also be an important part of the branding of your effort.
-* Some efforts choose to be in subdomains of academic institutions ( http://epidoc.cch.kcl.ac.uk/inscriptions/index.html , http://www.ota.ox.ac.uk/ , etc) these subdomains are typically free and brand the published TEI with the institutions identity.
+* Some efforts choose to be in sub-domains of academic institutions ( http://epidoc.cch.kcl.ac.uk/inscriptions/index.html , http://www.ota.ox.ac.uk/ , etc) these sub-domains are typically free and brand the published TEI with the institutions identity.
 * Others choose to have their own domains (http://papyri.info/idp_static/current/ http://www.freedict.org/) these are most commonly cross-institutional collaborations, these domains typically cost a small amount of money to register and maintain.
-* Some hosted services (i.e. google sites) have their own fixed domain that users get little or no say in.
+* Some hosted services (e.g., Google sites) have their own fixed domain that users get little or no say in.
-===Filenames===
+===File names===
-Many systems have difficulty with filenames containing non-ASCII characters or spaces (this is very common with poorly written scripted system on UNIX platforms). Others have difficulties with multiple filesnames which differ only by case (DOS-compatible filesystems are unable to make this distinction). It is recommended that you avoid these unless absolutely necessary or you have already tested that thery're permitted on your choose system.
+Many systems have difficulty with file names containing non-ASCII characters or spaces (this is very common with poorly written scripted system on UNIX platforms). Others have difficulties with multiple file names which differ only by case (DOS-compatible file systems are unable to make this distinction). It is recommended that you avoid these unless absolutely necessary or you have already tested that they're permitted on your choose system.
 === Single file vs Multiple files===
-Some groups may choose to have all their TEI data in a single file or spread it across multiple files. The multiple files are combined, either in a database or in XML (using a technique such as xpointer). Advantages of the single file approach include:
+Some groups may choose to have all their TEI data in a single file or spread it across multiple files. The multiple files are combined, either in a database or in XML (using a technique such as XPointer). Advantages of the single file approach include:
 * Conceptually easy
 * Easy editing
 * Header information doesn't need to be duplicated across multiple files
-* Constraints (schema / schematron validity) easier to check
+* Constraints (schema / Schematron validity) easier to check
 Advantages of the multiple file approach include:
@@ Line 26: / Line 26: @@
 === Ensuring Google can index your content ===
 If the findability of your content on popular search engines is important to you, there are a couple of points to bear in mind.
-* Use short, sane URLs, unique before the options and search terms (for a counter-example see http://www.nzdl.org/niupepa which is not findable by google). This means that if you're using a database to present your TEI, the core texts should be reachable by browsing simple URLs rather than entering search terms.
+* Use short, sane URLs, unique before the options and search terms (for a counter-example see http://www.nzdl.org/niupepa which is not findable by Google). This means that if you're using a database to present your TEI, the core texts should be reachable by browsing simple URLs rather than entering search terms.
-* Use quality metadata in the generated the HTML
+* Use quality meta-data in the generated the HTML
 * If you have a page about "Nouns in Klingon" then the string "Nouns in Klingon" should occur in the HTML <title> tag, a dc.title <meta> tag and in a <nowiki><h1></nowiki>, <nowiki><h2></nowiki> or <nowiki><h3></nowiki> tag on the page. Preferably it should be mentioned in the text too.  It should appear in language you're wanting people to be able to search in (English, Klingon, etc)
 * You should try not to move the content around. This will confuse both google and normal people who've bookmarked it.
@@ Line 72: / Line 72: @@
 | Single web page from (single TEI file + single XSL file)
 | A web page like any other.
-| Because TEI is hidden, third party repurposing or validation is impossible
+| Because TEI is hidden, third party re-purposing or validation is impossible
 | XML, TEI, XSLT
 | No
@@ Line 155: / Line 155: @@
+|
 |-
-| Hosting on google sites
+| Hosting on Google sites
 | Free, unlimited HTML pages (size and number)
 | No dynamic content (no [[eXist]] or other databases possible). Backups important