From: Tara L Andrews Date: Mon, 20 Jan 2014 20:34:19 +0000 (+0100) Subject: add help docs, especially for relationship mapper X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=commitdiff_plain;h=5800cf9ea8c4513f385b9823f4778bce34caf8fd;p=scpubgit%2Fstemmaweb.git add help docs, especially for relationship mapper --- diff --git a/root/images/00_bad_collation.png b/root/images/00_bad_collation.png new file mode 100644 index 0000000..20cb1fb Binary files /dev/null and b/root/images/00_bad_collation.png differ diff --git a/root/images/00_variantgraph.png b/root/images/00_variantgraph.png new file mode 100644 index 0000000..776eafd Binary files /dev/null and b/root/images/00_variantgraph.png differ diff --git a/root/images/01_makerelation.png b/root/images/01_makerelation.png new file mode 100644 index 0000000..690746c Binary files /dev/null and b/root/images/01_makerelation.png differ diff --git a/root/images/01_select_decollate.png b/root/images/01_select_decollate.png new file mode 100644 index 0000000..ac71183 Binary files /dev/null and b/root/images/01_select_decollate.png differ diff --git a/root/images/02_relationdialog.png b/root/images/02_relationdialog.png new file mode 100644 index 0000000..4dc4772 Binary files /dev/null and b/root/images/02_relationdialog.png differ diff --git a/root/images/02_witness_select.png b/root/images/02_witness_select.png new file mode 100644 index 0000000..4ef3a1c Binary files /dev/null and b/root/images/02_witness_select.png differ diff --git a/root/images/03_detached.png b/root/images/03_detached.png new file mode 100644 index 0000000..39951c0 Binary files /dev/null and b/root/images/03_detached.png differ diff --git a/root/images/03_infodelete.png b/root/images/03_infodelete.png new file mode 100644 index 0000000..4214412 Binary files /dev/null and b/root/images/03_infodelete.png differ diff --git a/root/images/04_rejoin_correct.png b/root/images/04_rejoin_correct.png new file mode 100644 index 0000000..616cfb8 Binary files /dev/null and b/root/images/04_rejoin_correct.png differ diff --git a/root/images/05_select_merge.png b/root/images/05_select_merge.png new file mode 100644 index 0000000..e3dd9f1 Binary files /dev/null and b/root/images/05_select_merge.png differ diff --git a/root/images/06_merged_farther.png b/root/images/06_merged_farther.png new file mode 100644 index 0000000..710adc7 Binary files /dev/null and b/root/images/06_merged_farther.png differ diff --git a/root/images/07_merged_mess.png b/root/images/07_merged_mess.png new file mode 100644 index 0000000..6325fa2 Binary files /dev/null and b/root/images/07_merged_mess.png differ diff --git a/root/images/08_merged_reloaded.png b/root/images/08_merged_reloaded.png new file mode 100644 index 0000000..245912e Binary files /dev/null and b/root/images/08_merged_reloaded.png differ diff --git a/root/src/about.tt b/root/src/about.tt index 95eca3c..df77971 100644 --- a/root/src/about.tt +++ b/root/src/about.tt @@ -8,12 +8,12 @@

Stemmaweb is a set of tools that has grown out of the Tree of Texts, a CREA ("creative research") project funded by the KU Leuven. The tools were developed variously within the project, on behalf of the project by Shadowcat Systems, and in collaboration with the Interedition project. The source code for all tools and associated libraries is available on Github.

-

All tools are free for scholarly (nonprofit) use and adaptation. Although some data may be viewed publicly without a user account, use of the tools with your own data is possible only by registering as a user. You may log in with a Google account or another OpenID account, or you may register with a local username and password for use on the site. The Tree of Texts project and KU Leuven retain rights to uploaded text traditions only insofar as it is necessary to store and back them up, display them according to the stated preferences, and analyze them with the tools provided and linked.

+

All tools are free for scholarly and nonprofit use and adaptation. Although some data may be viewed publicly without a user account, use of the tools with your own data is possible only by registering as a user. You may log in with a Google account or another OpenID account, or you may register with a local username and password for use on the site. The Tree of Texts project and KU Leuven retain rights to uploaded text traditions only insofar as it is necessary to store and back them up, display them according to the stated preferences, and analyze them with the tools provided and linked.

Tools available

At present the Stemmaweb tools comprise the following:

-

Uploader

+

Uploader ("Add a new text tradition")

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

Once a tradition is successfully uploaded, you may change its name and its language, and choose whether others may view (but not edit) it.

-

Stemma editor

+

