Difference between revisions of "StandaloneClient"

Revision as of 19:53, 18 March 2010

The TypeCraft client is a pure Java application.

REQUIREMENTS to run the TypeCraft client:

   * Java (version 6) 

INSTALLATION

[Microsoft Windows users]

   * download and run MS Windows installer: [TCc-setup.exe]

[Ubuntu/Debian Linux users]

   * download the run installer: [tcc_1.9100318-1_all.deb]
   * if it does not run automatically, you can use the following command: 
       * sudo dpkg -i tcc_1.9100318-1_all.deb

[other users]

   * download and unpack compressed archive file [TCc.zip] 
   * run the JAR file 'TCc.jar' inside of the TCc directory:
      * (double) click on the JAR file;
      * OR right click on the JAR file and choose 'open with Java';
      * OR alternatively, you have to run the following command in your terminal:  'java -jar TCc.jar'.

Bugs:

Please report bugs in the standalone client on the StandaloneClientBugs StandaloneClientDesignsuggestions wiki page.

STARTUP

The application requires a few seconds to become fully operational.

MAIN WINDOW

The main window "TypeCraft Client" appears when the application is fully initialized. Click on one of the buttons on the left to proceed further. The application will shut down when this window is closed (to close the window, click on the small X in the top right corner).

• "new text" button: opens a entirely new text in a new "Text" window.
• "my texts" button: displays all texts currently on your computer in the main window.
• "text search": opens the "Text Search" window.
• "phrase search": opens the "Phrase Search" window.
• "POS tags": displays the list of part-of-speech tags in the main window.
• "gloss tags": displays the list of gloss tags in the main window.
• "remote login": sends a login request to the central TypeCraft server.
• "config": displays configuration options in the main window.
• "about": displays a short application description in the main window.
• "log": displays the TypeCraft log in the main window.

MY TEXTS

Displays all TypeCraft texts currently on your computer. These texts were either created via the "new text" button, or were downloaded from the central TypeCraft server (via "text search).

The "server" column is checked if the local text is associated with a text on the central TypeCraft server. If the text was originally downloaded from the central TypeCraft server, the table will also display the text's owner [NOTE: due to current technical limitations, the username displayed is fixed on downloading the text; and uploaded texts display no username]. The remaining columns display language, text title, text title translation, and date last changed [NOTE: due to current technical limitations, date last changed is initially set to download date for downloaded texts].

Right click on the table to bring up a popup menu. Options are: "local copy" and "delete". Use "local copy" to sever the connection between a local text and it's corresponding server text (any subsequent upload of the text with create an entirely new text instance on the server).

Left click on the table to open a text for editing (in a "Text" window).

TEXT WINDOW

A "Text" window is brought up via the "new text" button, by clicking on a text in an appropriate table (eg. "My Texts", "Text Search" results), or via requesting the mother text of a phrase. The local identifier number of the text is displayed in the window title. The window may be closed by clicking on the small X in the top right hand corner (NOTE: if the text fields are incomplete it cannot be closed, only deleted).

A text contains the following editable fields:

• language
• title
• title translation
• group
• publish
• (plain) text
• notes

The fields "language", "title", "title translation" and "text" must be instantiated. If they have not been correctly filled in, the only way to close the text window is to delete the text. The "language" field provides basic tab completion.

The "notes" field is displayed immediately underneath the "text" field. Notes are stored on the local machine, but cannot be uploaded to the central TypeCraft server.

At the top of the window is a small menu: "options". Use this to close or delete the text.

At the bottom of the window are two buttons:

• "upload text": use this to upload the text on your computer to the central TypeCraft server. If the text is a server text (see explanation in MY TEXTS) then the corresponding text on the server is modified; if the text is not a server text then the text is saved as a new text instance on the central TypeCraft server.

• "create phrases": use this to create new phrases, based on the cuttently selected text in the plain text field.

The text's phrases are displayed in a scroll pane in the centre of the window. Left click a phrase to open a "Phrase" window. Right click after selecting one or more phrases (via CNTRL + left click) to activate the phrase popup menu:

• export
  • HTML
  • XML
  • LaTeX
• prepare for wiki
• delete

PHRASE WINDOW

A "Phrase" window is brought up by clicking on a phrase in an appropriate table (eg. in a "Text" window, "Phrase Search" results). The local identifier number of the phrase is displayed in the window title. The window may be closed by clicking on the small X in the top right hand corner (NOTE: if the phrase fields are incomplete it cannot be closed, only deleted).

A phrase contains the following editable fields:

• validity (combo box)
• phrase
• translation
• construction parameters
• construction description
• words table

The fields "phrase" and "translation" must be instantiated. If they have not been correctly filled in, the only way to close the text window is to delete the phrase.

The "notes" field is displayed at the bottom of the window. Notes are stored on the local machine, but cannot be uploaded to the central TypeCraft server.

At the top of the window is a menu: "options":

• export
  • HTML
  • XML
  • LaTeX
• prepare for wiki
• delete
• text
  • open
• close

The WORDS TABLE is displayed in a scroll pane in the centre of the window. Each column is a word. Word fields are: latinised, POS, and the morpheme fields (a word is composed of one or more morphemes). The POS field is equipped with basic tab-completion. The morpheme fields are: morpheme, meaning, gloss. Glosses are represented as a "." separated list of gloss tags, equipped with basic tab-completion. To edit a POS or gloss field, click it; to edit the other fields, double click [NOTE: fix me].

To bring up the popup menu over the words table, right click. You will be presented with the following "word" options:

• word of interest
• add word before
• add word after
• delete word
• rename word

and, if appropriate, the following "morpheme" fields:

• add morpheme before
• add morpheme after
• delete morpheme

TEXT SEARCH WINDOW

A "Text Search" window is brought up via the "text search" button.

The window contains three fields: "title", "title translation" and "language". The last field is equipped with basic tab-completion.

The window contains three buttons, and a results table.

Button "local search" runs a search against the texts on the local machine.

Button "server search" runs a search against the texts on the central TypeCraft server. This requires a valid username and password (specified in the "config" pane of the main window).

Button "reset" rests all search fields.

Click on a text in the results table to open it. If the search was performed on the server, the remote text will be downloaded to the local machine (NOTE: this may take some time).

PHRASE SEARCH WINDOW

A "Phrase Search" window is brought up via the "phrase search" button.

The window consists of the following sections:

• TEXT LEVEL
  • language (basic tab-completion)

• PHRASE LEVEL
  • global tagset
    • (fields of chosen tagset)
  • constr. description
  • phrase string
  • translation string

• WORD LEVEL
  • exact word
  • POS or POS or POS (with basic tab-completion)

• MORPHEME LEVEL
  • exact morpheme
  • meaning
  • gloss and/or gloss and/or gloss (with basic tab completion in "." separated list)

And two buttons: "search" and "reset".

Click search to bring up search results phrase table in a new window.

PHRASES (search result) WINDOW

Click on a phrase to open it. Right click to bring up popup menu (after selecting phrases via control-click):

• export
  • HTML
  • XML
  • LaTeX
• prepare for wiki

CONFIG PANE

Brought up via the "config" button in the main window.

Configuration parameters:

• htmlMaxWidth
  • max row width (in characters) for HTML export of phrases
• typecraftCentral URL
  • not editable; the location of the central TypeCraft server
• font
  • name (displays fonts which can handle the text in the test field in black, and other fonts in red)
  • size
  • test field (enter problematic characters here, and check the font combo box)
• remote login
  • username and password for central TypeCraft server.

Buttons: "save" (store configuration parameters), "cancel", and "hard reset" (reset all parameters to default values). Configuration parameters are stored between sessions.