Typecraft v2.5
Jump to: navigation, search

Difference between revisions of "Help:The TypeCraft Editors for Newcomers"

(5 intermediate revisions by the same user not shown)
Line 1: Line 1:
{{TcCopyEdit}}
 
  
 +
===The Basics===
 +
You need to be logged in order to use the TypeCraft editor and edit the TypeCraft wiki. Search of the repository is open to the general public.
  
 +
When you read this, please go to the upper right corner of this window. You see a blue GO button and right above it on the grey bar you see to the very right the Log in button. Press this button and follow the instructions.
  
==TypeCraft 2.0 Editor==
+
After filling in the required login information, you will received a confirmation mail from TypeCraft. This sometimes take a short while. When you have received the mail, open it and confirming your e-mail address. Go back to the TypeCraft page. You now can login to TypeCraft. The use of the system is free of charge,
 
+
In order to allow a smooth transition between the TypeCraft 2.0 editor and the TypeCraft 1.0 editor, TypeCraft will maintain both editors well into 2015, but at the same
+
time we would like to encourage TypeCraft users to switch to the new and improved editor. You still can find a user guide for the old editor at the end of this manual: [[#TypeCraft 1.0 Editor (This editor will be maintained until summer 2015)|TypeCraft 1.0 Editor]]
+
 
+
===The Basics===
+
You need to be logged in order to use the TypeCraft editor and edit the TypeCraft wiki([http://typecraft.org/w/index.php?title=Special:UserLogin&returnto=Main_Page Login screen ]] ). Search of the public IGT repository is open to the general public.
+
 
+
After filling in the required login information, you will received a confirmation mail from TypeCraft. This sometimes might take one or two days, since the process is not fully automatic. After confirming your e-mail address, you can login to TypeCraft. The use of the system is free of charge,
+
  
 
When logging in for the first time, TypeCraft creates a public TypeCraft user page for you, using the information that you provided when creating your TypeCraft login.  
 
When logging in for the first time, TypeCraft creates a public TypeCraft user page for you, using the information that you provided when creating your TypeCraft login.  
  
[[File:Userpage.jpg|thumb|400px|left| Dorothee Beermann's user page]]  One of the main goals of TypeCraft is to facilitate the exchange of IGT data.To know who created and annotated the TypeCraft IGT is part of ensuring linguistic data quality and  provenance. Is the language(s) that you work with your mother tongue? Do you speak a dialect? Are you a field worker, a language specialist. Information about your work with language is useful to other users of TypeCraft who are interested in your data.
+
Your name now appears on the grey bar on top of your TypeCraft window. Click on your name. This will bring you to your user page. You can edit this page by adding text, pictures or videos.  
  
If you use TypeCraft in the context of a project, you might want to consider creating a project page on the TypeCraft wiki, or link to your already existing project page somewhere else.
+
If you use TypeCraft in the context of a project, you might want to consider creating a project page on this wiki, or link your pages on the TC-wiki to an already existing web page featuring your project.
  
You can go to your public TypeCraft user page by clicking on your name at the right upper corner of your TypeCraft wiki page. The screenshot to the left shows such a user page  Wherever you are in on the TypeCraft wiki, clicking your name, in the upper right corner will bring you back to your user page.
 
  
 +
===My preferences===
 +
Using the  ''Preferences'''button, found to the right of your user name on top of the TypeCraft site, you can customise the TypeCraft wiki. Here you can change your password, register a new e-mail address and allow others users to send you e-mails via TypeCraft.
  
 +
You also can use the preferences button to customise the search behaviour of your TypeCraft wiki.
  
 
+
The easiest way to find things on your TypeCraft wiki is to use the wiki-search window on the navigation bar. Type for example *annotation* and click *GO* or *SEARCH*<ref> The main difference between *Go* and *Search* is that *Go* brings you directly to the page with the title that you have typed into the search window. *GO* also allows you to create a page of that name in case that it does not exist yet </ref>. *Search* will consist of TypeCraft wiki pages from different namespaces that contain the search term.  
 
+
 
+
====My preferences====
+
From your '''my preferences''' page, found to the right of your user name, you can customise the TypeCraft wiki. Here you can change your password, register a new e-mail address and allow others users to send you e-mails via TypeCraft.
+
 
+
You also use my preferences to customise the search behaviour of your TypeCraft wiki (wiki search is not to be confused with a search in the TypeCraft IGT database).
+
 
+
An easiest way to find things on your TypeCraft wiki is to use the wiki-search window on the navigation bar. Type for example *annotation* and click *GO* or *SEARCH*<ref> The main difference between *Go* and *Search* is that go brings you directly to the page with the title that you typed into the search window. *GO* also allows you to create a page of that name in case that it does not exist yet </ref> The search result will consist of TypeCraft wiki pages from different namespaces that start with the word ''(A,a)nnotation'' in their title.
+
  
 
Namespaces are used by a Mediawiki to create collections of wiki pages. My preferenes allows you to set the namespaces in which the TypeCraft wiki should search. Next to
 
Namespaces are used by a Mediawiki to create collections of wiki pages. My preferenes allows you to set the namespaces in which the TypeCraft wiki should search. Next to
 
the standard namespaces found on any mediawiki, TypeCraft uses its own namespaces. It therefore is best that you search in the following namespaces:
 
the standard namespaces found on any mediawiki, TypeCraft uses its own namespaces. It therefore is best that you search in the following namespaces:
 
 
[[File:Preferences.png|thumb|400px|left|click on the picture to see a largoer version]]
 
  
 
:: '''Main'''
 
:: '''Main'''
Line 49: Line 34:
  
  
 
+
===The TypeCraft Editor===
 
+
 
+
 
+
 
+
 
+
 
+
 
+
 
+
 
+
 
+
 
+
====TypeCraft 2.0 Editor - What is new?====
+
 
+
The new editor focuses on the visualisation of the relation between the text and annotated phrases.
+
Units chosen for annotation no longer are necessarily sentences. Instead the TypeCraft 2.0 editor also allows the selection of discourse segments for annotation.
+
 
+
Also different from the TypeCraft 1.0 editor, the new editor no longer assumes that the user wants to annotate the whole text, although we also provide for the
+
complete annotation of texts and a sentence-based text segmentation, as described in …......
+
  
 
[[File:tooltabs.jpg|thumb|400px|left]]
 
[[File:tooltabs.jpg|thumb|400px|left]]
  
Central to the new editor is the text area.  A tool tabs menu gives the user access to all main functions, as shown to in the screenshot to the left.
+
Central to the text area is the tool tabs menu which gives the user access to all main functions, as shown in the screenshot to the left.  The upper tool tab row (in light yellow since we used the Theme called ''Sunny'' for this screenshot) gives access to the Text and Phrase related functions. The Text and Phrase export functions are accessed from here. You can export one or several phrase or relative to Texts you can export Word lists. Here you also find the function that allows you to  delete a Text or Phrases.
   
+
The upper tool tab row (in light yellow since we used the Theme called ''Sunny'' for this screenshot)gives access to the Text and Phrase related functions. The Text and Phrase
+
export functions are accessed from here, as well as a function that deletes a Text or Phrases.
+
  
 
Also Editor Themes can be chosen from the upper Tool tabs menu. It allows you to customise the looks of your editor.
 
Also Editor Themes can be chosen from the upper Tool tabs menu. It allows you to customise the looks of your editor.
 
 
The second tool tabs provides access to the following functions:   
 
The second tool tabs provides access to the following functions:   
  
Line 91: Line 54:
 
:: '''View Discourse Senses'''(will show the scope of discourse senses as coloured line within the text. Mouse-over will make the sense tag visible)
 
:: '''View Discourse Senses'''(will show the scope of discourse senses as coloured line within the text. Mouse-over will make the sense tag visible)
 
   
 
   
 +
 
As part of the Metadata section, to the right of the text area, you define the source language of your text by picking its name from the ISO list of the World's languages. Quite a few languages are known under several names. You might want to check [http://glottolog.org/ Glottolog] or [http://www.ethnologue.com/ Ethnologue]
 
As part of the Metadata section, to the right of the text area, you define the source language of your text by picking its name from the ISO list of the World's languages. Quite a few languages are known under several names. You might want to check [http://glottolog.org/ Glottolog] or [http://www.ethnologue.com/ Ethnologue]
  
 +
Some of the above mentioned functions open additional windows which you can freely moved within your browser window.
  
===Annotating with the TypeCraft 2.0 Editor===
+
===The Annotation Table===
  
More about how to annotate with the TypeCraft 2.0 Editor you learn by [[:Help:How_to_annotate_in_TypeCraft_-_a_practical_guide| following this link]]
+
Also the tabular IGT editor opens in an extra window, and is freely moveable so that you can annotate a phrase with its textual context still visible in the background. You can open instantiated phrases (the green (not yet annotated) and the blue (annotated) either directly from the text area by double clicking
 +
them, or from your *View phrases* tab. Sentences stay open in your tabular editor unless you close them explicitly. This allows you to work with several phrases at the same time, and by sizing and moving the tabular editor window you always have direct access to the whole text.
  
 +
The tabular editor gives you access to a Valance annotation set, and to the Sense tiers which allow you to annotate for discourse senses.
  
+
More about the Editor you find here:
 +
[[:Help:How_to_annotate_in_TypeCraft_-_a_practical_guide| following this link]]
  
  
  
 +
  
  
Line 112: Line 81:
  
  
===TypeCraft 1.0 Editor (This editor will be maintained until summer 2015)===
 
 
<span style="color:red;font-size:125%;"> TypeCraft recommends the new, improved TypeCraft 2.0 editor </span>
 
 
 
 
You have decided not to use the new TypeCraft editor.Follow the steps as indicated below:
 
 
====Step 1 - enter text into the text field====
 
<span style="color: grey;"> The Text Editor has on the left side a text field. You use this field to either to import text from a file by copy & paste, or you manually enter sentences.</span>
 
 
====Step 2 - sentence split====
 
<span style="color: grey;"> After you have entered your text you click on *Create phrases*. A dialogue box appears. If you have not marked parts of the text
 
(which you normally only do if you want to add more text to an already existing text), TypeCraft will say: ''Nothing selected. Should TypeCraft use the whole text instead?'' Answer: ''yes''.</span>
 
 
====(Step 3 optional) - repeat sentence split ====
 
<span style="color: grey;"> If you are unhappy with the way TypeCraft has split your sentences, revise the punctuation and delete additional spaces between paragraphs. You can repeat this step until you are satisfied with the sentence break up. When you are happy with the initialised sentence you can start to annotated them</span>
 
 
====Step 4 - Initializing your annotation table====
 
<span style="color: grey;"> Click on one of the individual blue initialised phrases on the right-hand side of your Text Editor window. A small window pops-up, saying:</span>
 
<span style="color: grey;">
 
{| border="1"
 
|-
 
|'''''TypeCraft wants to know''':
 
|-
 
|This phrase has no words yet.
 
You can initialise words and morphemes automatically.
 
Separate words by spaces (" ") and morphemes by hyphens ("-").
 
 
If you click cancel you can insert words and morphemes manually.
 
 
|}</span>
 
 
<span style="color: grey;"> It seems that we have added this window to confuse you ;); what we really mean is this:</span>
 
<span style="color: grey;">
 
'''You have 3 different options as how to start using the annotator</span>
 
<span style="color: grey;">
 
If you want the phrase in the input mask inserted into a table without any further segmentation, click OK.</span>
 
<span style="color: grey;">
 
If you want the text in the input mask inserted into the table and you in addition want to split some of the words into smaller segments before they are inserted into the table,you can do that by inserting hyphens "-" or spaces " " now. Click OK. Do not be afraid of possible mistakes you might make when inserting hyphens at this point. You can always change what you do later.</span>
 
  
<span style="color: grey;">
 
If you don't want to start off with the material in the input mask, but rather wish to fill all material into the table manually '''click cancel'''. A one-column skeleton of a table appears, and here
 
you can fill in text in the top line - one word per column. You create a new column by clicking in an existing column: you get a menu where you left-click, and get the options 'New word before', 'New word after' or 'Delete word'. By clicking on either of the former options a new empty column appears, where a word can be written in. On the second line in the table, morphological units are written in in a similar manner - the menu now offers 'New morpheme before', 'New morpheme after' or 'Delete morpheme', and in similar fashion as above, in the first two cases an empty column is created for being filled manually.</span>
 
<span style="color: grey;">
 
These manual processes can be performed also if one has chosen one of the first two bullet-point options presented above. Thus, one can at any point go back and correct mistakes, fill in more information, etc. </span>
 
  
 
<references/>
 
<references/>

Revision as of 20:37, 18 January 2018

The Basics

You need to be logged in order to use the TypeCraft editor and edit the TypeCraft wiki. Search of the repository is open to the general public.

When you read this, please go to the upper right corner of this window. You see a blue GO button and right above it on the grey bar you see to the very right the Log in button. Press this button and follow the instructions.

After filling in the required login information, you will received a confirmation mail from TypeCraft. This sometimes take a short while. When you have received the mail, open it and confirming your e-mail address. Go back to the TypeCraft page. You now can login to TypeCraft. The use of the system is free of charge,

When logging in for the first time, TypeCraft creates a public TypeCraft user page for you, using the information that you provided when creating your TypeCraft login.

Your name now appears on the grey bar on top of your TypeCraft window. Click on your name. This will bring you to your user page. You can edit this page by adding text, pictures or videos.

If you use TypeCraft in the context of a project, you might want to consider creating a project page on this wiki, or link your pages on the TC-wiki to an already existing web page featuring your project.


My preferences

Using the Preferences'button, found to the right of your user name on top of the TypeCraft site, you can customise the TypeCraft wiki. Here you can change your password, register a new e-mail address and allow others users to send you e-mails via TypeCraft.

You also can use the preferences button to customise the search behaviour of your TypeCraft wiki.

The easiest way to find things on your TypeCraft wiki is to use the wiki-search window on the navigation bar. Type for example *annotation* and click *GO* or *SEARCH*[1]. *Search* will consist of TypeCraft wiki pages from different namespaces that contain the search term.

Namespaces are used by a Mediawiki to create collections of wiki pages. My preferenes allows you to set the namespaces in which the TypeCraft wiki should search. Next to the standard namespaces found on any mediawiki, TypeCraft uses its own namespaces. It therefore is best that you search in the following namespaces:

Main
User
TypeCraft
Category
Classroom
Help

When in *my preference* select -> User profile -> *SEARCH*, and select the relevant namespaces by ticking of boxes. Save your preferences.


The TypeCraft Editor

Tooltabs.jpg

Central to the text area is the tool tabs menu which gives the user access to all main functions, as shown in the screenshot to the left. The upper tool tab row (in light yellow since we used the Theme called Sunny for this screenshot) gives access to the Text and Phrase related functions. The Text and Phrase export functions are accessed from here. You can export one or several phrase or relative to Texts you can export Word lists. Here you also find the function that allows you to delete a Text or Phrases.

Also Editor Themes can be chosen from the upper Tool tabs menu. It allows you to customise the looks of your editor. The second tool tabs provides access to the following functions:

Save (saves your text)
Share (text can be shared between users of TypeCraft. The groups that you are a member of will show in a drop down menu here, and you can save your ::text to any of these groups)
Publish (allows you to make your text accessible to the general public)
Template (saving one of your texts as a template, allows other users to make a copy of that text. This is a function
at present mainly used for teaching)
New Phrase (after highlighting a segment in your text area, you can use this function to create a new annotation unit, called a Phrase)
Delete Phrase (the function allows you to delete the activation of a text segment as an annotation phrase. The text element itself will not
be deleted)
View Phrase List(will show you all your instantiated Phrases)
View Discourse Senses(will show the scope of discourse senses as coloured line within the text. Mouse-over will make the sense tag visible)


As part of the Metadata section, to the right of the text area, you define the source language of your text by picking its name from the ISO list of the World's languages. Quite a few languages are known under several names. You might want to check Glottolog or Ethnologue

Some of the above mentioned functions open additional windows which you can freely moved within your browser window.

The Annotation Table

Also the tabular IGT editor opens in an extra window, and is freely moveable so that you can annotate a phrase with its textual context still visible in the background. You can open instantiated phrases (the green (not yet annotated) and the blue (annotated) either directly from the text area by double clicking them, or from your *View phrases* tab. Sentences stay open in your tabular editor unless you close them explicitly. This allows you to work with several phrases at the same time, and by sizing and moving the tabular editor window you always have direct access to the whole text.

The tabular editor gives you access to a Valance annotation set, and to the Sense tiers which allow you to annotate for discourse senses.

More about the Editor you find here: following this link








  1. The main difference between *Go* and *Search* is that *Go* brings you directly to the page with the title that you have typed into the search window. *GO* also allows you to create a page of that name in case that it does not exist yet