I've updated these two pages: http://www.tei-c.org/Guidelines/P5/ http://www.tei-c.org/Guidelines/P5/get.xml If anyone has five minutes to give them a read, let me know if you see anything that needs fixing. Kevin, I hope I haven't trodden on your feet there; I figured that while I was doing other stuff involving SF to GitHub, I might as well do these. Both pages, but especially the second, have some very ancient and perhaps now obsolete sections that really need looking at, especially as we're making decisions about what to do with the deb packages. Cheers, Martin
On 10/4/15 5:33 PM, Martin Holmes wrote:
Kevin, I hope I haven't trodden on your feet there
Not at all! I appreciate your help in updating documentation. If anyone else would like to help and doesn't already have access to OpenCMS, I can get you set up. I would already be sharing more widely if the system weren't so arcane, buggy, and lacking in granular permissions. K.
I gave a look and the two pages seems ok Only, why not remove the
referebnce to SF in http://www.tei-c.org/Guidelines/ ?
f
2015-10-05 2:41 GMT+02:00 Kevin Hawkins
On 10/4/15 5:33 PM, Martin Holmes wrote:
Kevin, I hope I haven't trodden on your feet there
Not at all! I appreciate your help in updating documentation.
If anyone else would like to help and doesn't already have access to OpenCMS, I can get you set up. I would already be sharing more widely if the system weren't so arcane, buggy, and lacking in granular permissions.
K.
-- tei-council mailing list tei-council@lists.tei-c.org http://lists.lists.tei-c.org/mailman/listinfo/tei-council
PLEASE NOTE: postings to this list are publicly archived
-- Fabio Ciotti Dipartimento Studi Umanistici, Università di Roma Tor Vergata Presidente Associazione Informatica Umanistica Cultura Digitale
On 15-10-05 12:53 AM, Fabio Ciotti wrote:
I gave a look and the two pages seems ok Only, why not remove the referebnce to SF in http://www.tei-c.org/Guidelines/ ?
Done. I'm sure there are more floating around, though. Cheers, Martin
f
2015-10-05 2:41 GMT+02:00 Kevin Hawkins
: On 10/4/15 5:33 PM, Martin Holmes wrote:
Kevin, I hope I haven't trodden on your feet there
Not at all! I appreciate your help in updating documentation.
If anyone else would like to help and doesn't already have access to OpenCMS, I can get you set up. I would already be sharing more widely if the system weren't so arcane, buggy, and lacking in granular permissions.
K.
-- tei-council mailing list tei-council@lists.tei-c.org http://lists.lists.tei-c.org/mailman/listinfo/tei-council
PLEASE NOTE: postings to this list are publicly archived
Quick comments on the P5 page: 1. The link " installing the command-line version http://www.tei-c.org/Tools/index.xml#roma " for Roma goes (redundantly) here http://www.tei-c.org/Tools/index.xml#roma but should probably go to http://www.tei-c.org/Guidelines/Customization/odds.xml#romacommandline (you might want also to change from "installing" to "using") 2. Grammar police alert..... For a set of files are provided in the xml/tei/odd/ directory which are for use by" please substitute "The following files are provided in the directory xml/tei/odd for the use of " 3. I don't like the insistently ingratiating tone of the paragraph titled "Previous Releases of P5" ("for convenience...", "one of the benefits of this...", "organised nicely...") I would prefer something straightforwardly factual, as is the case for the rest of the page. And please be consistent about whether the reader is addressed as "you" or as "one". 4. "list the element or class name" -> "listing the element or class name" (I assume) 5. I wonder if it's time to retire or at least make less prominent the mention of the fact that P4 exists? The initial para saying "P5 is a major revision of the TEI Guidelines that offers many new and improved features. Although P5 is very different from P4, both in its technical details and in many of its encoding provisions, migration from P4 to P5 is largely automatable using readily available tools. The TEI provides information and advice on migration http://www.tei-c.org/Vault/P4/migrate.html, and has also established a page on the TEI wiki http://www.tei-c.org/wiki/ where TEI users can contribute migration tools and stylesheets." could perhaps be moved to the end of the page or revised ? On 04/10/15 23:33, Martin Holmes wrote:
I've updated these two pages:
http://www.tei-c.org/Guidelines/P5/ http://www.tei-c.org/Guidelines/P5/get.xml
If anyone has five minutes to give them a read, let me know if you see anything that needs fixing.
Kevin, I hope I haven't trodden on your feet there; I figured that while I was doing other stuff involving SF to GitHub, I might as well do these. Both pages, but especially the second, have some very ancient and perhaps now obsolete sections that really need looking at, especially as we're making decisions about what to do with the deb packages.
Cheers, Martin
I've done most of these; I left the issue of style of address and ingratiating tone to a future more careful rewrite. I've commented out the P4 stuff completely for the moment. Cheers, Martin On 15-10-05 04:03 AM, Lou Burnard wrote:
Quick comments on the P5 page:
1. The link " installing the command-line version http://www.tei-c.org/Tools/index.xml#roma " for Roma goes (redundantly) here http://www.tei-c.org/Tools/index.xml#roma but should probably go to http://www.tei-c.org/Guidelines/Customization/odds.xml#romacommandline (you might want also to change from "installing" to "using")
2. Grammar police alert..... For a set of files are provided in the xml/tei/odd/ directory which are for use by" please substitute "The following files are provided in the directory xml/tei/odd for the use of "
3. I don't like the insistently ingratiating tone of the paragraph titled "Previous Releases of P5" ("for convenience...", "one of the benefits of this...", "organised nicely...") I would prefer something straightforwardly factual, as is the case for the rest of the page. And please be consistent about whether the reader is addressed as "you" or as "one".
4. "list the element or class name" -> "listing the element or class name" (I assume)
5. I wonder if it's time to retire or at least make less prominent the mention of the fact that P4 exists? The initial para saying "P5 is a major revision of the TEI Guidelines that offers many new and improved features. Although P5 is very different from P4, both in its technical details and in many of its encoding provisions, migration from P4 to P5 is largely automatable using readily available tools. The TEI provides information and advice on migration http://www.tei-c.org/Vault/P4/migrate.html, and has also established a page on the TEI wiki http://www.tei-c.org/wiki/ where TEI users can contribute migration tools and stylesheets." could perhaps be moved to the end of the page or revised ?
On 04/10/15 23:33, Martin Holmes wrote:
I've updated these two pages:
http://www.tei-c.org/Guidelines/P5/ http://www.tei-c.org/Guidelines/P5/get.xml
If anyone has five minutes to give them a read, let me know if you see anything that needs fixing.
Kevin, I hope I haven't trodden on your feet there; I figured that while I was doing other stuff involving SF to GitHub, I might as well do these. Both pages, but especially the second, have some very ancient and perhaps now obsolete sections that really need looking at, especially as we're making decisions about what to do with the deb packages.
Cheers, Martin
1. "If you simply want to use the most stable versions of the various products of the TEI, then investing time and effort in learning to use the Repository is probably not what you want to." what I want to what? But this sentence is giving the wrong message anyway. How about "However, it is not necessary to learn how to use the Repository if you simply want to use the most stable versions of the various TEI products." (and maybe insert the simple example here?) 2. "To check out the contents of a TEI GitHub Repository with a simple Unix subversion client," I think not. How about "Unix systems provide a command line utility "git" which can be used to checkout the contents of a TEI Repository " 3. "While they should work (possibly with customization) on other Linux systems, they are not designed to work on Microsoft Windows." Should we not also say something about their usability on a Mac? 4. "internationalisation movements" --> "internationalisation efforts" perhaps? "However, others are planned, if you want to help out, ask about doing so on the TEI-L mailing list. " Apart from the misused comma, did we not have another more precise page describing the I18N effort somewhere? 5. The list of "exemplars" contains several typos and other infelicities; however I wonder if it's not a bit of a hostage to fortune being so explicit here? Maybe it would be better to replace this list by a link to another page explaining what the exemplars are and their salient characteristics . 6. Roma: "in addition to its command-line version available in the Roma subversion module" err, and what is a "subversion module" again? 7. "provides a location for the dissemination and development of XSLT stylesheets" -> "contains the TEI XSLT Stylesheet library" 8. The remarks about the Stylesheets surely ought to include a link to the git repo for them, since that's where technical issues concerning their use are discussed. 9. "These steps assume a linux system and command-line git client, and installs "Am I the last person alive to care about verb/noun concord? 10 "More information on using these deliverables is available from the TEI website. " Uselessly vague. Please delete. 11. The example at the end of this page surely ought to be at the beginning, marked as the "Spare me the details, I just want to get going option"? "If you just want to get started using the TEI on your Linux system, do the following: " or similar. On 04/10/15 23:33, Martin Holmes wrote:
I've updated these two pages:
http://www.tei-c.org/Guidelines/P5/ http://www.tei-c.org/Guidelines/P5/get.xml
If anyone has five minutes to give them a read, let me know if you see anything that needs fixing.
Kevin, I hope I haven't trodden on your feet there; I figured that while I was doing other stuff involving SF to GitHub, I might as well do these. Both pages, but especially the second, have some very ancient and perhaps now obsolete sections that really need looking at, especially as we're making decisions about what to do with the deb packages.
Cheers, Martin
Thanks for the detailed proofing. I've done a few of these but I've run out of time for the moment; I'll try to finish them off later. Cheers, Martin On 15-10-05 04:31 AM, Lou Burnard wrote:
1. "If you simply want to use the most stable versions of the various products of the TEI, then investing time and effort in learning to use the Repository is probably not what you want to."
what I want to what? But this sentence is giving the wrong message anyway. How about
"However, it is not necessary to learn how to use the Repository if you simply want to use the most stable versions of the various TEI products." (and maybe insert the simple example here?)
2. "To check out the contents of a TEI GitHub Repository with a simple Unix subversion client," I think not. How about "Unix systems provide a command line utility "git" which can be used to checkout the contents of a TEI Repository "
3. "While they should work (possibly with customization) on other Linux systems, they are not designed to work on Microsoft Windows." Should we not also say something about their usability on a Mac?
4. "internationalisation movements" --> "internationalisation efforts" perhaps? "However, others are planned, if you want to help out, ask about doing so on the TEI-L mailing list. " Apart from the misused comma, did we not have another more precise page describing the I18N effort somewhere?
5. The list of "exemplars" contains several typos and other infelicities; however I wonder if it's not a bit of a hostage to fortune being so explicit here? Maybe it would be better to replace this list by a link to another page explaining what the exemplars are and their salient characteristics .
6. Roma: "in addition to its command-line version available in the Roma subversion module" err, and what is a "subversion module" again?
7. "provides a location for the dissemination and development of XSLT stylesheets" -> "contains the TEI XSLT Stylesheet library"
8. The remarks about the Stylesheets surely ought to include a link to the git repo for them, since that's where technical issues concerning their use are discussed.
9. "These steps assume a linux system and command-line git client, and installs "Am I the last person alive to care about verb/noun concord?
10 "More information on using these deliverables is available from the TEI website. " Uselessly vague. Please delete.
11. The example at the end of this page surely ought to be at the beginning, marked as the "Spare me the details, I just want to get going option"?
"If you just want to get started using the TEI on your Linux system, do the following: " or similar.
On 04/10/15 23:33, Martin Holmes wrote:
I've updated these two pages:
http://www.tei-c.org/Guidelines/P5/ http://www.tei-c.org/Guidelines/P5/get.xml
If anyone has five minutes to give them a read, let me know if you see anything that needs fixing.
Kevin, I hope I haven't trodden on your feet there; I figured that while I was doing other stuff involving SF to GitHub, I might as well do these. Both pages, but especially the second, have some very ancient and perhaps now obsolete sections that really need looking at, especially as we're making decisions about what to do with the deb packages.
Cheers, Martin
I've finally made (most of) these changes. I didn't agree with moving the detailed example to the beginning (#11 below), because there is a TOC at the top of the page, so I've left it where it was. Cheers, Martin On 15-10-05 04:31 AM, Lou Burnard wrote:
1. "If you simply want to use the most stable versions of the various products of the TEI, then investing time and effort in learning to use the Repository is probably not what you want to."
what I want to what? But this sentence is giving the wrong message anyway. How about
"However, it is not necessary to learn how to use the Repository if you simply want to use the most stable versions of the various TEI products." (and maybe insert the simple example here?)
2. "To check out the contents of a TEI GitHub Repository with a simple Unix subversion client," I think not. How about "Unix systems provide a command line utility "git" which can be used to checkout the contents of a TEI Repository "
3. "While they should work (possibly with customization) on other Linux systems, they are not designed to work on Microsoft Windows." Should we not also say something about their usability on a Mac?
4. "internationalisation movements" --> "internationalisation efforts" perhaps? "However, others are planned, if you want to help out, ask about doing so on the TEI-L mailing list. " Apart from the misused comma, did we not have another more precise page describing the I18N effort somewhere?
5. The list of "exemplars" contains several typos and other infelicities; however I wonder if it's not a bit of a hostage to fortune being so explicit here? Maybe it would be better to replace this list by a link to another page explaining what the exemplars are and their salient characteristics .
6. Roma: "in addition to its command-line version available in the Roma subversion module" err, and what is a "subversion module" again?
7. "provides a location for the dissemination and development of XSLT stylesheets" -> "contains the TEI XSLT Stylesheet library"
8. The remarks about the Stylesheets surely ought to include a link to the git repo for them, since that's where technical issues concerning their use are discussed.
9. "These steps assume a linux system and command-line git client, and installs "Am I the last person alive to care about verb/noun concord?
10 "More information on using these deliverables is available from the TEI website. " Uselessly vague. Please delete.
11. The example at the end of this page surely ought to be at the beginning, marked as the "Spare me the details, I just want to get going option"?
"If you just want to get started using the TEI on your Linux system, do the following: " or similar.
On 04/10/15 23:33, Martin Holmes wrote:
I've updated these two pages:
http://www.tei-c.org/Guidelines/P5/ http://www.tei-c.org/Guidelines/P5/get.xml
If anyone has five minutes to give them a read, let me know if you see anything that needs fixing.
Kevin, I hope I haven't trodden on your feet there; I figured that while I was doing other stuff involving SF to GitHub, I might as well do these. Both pages, but especially the second, have some very ancient and perhaps now obsolete sections that really need looking at, especially as we're making decisions about what to do with the deb packages.
Cheers, Martin
participants (4)
-
Fabio Ciotti
-
Kevin Hawkins
-
Lou Burnard
-
Martin Holmes