Difference between revisions of "Help:QuickStart"

Latest revision as of 15:58, 25 December 2017

Also look at:

The TypeCraft wiki
- Posting
- Searching

You enter the editor by clicking on TypeCraft Menu -> TypeCraft editor -> New text on the TypeCraft navigation bar. "Text" here refers to any written material that you would like to submit to the editor for annotation. After clicking on New text the editor loads an empty text field with a template for meta data on the right, as shown in the screen shot below. (Click on the picture to enlarge it.)

the Editor text area-no text loaded yet

The editor's text area allows basic formatting of your text (see screenshot to the left). To the right of the text area the Metadata matrix is accessible. We offer a default Metadata template and additional specialized templates to which you can change by using the *Change Metadata set* bottom at the bottom of the template section.

You enter your text into the text area by copying & pasting text from a file or from an online site into the text area. You then select the text's language in the metadata template and provide the rest of the metadata. You can always come back to completing meta information.

Back to the text area you now define what we call Phrases for annotation. TypeCraft phrases may be sentences or fragments. Text does not need to be annotated sentence by sentence. You select an element for annotation by highlighting it. You then press the New Phrase button which will put the selected element into the Phrase list. In the text area this phrase now appears in green. If you would like to annotate the whole text, press New Phrase without selecting anything. Follow the instructions given in the dialog window.

You can start to annotate in several ways. You double-click on one of the instantiated (green) elements in the text area, or you open the Phrase list by clicking on *View Phrase list* and select the phrase that you would like to annotate.

When the phrase opens, a dialogue window pops-up with the following message:

 TypeCraft wants to know 
 which of the following options you prefer:
 1. to insert full forms into the table directly (recommended).
      Choosing this option allows you to separate affixes from word stems
      in the input mask below. Insert hyphens "-" or spaces " " to indicate morph 
      or word boundaries and then click OK.
 2. to manually insert words from your phrase into the table.
      For this option, click *Cancel* and an empty table will appear.

After you have decided between these options, i.e., whether you would like to work with a pre-filled table which realizes your choices of morph boundaries, or you would like to start with an empty table, the tabular editor will open, respectively, pre-filled or empty.

You annotate by navigating through the table. We recommend that you add annotations to the tiers vertically by making use of the space bar for traversing the table in a vertical fashion. This method is in our experience the fastest.

The *WORD* and the *MORPH* tiers feature a menu bar which allows you to modify existing entries. The menu bar appears when you activate the field you want to change by clicking on it. From the menu (visible as grey lines on the right of the field) you can also add words or change the word's segmentation.

Gloss* and *POS* tags are chosen from predefined lists. You find an overview over all Gloss and POS tags in you TypeCraft Tools on the navigation bar (on the left of your browser window). These lists are auto-generated and can be ordered by category at your convenience. The lists also provide short definitions for each tag.

The annotation table is supplemented by a large note field. Notice that also the content of the note field can be searched, and if you use a designated marker to flag sentences that you would like to target by a search, this can be done easily in the note field. Is the annotation of a phrase questionable, for example, you could add a question mark to the Note field. A search for "?" in the note field will then allow you to search only for sentences with questionable annotations.

Aside from the features already mentioned, one can annotate also for valence and for discourse sense. For these, see How to annotate in TypeCraft - a practical guide, and Multi-level linguistic annotation with TypeCraft.

Search for Interlinear Glossed Text in the TC database

You enter the search facilities by clicking on TypeCraft Menu -> TypeCraft Search, from which you have access to Text search and Phrase search.

Text search

Text search allows you to find Interlinear Glossed Texts in the TypeCraft IGT database.

Since TypeCraft data is structured throughout, you can use many different search criteria to find the type of text you are looking for. You also can decide if you would like to look only in your own data, or if you intend a general search in TypeCraft data.

Using Metadata information as search term, you can for example ask for the name of the text owner, when the text was modified last, and of course for the language. Strings or sub-strings of the text title or the title translation can be used directly as search terms.

Valence over Sense annotations as well as Gloss and Part of Speech tags can be used to select texts that contain them. One or several tags in combination can be specified as search terms, and their scope can be defined.

Also strings or sub-strings contained in the Note field can be used to search for texts.

Go to the Text search on your navigation bar to look for the other search options.

The screenshot above shows a partial result for a search of texts that contain thematic annotations; the GLOSS tags BEN(eficiary) and GOAL were used as search terms, and 38 texts were found with 127 instances for the search term GOAL and 154 instances for the search term BEN(eficiary).

Phrase search