Stemma editor ("Add a new stemma / Edit this stemma")

For any text tradition you own, you may associate one or more stemma hypotheses to the tradition. Currently the way to specify a stemma is in "dot" format, as documented within the interface for the "Add/edit stemma" buttons.

+ +

Stemma generation via Stemweb ("Run a Stemweb algorithm")

+

Given an uploaded collation, it is possible to generate a stemma hypothesis using one of several algorithms. This feature, Stemweb, is a service provided by researchers at the HIIT (Helsinki Institute for Information Technology). The algorithms currently available include: + +

+ Both the Semstem and RHM algorithms require a single parameter, "iterations", to specify the number of times the analysis should be run to arrive at a consensus model. A higher number produces a more certain result, but requires a longer time to run. Suggested minimums are 50 iterations for Semstem and 1000000 iterations for RHM.

+

All of these algorithms run "asynchronously" - when the owner of a tradition makes a request for a generated tree, the result can take some minutes (or even hours, depending on the complexity of the tradition) to return. When a request has been made, the owner can check its progress using the same button; if the stemma has meanwhile been calculated, it will be loaded. If the owner leaves the Stemmaweb site and the stemma is calculated meanwhile, it will appear when Stemmaweb is next used.

+

Generated stemmas are not oriented - they have no inferred root or origin. This means that, in order to examine the texual variants against a generated stemma (see "Stexaminer" below), a root must first be chosen. This can be done simply by clicking a node in the returned graph, and choosing the option to use that node as the root. Any stemma may be re-rooted any number of times.

-

Relationship mapper

-

The relationship mapper tool allows you to define the relationships between variant readings within your text. This is useful for, among other things, later stemma analysis - it allows classification of the sorts of variants that may or may not yield clues as to the history of the text. Please see the "Help/about" link at the top of the relationship mapper for more information about its use.

- -

Stexaminer

+

Stexaminer ("Examine variants against this stemma")

This tool allows visualization of the variants within a text tradition, according to the selected stemma hypothesis. The stemma graph and the variant witness groupings are sent to a calculation service, provided by the Declarative Language and Artificial Intelligence research group of the KU Leuven, that attempts to determine for each variant location within the text:

For more information on this tool and the analysis behind it, please see the following paper.

+

Relationship mapper ("View collation and relationships")

+

The relationship mapper tool allows you to define the relationships between variant readings within your text. This is useful for, among other things, later stemma analysis - it allows classification of the sorts of variants that may or may not yield clues as to the history of the text. Please see the "Help/about" link at the top of the relationship mapper for more information about its use.

+

License

All source code for the Stemmaweb tools and user interface is open-source. The Perl libraries are governed by the Perl license; the remaining software is governed by the GNU General Public License.

Rights to all textual data uploaded to the Stemmaweb system are retained by its original owner. By uploading the data you assert that you have the right to use it, and you grant us rights to it insofar as it is necessary for us to store, backup, and display the data.

diff --git a/root/src/index.tt b/root/src/index.tt index 580da1c..884a68e 100644 --- a/root/src/index.tt +++ b/root/src/index.tt @@ -12,7 +12,7 @@ var textOnLoad = "[% withtradition %]"; [% END %]
- [% IF c.user_exists %]Hello! [% c.user.get_object.email %]!   Sign out | [% ELSE %]Login | [% END %]About Stemmaweb + [% IF c.user_exists %]Hello! [% c.user.get_object.email %]!   Sign out | [% ELSE %]Sign in/Register | [% END %]About Stemmaweb

Stemmaweb - a collection of tools for analysis of collated texts

diff --git a/root/src/relatehelp.tt b/root/src/relatehelp.tt index ee13a12..f4dd989 100644 --- a/root/src/relatehelp.tt +++ b/root/src/relatehelp.tt @@ -13,36 +13,62 @@

Making relationships between words

-

The tool itself is an interface for allowing these relationships to be declared. The collation is presented as a variant graph running from left to right. In a variant graph, each node is a reading, and each witness takes a single path through the readings from beginning to end. When readings appear vertically aligned with each other, it is an indication that they are variant readings, occurring at the same point in the text. +

The tool itself is an interface for allowing these relationships to be declared. The collation is presented as a variant graph running from left to right. In a variant graph, each node is a reading, and each witness takes a single path through the readings from beginning to end. When readings appear vertically aligned with each other, it is an indication that they are variant readings, occurring at the same point in the text. In the example given here, the variants include "ecclesia/que", "beata/sancta/beatam", "uirgine/uirginem", and "tres/duas".

+

