Typecraft v2.5
Jump to: navigation, search

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

 
(12 intermediate revisions by the same user not shown)
Line 1: Line 1:
{{TcCopyEdit}}
 
 
 
 
==TypeCraft 2.0 Editor==
 
 
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===
 
===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.
+
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 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,
+
You find the login button in the upper right corner. Press this button and follow the instructions.
  
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.  
+
After filling in the required login information, you will receive a confirmation mail from TypeCraft. After receiving the confirming mail, go back to TypeCraft page and login. The use of the system is free of charge,
  
[[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.
+
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 account.  
  
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.
+
Your name 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 your user page to make it your profile page at TypeCraft.  
  
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.  
+
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 your project pages to the TC-wiki.  
  
  
 +
===My preferences===
 +
Using the  ''Preferences'''button, (right upper corner of your TypeCraft window) you can customize 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 customize 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* 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. *Search* will consist of TypeCraft wiki pages from different namespaces that contain the search term.
  
 
+
Namespaces are used by this MediaWiki to create collections of wiki pages. ''Preferences'' allows you to set the namespaces in which the TypeCraft wiki should search. Next to
====My preferences====
+
the standard namespaces found on any MediaWiki, TypeCraft uses its own namespaces. It therefore is best that you search in the following namespaces:
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
+
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 46: Line 32:
 
:: '''Help'''
 
:: '''Help'''
  
When in *my preference* select -> User profile -> *SEARCH*, and select the relevant namespaces by ticking of boxes. Save your preferences.
+
When in *Preference* select User profile *SEARCH*, and select the relevant namespaces by ticking of boxes. Save your preferences.
  
  
 +
===The TypeCraft  Editor===
  
 +
[[File:tooltabs.jpg|thumb|600px|left]]
  
  
 +
The TC Editor consists of a text area from which you have access to the tool tabs which give you access to all main functions.
 +
The upper tool tab row (which appears in light yellow in the screenshot to the left) lead you to Text and Phrase related functions. You can export one or several phrases you can stage them for annotation or delete them.
  
 +
Also Editor Themes can be chosen from the upper Tool tabs menu which allows you to customize the looks of your editor.
  
  
Line 58: Line 49:
  
  
 +
The following list gives an overview of  functions: 
  
 +
:: '''Save''' (saves your text)
 +
:: '''Share''' (texts can be shared between TypeCraft users. The groups that you are a member of will show in a drop down.  Select a group and click. Your text is now available to all members of this group.
 +
:: '''Publish''' (allows you to make your text accessible to the public)
 +
:: '''Template''' (saving one of your texts as a template, allows other users to make a copy of that text. (experimental function)
 +
:: '''New Phrase''' (after highlighting a segment in your text area, you can use this function to create a new annotation unit)
 +
:: '''Delete Phrase''' (the function allows you to delete the activation of a text segment as an annotation unit. Note that the text element itself will not
 +
:: be deleted)
 +
:: '''View Phrase List'''(will show your instantiated phrases in an annotation table)
 +
:: '''View Discourse Senses'''(will show the scope of discourse senses as a coloured line within the text. Mouse-over will make the sense tag visible (experimental function).
 +
  
 +
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]
  
====TypeCraft 2 Editor - What is new?====
+
Some above-mentioned functions open additional windows, which you can freely move within your browser window.
  
 +
===The Annotation Table===
  
 +
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 ones are not yet annotated while the blue one carry annotations. You can double-click a blue phrase to open it in the annotation table. You can also open phrases form the  *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 will always have direct access to the whole text.
  
 +
====Advanced Functions====
 +
The tabular editor allows you to create further layers of annotation. Valence can be annotated using a  closed set of categories. Values can be selected from drop down menus.
  
 +
The editor features in addition a Sense tier, which can be evoked from the annotation interface.
  
 
+
More about the Editor you find here:
===Annotating with the TypeCraft 2 Editor===
+
[[:Help:How_to_annotate_in_TypeCraft_-_a_practical_guide| following this link]]
 
+
  
  
Line 85: Line 92:
  
  
 
+
<references/>
===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>
+
 
+
<reference/>
+

Latest revision as of 16:00, 18 August 2021

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 public.

You find the login button in the upper right corner. Press this button and follow the instructions.

After filling in the required login information, you will receive a confirmation mail from TypeCraft. After receiving the confirming mail, go back to TypeCraft page and login. 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 account.

Your name 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 your user page to make it your profile page at TypeCraft.

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 your project pages to the TC-wiki.


My preferences

Using the Preferences'button, (right upper corner of your TypeCraft window) you can customize 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 customize 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* 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. *Search* will consist of TypeCraft wiki pages from different namespaces that contain the search term.

Namespaces are used by this MediaWiki to create collections of wiki pages. Preferences 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 *Preference* select → User profile → *SEARCH*, and select the relevant namespaces by ticking of boxes. Save your preferences.


The TypeCraft Editor

Tooltabs.jpg


The TC Editor consists of a text area from which you have access to the tool tabs which give you access to all main functions. The upper tool tab row (which appears in light yellow in the screenshot to the left) lead you to Text and Phrase related functions. You can export one or several phrases you can stage them for annotation or delete them.

Also Editor Themes can be chosen from the upper Tool tabs menu which allows you to customize the looks of your editor.



The following list gives an overview of functions:

Save (saves your text)
Share (texts can be shared between TypeCraft users. The groups that you are a member of will show in a drop down. Select a group and click. Your text is now available to all members of this group.
Publish (allows you to make your text accessible to the public)
Template (saving one of your texts as a template, allows other users to make a copy of that text. (experimental function)
New Phrase (after highlighting a segment in your text area, you can use this function to create a new annotation unit)
Delete Phrase (the function allows you to delete the activation of a text segment as an annotation unit. Note that the text element itself will not
be deleted)
View Phrase List(will show your instantiated phrases in an annotation table)
View Discourse Senses(will show the scope of discourse senses as a coloured line within the text. Mouse-over will make the sense tag visible (experimental function).


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 above-mentioned functions open additional windows, which you can freely move within your browser window.

The Annotation Table

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 ones are not yet annotated while the blue one carry annotations. You can double-click a blue phrase to open it in the annotation table. You can also open phrases form the *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 will always have direct access to the whole text.

Advanced Functions

The tabular editor allows you to create further layers of annotation. Valence can be annotated using a closed set of categories. Values can be selected from drop down menus.

The editor features in addition a Sense tier, which can be evoked from the annotation interface.

More about the Editor you find here: following this link