Phrase search is equally fine-grained as text search. Next to specifying textual, phrasal, word and morpheme properties in order to inform your search, you can define the scope of your search.

For example: When defining two Gloss tags as search terms you can choose the search scope such that you only look for glosses that specify the same morpheme, as it would be the case for the 3SG and PRES gloss tags relative to the English verb suffix -s in the word goe-s.

You might instead define that certain search terms should occur on the same word, or occur in the same phrase.

As for text search, also the result of a phrase search is displayed showing the number of phrases found and the number of instances that were found for each of the search terms.

Search in the TypeCraft wiki

To access the wiki pages for search, write part of the name of the page wanted into the Search TC-wiki slot in the upper right cormer. You can choose between coontinuations of the name, and a Search results page will open, either with the desired page, or a set of Page title matches, between which you can further select.

For further specification of the search domain, see Searching .

If you want to search by general content rather than the name of a page, you can type into the Search TC-wiki slot in the upper right cormer the string "Category:", and a range of categories of wiki pages will show up. Clicking on either of these, all wiki pages falling within the category will show up.

The TypeCraft Importer

The TypeCraft Importer allows you to import structured data from other application. At present we support import from Toolbox WORD (txt) import of IGT and the import of TC XML.

Your files or the material that you provide in the Importer's text area will after import be accessible in *Your text* which you access from the TypeCraft navigation bar after login.

The TypeCraft Importer can also be used to import Norwegian text (Bokmål or Nynork)for Part of Speech tagging. The tagged output becomes accessible under *My text * for further annotation.

For a more detailed description of the TypeCraft Importer go Help: The TypeCraft Importer