In 'select' mode, when the nodes are green, you can navigate through the graph. Scrolling up or down will zoom in and out, respectively; dragging the graph will pan it in that direction. Use this navigation to hone in on the part of the graph to be worked with.

-

When you are ready to draw relationships, click the 'pencil' icon to enter edit mode. When you select a node (by clicking on it) you can drag it onto another node to indicate that a relationship exists between them. Fill in the details of the relationship as follows:

-

Type can be one of:

-
    -
  • Orthographic - these are interchangeable representations of the same reading
    • -
  • Spelling - these are variant spellings of the same reading
    • -
  • Grammatical - these readings are word forms with the same lemma
    • -
  • Lexical - these readings fulfill corresponding functions in the text. Use the "Annotation" field to elaborate.
    • -
  • Meaning - these readings have corresponding meanings (e.g. synonyms, antonyms). Use the "Annotation" field to elaborate.
    • -
  • Transposition - this pair actually represents the same reading, but its location varies between witnesses. -
+

When you are ready to draw relationships, click the 'pencil' icon to the top right of the screen to enter edit mode. When you select a node (by clicking on it) you can drag it onto another node to indicate that a relationship exists between them.

+ + +

Fill in the details of the relationship as indicated in the dialog:

+ + +

Type can be any one of the types that appears in the key to the right of the screen.

Scope can be one of:

  • Local - the relationship applies only at this point in the text
    • -
  • Global - the relationship applies throughout the text
    • +
  • Document - the relationship applies throughout the text
    • +
  • Global - the relationship applies throughout all texts of this language
+

NOTE: at the moment, "global" scope is treated as "document" scope, i.e. only applies throughout the individual text.

+ +

The relationships are displayed as colored paths between readings. While in 'edit' mode, clicking on a relationship path will display the information associated with it, and give the user an option to delete it. Deletion of a 'global' relationship will remove that relationship throughout the graph.

+ + +

When you are ready to move elsewhere in the graph, click the 'hand' icon to return to select mode.

-

The relationships are displayed as colored paths between readings. While in 'edit' mode, clicking on a relationship path will display the information associated with it, and give the user an option to delete it. Deletion of a 'global' relationship will remove that relationship throughout the graph. When you are ready to move elsewhere in the graph, click the 'hand' icon to return to select mode.

Correcting the collation

-

Occasionally, the collation as uploaded will contain errors, or need for some other reason to be modified. Within the relationship mapper, you can detach a sequence of readings and re-attach it elsewhere as a form of manual collation.

+

Occasionally, the collation as uploaded will contain errors, or need for some other reason to be modified. For example, in the following snippet, the witness Ba96 has a string of words "cetera. Secundo uere asserendo" that have been separated from their analogues in other witnesses through an erroneous collation of the "et" in Ba96 with a later "et" in the majority of witnesses.

+ -

To detach one or more readings, drag with the mouse to select an area of the graph that includes all the affected readings. A dialog will pop up to ask which witnesses should be detached from the collation at that point. To attach a reading elsewhere, select it and drag it to the corresponding reading elsewhere in the graph, just as though you were making a relationship. There should be an option to specify that the readings are identical; select it.

+

Within the relationship mapper, you can detach a sequence of readings and re-attach it elsewhere as a form of manual collation. To detach one or more readings, drag with the mouse to select an area of the graph that includes all the affected readings.

+ + +

A dialog will pop up to ask which witnesses should be detached from the collation at that point. At least one witness must be selected; at least one witness must also remain unselected. In the case of our example, we wish to detach the reading for Ba96.

+ -

At the moment, editing the graph in this manner can quickly lead to a rather untidy and confusing-looking graph. If at any point it becomes too difficult to follow, please re-load the relationship mapper.

+

The result will be one or more new readings in the graph, identical to the selected ones, with the affected witnesses using the new reading instead of the old one.

+ + +

To attach the separated reading elsewhere, select it and drag it to the corresponding reading elsewhere in the graph, just as though you were making a relationship.

+ + +

There should be an option "Merge readings" to specify that the readings are identical; select it.

+ + +

When two identical readings are merged, the relationship mapper will display a set of suggestions for other readings that might also need to be merged, in light of the change that was just made. Selecting the green button will accept the suggestion; selecting the red button will reject it. If a reading is erroneously merged, it may be detached again in the same manner described above.

+ + +

At the moment, editing the graph in this manner can quickly lead to a rather untidy and confusing-looking graph:

+ +

If at any point it becomes too difficult to follow, please re-load the relationship mapper. The corrected graph will appear in its clean format.

+ + + + [% PROCESS footer.tt %] \ No newline at end of file