From: Tara L Andrews Date: Thu, 11 Oct 2012 13:57:02 +0000 (+0200) Subject: add input help / info X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?p=scpubgit%2Fstemmaweb.git;a=commitdiff_plain;h=4a6b658f408cbac2ca9ec66b1042ecd8cef5b5fa add input help / info --- diff --git a/lib/stemmaweb/Controller/Root.pm b/lib/stemmaweb/Controller/Root.pm index aa6329c..59fa097 100644 --- a/lib/stemmaweb/Controller/Root.pm +++ b/lib/stemmaweb/Controller/Root.pm @@ -51,6 +51,17 @@ sub about :Local :Args(0) { $c->stash->{template} = 'about.tt'; } +=head2 help/* + +A dispatcher for documentation of various aspects of the application. + +=cut + +sub help :Local :Args(1) { + my( $self, $c, $topic ) = @_; + $c->stash->{template} = "$topic.tt"; +} + =head1 Elements of index page =head2 directory diff --git a/root/src/about.tt b/root/src/about.tt index e09124f..292829a 100644 --- a/root/src/about.tt +++ b/root/src/about.tt @@ -16,13 +16,8 @@

Any logged-in user may upload a text collation in one of several forms:

diff --git a/root/src/input.tt b/root/src/input.tt new file mode 100644 index 0000000..0fa1b45 --- /dev/null +++ b/root/src/input.tt @@ -0,0 +1,55 @@ +[% PROCESS header.tt + pagetitle = "Guidelines for XML file uploads to Stemmaweb" +%] +

Stemmaweb Help - XML upload guidelines

+
+

Guidelines for TEI parallel segmentation input

+
+

The Stemmaweb uploader can accept a collated text tradition in TEI parallel-segmentation format that adheres to the following guidelines:

+
    +
  • The file must have an <msDesc> element in its header which contains a list of all witnesses used in the text in the <listWit> element. Each <witness> element within <listWit> must have an xml:id attribute; this is taken to be the witness sigil, and is expected to appear in the "wit" attribute of the relevant apparatus readings within the text.
    • +
  • Individual reading words may be wrapped in <w> tags; if the tag has an xml:id it will be preserved as the reading ID.
    • +
  • All text within the main <text> element of the TEI file will be taken to be part of the collation. Paragraph and line divisions are not currently preserved.
    • +
  • At the point where any witness appears in the collation, this should be signified with a <witStart> tag within its own apparatus. The first of these will therefore be the first element in any collated text, for example: + 
    +    	<body>
+          <p xml:id="am_1_1">
+            <app xml:id="AppStart">
+              <rdg wit="#Jer #K #A #F #B #I #D #J #O #V #X #Y #Z #W"><witStart/></rdg>
+            </app>
+          [...]
+          </p>
+    	</body>
+
    Likewise, when a witness text ends this should be noted with a <witEnd> tag. Lacunae within the text may be indicated through successive uses of the <witEnd> and <witStart> tags.
    • +
  • Readings as they appeared before scribal corrections may be indicated using the "type" attribute on the <rdg> element, as shown here: + 
    +            <app xml:id="App530">
+              <lem wit="#Jer #K #F #B #I #A #D #J #O #V #X #Y #Z #W">
+                <w xml:id="L414">զոր</w>
+              </lem>
+              <rdg type="a.c." wit="#B"><w>Õ¦Õ¸</w></rdg>
+            </app>
+
    • +
  • An apparatus entry may contain the <lem> tag as well as the <rdg> tag; these are treated as equivalent for the purpose of creating the graph.
    • +
+
+ +

Guidelines for Classical Text Editor export

+
+

The Stemmaweb uploader can accept a collated text tradition exported from CTE, provided that certain guidelines are observed:

+
    +
  • Common abbreviations (e.g. 'om.', 'add.', and the like) should be set correctly via the Format -> Document... menu under the General tab. Any other abbreviations or notes are likely to be interpreted as literal readings by the uploader.
    • +
  • Avoid notations such as "tr. post word"; this is difficult to parse even for a human and almost impossible for a computer.
    • +
  • Be extremely careful with overlapping apparatus entries; if, for example, a pair of entries reads: + 
    +    		dominus deus] tr. A
+    		deus] deo A
+
    + then you are simultaneously telling CTE that A reads "deus dominus" and "deo dominus", and the export will become confused. Ensure that there is no scope for confusion.
    • +
  • Ensure that the critical apparatus (and the apparatus siglorum, if any) is marked as such via the Format -> Notes/Apparatus settings menu.
    • +
  • Ensure (via the menu item Options -> Preferences, under the 'XML' tab) that the 'Apparatus export' option is set to "<app> tags".
    • +
+
+
+ +[% PROCESS footer.tt %] \ No newline at end of file