@@ Line 1: / Line 1: @@
-{{TcCopyEdit}}
+Also look at:
+* [[Help:The_TypeCraft_Editors_for_Newcomers| '''Newcomers''']]
+* [[Help: How to search in TypeCraft| '''Database search''']]
+* '''The TypeCraft wiki'''
+** [[Help:Posting_on_the_TypeCraft_Wiki|'''Posting'''  ]]
+** [[Help:Searching_in_the_TypeCraft_Wiki|'''Searching''' ]]
+===How to annotate new text in the TC database===
-=This is the TypeCraft QuickStart Guide=
+ Link to a more detailed introduction  [[Help:How_to_annotate_in_TypeCraft_-_a_practical_guide| Using the '''TypeCraft Editors''']]
-For more information about linguistic online editing with TypeCraft, search in the TypeCraft database, exporting TypeCraft data, or editing the TypeCraft wiki, please consult
-one of the following TypeCraft wiki pages:
-* Help with the TypeCraft Editor [[Help:The_TypeCraft_editor_for_Newcomers|for Newcomers]]
-* Help with the using the [[Help:How_to_annotate_in_TypeCraft_-_a_practical_guide|TypeCraft Editor]]
+You enter the editor by clicking on '''TypeCraft Menu''' -> '''TypeCraft editor''' -> '''New text''' on the TypeCraft navigation bar. "Text" here refers to any written material that you would like to submit to the editor for annotation. After clicking on '''New text''' the editor loads an empty text field with a template for meta data on the right, as shown in the screen shot below. (Click on the picture to enlarge it.)
-* Help with posting on the [[Help:Posting_on_the_TypeCraft_Wiki#Help_with_editing_in_the_TC_wiki|TypeCraft Wiki ]]
-* Help with Search in Typecraft data
-* Help with Editing the TypeCraft wiki
-==Help with the TC Editors==
-===Annotation using the TypeCraft 2.0 editor===
-You enter the TC2 editor by clicking on '''New text''' one the TypeCraft navigation bar. The editor opens a dialog window with the following message:
- Your text will use the new and better TC editor.
- If for some reason you want to use the old editor choose
- No below.
-The word "Text" in the phrase "Your text" above refers to any piece of digital writing not yet linguisticaly annotated. To annotate this text in the new editor, you now press "yes".
 [[File:TCeditor1.jpg|thumb|250px|left|the Editor text area-no text loaded yet ]]
-The editor's text area opens (see screenshot to the left). To the right the Metadata matrix is accessible. We offer a default Metadata template and a
+The editor's text area allows basic formatting of your text (see screenshot to the left). To the right of the text area the Metadata matrix is accessible. We offer a default Metadata template and additional specialized templates to which you can change by using the *Change Metadata set* bottom at the bottom of the template section.
-template for the [http://www.skrivesenteret.no/ Norwegian Centre for Writing and Writing Research]. (You find a *Change Metadata set* bottom at the end of the template.)
-You enter your text into the text area by copying & pasting text from a file or from an online site into the text area. Next you select the text's lanuage in the metadata template and provide the rest of the metadata. You always can come back to this, and fill in missing information.
+You enter your text into the text area by copying & pasting text from a file or from an online site into the text area. You then  select the text's language in the metadata template and provide the rest of the metadata. You can always come back to completing meta information.
-Back to the text area you now define what we call ''Phrases'' for annotation. TypeCraft ''phrases'' might be sentences or fragments. Also, text does not need to be annotated sentence by sentence, although that is also possible by ..............
+Back to the text area you now define what we call ''Phrases'' for annotation. TypeCraft ''phrases'' may be sentences or fragments.
-............... .
+Text does not need to be annotated sentence by sentence. You select an element for annotation by highlighting it. You then press the '''New Phrase''' button which will put the selected element into the '''Phrase list'''. In the text area this phrase now appears in green.
+If you would like to annotate the whole text, press '''New Phrase''' without selecting anything. Follow the instructions given in the dialog window.
-You select an element for annotation by highlighting it. You then press the '''New Phrase''' button which will put the selected element into the '''Phrase list'''. In the text area this phrase now appears in green.
-Now it is time for starting with the core annotation. You can do that in two ways. You double-click on one of the instantiated elements in the text area (those sentence in green colour), or you open the Phrase list by clicking on *View Phrase list*.
+You can start to annotate in several ways. You double-click on one of the instantiated (green) elements in the text area, or you open the Phrase list by clicking on '''*View Phrase list*''' and select the phrase that you would like to annotate.
-When the phrase opens a dialogue window pops-up with the following message:
+When the phrase opens, a dialogue window pops-up with the following message:
    '''TypeCraft wants to know '''
- which of the following options you prefer:
+  which of the following options you prefer:
 . to insert full forms into the table directly (recommended).
         Choosing this option allows you to separate affixes from word stems
         in the input mask below. Insert hyphens "-" or spaces " " to indicate morph
         or word boundaries and then click OK.
 . to manually insert words from your phrase into the table.
         For this option, click *Cancel* and an empty table will appear.
-====The tabular annotation editor====
+After you have decided between these options, i.e., whether you would like to work with a pre-filled table which realizes your choices of morph boundaries, or you would like to start with an empty table, the tabular editor will open, respectively, pre-filled or empty.
-After you have decided whether you would like to work with a pre-filled table which realises your choices of morph boundaries, or you would like to start with a
-clean table, the tabular editor will open, respectively, pre-filled or empty.
-You annotate by navigating through the table. We recommend that you add annotations to the tiers vertically by making use of the space bar. This method is in our experience the fastest.
+You annotate by navigating through the table. We recommend that you add annotations to the tiers vertically by making use of the space bar for traversing the table in a vertical fashion. This method is in our experience the fastest.
- ''' To learn more about the tiers and annotation tags and levels go to'''
+The *WORD* and the *MORPH* tiers feature a menu bar which allows you to modify existing entries. The menu bar appears when you activate the field you want to change by clicking on it. From the menu (visible as grey lines on the right of the field) you can also add words or change the word's segmentation.
-          '''[[Multi-level linguistic annotation with TypeCraft]]'''
-The *WORD* and the *MORPH* tiers feature a menu bar which allows you to modify existing entries. The menu bar appears when you activate the field you want to change. From the menu you can also add words or change the word's segmentation. *Gloss* and *POS* tags are chosen from a predefined list. You find an overview over all Gloss and POS tags on your navigation bar. These lists are auto-generated and can be ordered by category at your convenience. The lists also provide short definitions for each tag.
+*Gloss* and *POS* tags are chosen from predefined lists. You find an overview over all Gloss and POS tags in you '''TypeCraft Tools''' on the navigation bar (on the left of your browser window). These lists are auto-generated and can be ordered by category at your convenience. The lists also provide short definitions for each tag.
-The annotation table is supplemented by a large note field. Notice that also the content of the note field can be searched, and if you for example use a designated marker to
+The annotation table is supplemented by a large note field. Notice that also the content of the note field can be searched, and if you use a designated marker to flag sentences that you would like to target by a search, this can be done easily in the note field. Is the annotation of a phrase questionable, for example, you could add a question mark to the Note field. A search for "?" in the note field will then allow you to search only for sentences with questionable annotations.
-flag sentences that you would like to target by a search, this can be done easily. Is the annotation of a phrase questionable, you could add a question mark to the Note field. A search for "?" in the note field will then allow you to target by a search only sentences with questionable annotations.
-====Annotation for Valence using the Construction description template====
+Aside from the features already mentioned, one can annotate also for '''valence''' and for '''discourse sense'''. For these, see [[How to annotate in TypeCraft - a practical guide]], and [[Multi-level linguistic annotation with TypeCraft]].
-You enter the valence annotation mode from the tabular editor by pressing the * Change* to the
-right of the label '''Valence''' which you find above the word- and morph-level annotation table.
-An additional annotation windows,as shown in the screenshot to the left, appears and allows you to specify valency attributes using a predefined vocabulary.
+===Search for Interlinear Glossed Text in the TC database===
+You enter the search facilities by clicking on '''TypeCraft Menu''' -> '''TypeCraft Search''', from which you have access to '''Text search''' and '''Phrase search'''.
-[[Image:ValenceAnno.jpg|thumb|500px|left|Valence Annotation Schema]]
-While the valence annotation schema is still under development, we allow at this point we the input of the following attributes:
+====Text search====
-    * Syntactic Argument Structure   * Salient Sentence Pattern
+Text search allows you to find Interlinear Glossed Texts in the TypeCraft IGT database.
-    * Situation Type                 * Force & Eventuality
-    * Diathesis                      * Modality
-    * Adjunct of Interest            * Sentence Aspect
-[[Image:Menu Valence.jpg|thumb|200px|right| Drop-down window for the attribute Syntactic argument structure]]
-Each of these attributes has a set of possible values. Some of thehe values for the attribute Syntactic Argument Structure are shown to the the right in the wayleft:
+[[File:Search1.jpg|thumb|700px|left]]
-they appear in the drop-down window.
+Since TypeCraft data is structured throughout, you can use many different search criteria to find the type of text you are looking for. You also can decide if you would like to look
+only in your own data, or if you intend a general search in TypeCraft data.
-More about Valence annotation in TypeCraft can be found under:
+Using Metadata information as search term, you can for example ask for the name of the text owner, when the text was modified last, and of course for the language.
+Strings or sub-strings of the text title or the title translation can be used directly as search terms.
-   ''' To learn more about Valence annotation in TypeCraft go to'''
+Valence over Sense annotations as well as Gloss and Part of Speech tags can be used to select texts that contain them. One or several tags in combination can be specified as search terms, and their
-          '''[[Multi-level linguistic annotation with TypeCraft]]'''
+scope can be defined.
-When finished with the annotation of valency you return to your tabular annotation editor, where the valence values now appear as a hyphenated string (as shown in the screen shot to the right) exposing the valency specifications that you have chosen for the phrase under annotation.
+Also strings or sub-strings contained in the Note field can be used to search for texts.
-===Export===
+Go to the [[:Special:TypeCraft/SearchText/ |Text search]] on your navigation bar to look for the other search options.
-The TypeCraft user-interface allows for several forms of export:
-* Export to the TCwiki
+The screenshot above shows a partial result for a search of texts that contain thematic annotations; the GLOSS tags BEN(eficiary) and GOAL were used as search terms,
-* Export to HTML
+and 38 texts were found with 127 instances for the search term GOAL and 154 instances for the search term BEN(eficiary).
-* Export to WORD and Open Office
-In your TypeCraft Editor go to the tab *Phrase* in the upper left corner of your editor window. When pressing on *Phrase* a drop-down window opens. Select the first option which is: *Export*.
-====Export to the TCwiki====
-For a description of the export to the TCwiki, please follow this link: [[TypeCraft Export|Export to the TC wiki]].
+====Phrase search====
+Phrase search is equally fine-grained as text search. Next to specifying textual, phrasal, word and morpheme properties in order to inform your search, you can define the scope of your search.
+For example: When defining two Gloss tags as search terms you can choose the search scope such that you only look for glosses that specify the same morpheme, as it would be the case
+for the 3SG and PRES gloss tags relative to the English verb suffix ''-s'' in the word ''goe-s''.
+You might instead define that certain search terms should occur on the same word, or occur in the same phrase.
+As for text search, also the result of a phrase search is displayed showing the number of phrases found and the number of instances that were found for each of the search terms.
-===Export to WORD and Open Office===
-The export to WORD or Open Office is done through several simple steps:
-Go to the TypeCraft Editor by opening *My texts*. You select one of your texts and open it. This can look for example like this:
-[[File:Export.png|thumb|500px|left|click on the picture to enlarge]]
+===Search in the TypeCraft wiki===
+To access the wiki pages for search, write part of the name of the page wanted into the '''Search TC-wiki''' slot in the upper right cormer. You can choose between coontinuations of the name, and  a '''Search results''' page will open, either with the desired page, or a set of ''Page title matches'', between which you can further select.
-As shown in the picture on the left, you can now select the sentences that you would like to export by marking them in the check boxes on the left of the instantiated sentences (the blue sentences to the right of the Editor window).
+For further specification of the search domain, see [[Help:Searching_in_the_TypeCraft_Wiki|'''Searching''' ]].
-Go to the tool tabs of the Editor window and select Phrases -> Export -> HTML (just as it is shown in the picture). You have the choice of exporting the examples with or without border. Make your choice and save the Tc-export file to your computer. (You will see a small pop-up window that asks you to either open or save the Tc-export file. You should save the file.)
-When you now open the exported file on your machine, the default option that you will be presented with is to open the file in your browser (for example Firefox,Chrome, IE or Safari). In order to save the Tc-export file as a WORD or Open Office document you have to open the file by choosing the option *Open with* -> WORD or Open Office. Notice that the imported examples can still be manipulated. For example you might want to change the font size or highlight certain glosses, add colour or borders.
-===Share your text with a group===
+If you want to search by general content rather than the name of a page, you can type into the '''Search TC-wiki''' slot in the upper right cormer the string "Category:", and a range of categories of wiki pages will show up. Clicking on either of these, all wiki pages falling within the category will show up.
-This is a feature of your TypeCraft editor that must be set by the [mailto:ldd.workshop@hf.ntnu.no system administrator]. In your mail to the administrator, please state which name you wish for your group (for example the name of your project or the name of the language you work on), and the TypeCraft user names of all members of the group that you would like to start. The system administrator will create the group for you. This will not take very long, and when the group is created, you can start to assign texts to your group, by selecting in your TypeCraft Editor from the *Share with group* line your group.
-===Annotation using the TypeCraft 1.0 editor===
+===The TypeCraft Importer===
-<span style="color: grey;">Click *My Text* in the navigation-bar. The TC Editor opens. You may now enter or copy-and-paste a text into the left part of the editor window.
+The TypeCraft Importer allows you to import structured data from  other application.
-Do not add morph boundaries at this point. At this point the TC Editor only accepts text strings. Before you start to tokenize your text strings,
+At present we support import from Toolbox WORD (txt) import of IGT and the import of TC XML.
-determine the language of your text by going to the *CHANGE* button. TC uses the ISO-639-1 code for languages. Please use the drop-down window
-to select one of the ISO language namYour text will use the new and better TC editor.</span>
-<span style="color: grey;">If for some reason you want to use the old editor choose No below.s. Give your text a title and a title translation if appropriate. Text title and title translation will inform *Text search* and therefore should be chosen with care.</span>
-'''Tokenization'''
+Your files or the material that you provide in the Importer's text area will after import be accessible
-<span style="color: grey;">You can tokenise your text into sentences. This generally works quite well. TypeCraft has at this point still problems with period signs for example in titles like ''Mr.'' or ''Dr.'' and semicolons. In order to tokenise you text or collection of sentences press *CREATE PHRASES*; this will initiate the tokenization. Inspect the result before you choose *Yes* from the dialogue box. If you have not highlighted parts of your text, TC will ask you whether you would like to tokenize the whole text. Say *Yes*. The tokenization can be repeated several times until you are content with the result.</span>
+in '''*Your text*'''  which you access from the TypeCraft navigation bar after login.
-'''Morph break-up'''
+The TypeCraft Importer can also be used to import Norwegian text (Bokmål or Nynork)for Part of Speech tagging.
-Select a sentence from the set of tokenised sentences which now have appeared on the right hand side of your editor window. Click on one sentence. This will open a dialogue box. Follow the instructions in the dialogue box to insert morph boundaries into the annotation table.
+The tagged output becomes accessible under ''' *My text * ''' for further annotation.
-'''Annotation Table'''
+For a more detailed description of the TypeCraft Importer go [[Help: The TypeCraft Importer]]
-Navigate through the annotation levels vertically by making use of the space bar. The *WORD* and the *MORPH* tier feature a menu bar which allows you to delete words/morphs which appear when you click on the field in those rows that you would like to change. From the menu you can also add words or change the word segmentation. *Gloss* and *POS* tags are chosen from a predefined list. You find an overview over all Gloss and POS tags on your navigation bar. These lists are auto-generated and can be ordered by category at your convenience.
-</span>