Loading...
 

collaborative_terminology_platform_include_user_guide

Still to be done

IMPORTANT MESSAGE: installation of this profile is not yet over.

Next steps are described at the bottom of the administrator guide (section Finalizing installation of the terminology profile). Instructions in the present box should then be deleted (but instructions on the Administrator's Guide should be preserved for future reference.




Instructions for new users

This site supports multilingual collaborative terminology. If this is your first time here, please register so that you can specify your language preferences.

Specifying your language preferences allows for the display of records side by side in your first two preferred languages (the wiki allows for more than two languages at once).

First, register:
  • Click on the Register link.
  • Fill-in the form and click on the Register button.
  • One or two minutes later, you will receive an e-mail with a confirmation link. Click on that link.
  • Now that you are registered, you may specify your language preferences.

Please note that registration alone does not give you the right to modify records. One of the administrators may add you in the list of the Editors if it is necessary. If you think you should be an editor, please contact the administrators.

Specifying your language preferences

If you work mostly in a few languages (e.g. English and French), then you should specify your language preferences. The advantage of doing this is that when displaying a term in multiple languages, the system put your first two preferred languages side by side, for easier comparison.

Note however that you must first register on the site.

To change your language preferences:
  • Go here (or click on the link Preferences of the left menu)
  • Choose your mother tongue as your Preferred language, instructions of the site will then be displayed in that language.
  • Click on Can you read more languages?
  • Click on Select language...., and then on your second language.
  • You can repeat that step to add additional languages. Make sure you add the languages in the order that you most frequently use them.
  • Click on the Change preferences button located at the very bottom of the page.

Searching for a term

To search a term:
  • Type the term in the Search a term field of the Terminology module (usually located on the top right corner).
  • Select the the language for the search.
  • Click on the Go button.

If only one term is found, it is automatically displayed.

If you specified a second language in your language preferences, the system will display the terms side by side in those two languages.

When the system finds more than one term, it will displays the list of all terms matching your query.

Modifying an existing term

First, you must search for a term.

Then, simply click on the Modify button located under the term you want to modify.

If you do not see the Modify button, it means you are not in the Editors group. If you think you should be allowed to modify the records, please contact the administrators and ask them to add you to that group.

Creating a new term

To create a new term in a given language:
  • Type the term in the Search a term field of the Terminology module (usually located on the top right corner).
  • Click on the Go button.
  • If the term does not already exist, a button starting with caption Create the page appears. Click on that button.
  • This will create a page pre-filled with template fields. Simply fill the provided fields. For example, if you want to add a definition, simply erase the word None (located at the right of the __Definition__ tag), and replace it by your own definition.

Tip: The content of a terminology entry uses something called "wiki markup", to indicate where bold, italics, etc should appear. For example, the double underscores found in __Definition__, simply indicate that this word should be displayed in bold. In general, you will not need to modify or use such markup to enter data into a term entry. If you see some markup that you do not understand, simply leave it as is.

The one case where you may need to use wiki markups, is when you specify a new equivalent in the Synonyms and Acronyms section. See Adding more equivalents for a term section for details.

If you wish to use markup inside a term entry, there are several buttons located above the edit box, which can help you (for example, if you select some text and click on the big B icon, the appropriate markup will be inserted to make your selection bold).


Creating an equivalent in another language

When a term has no equivalent in a target language, you may proceed as follows:

  • Go to the chosen term.
  • Click on the Translate button located under the term.
  • Select the language for the new equivalent in the Language of the new page list.
  • Enter the equivalent in the Name of the new page field.
  • Click on the Create the translation button.
  • Delete the Translation in progress mention.
  • Write over or simply rewrite from scratch as you prefer.
  • Click on the Translation complete button.

Note: When you create a record based on existing content from another language, field names will remain in that language, unless you translate them yourself.

For example, if you create a record based on a French record, the Definition field will appear as Définition (i.e. with an accent).

The system will be modified in a near future, so that it translates the field names automatically.


Asking a question:

If you want to know how a term translates in a given language, you have two options:

Option 1: Ask your question on one of the forums. Once you know the answer, you may also wish to help the community by creating a page for this term. See section Create an equivalent in another language.


Option 2: Go to the term's page in the source language (or create it if it does not already exists), and add a comment asking for the equivalent in the target language. Click on the "watch this page" icon (the eye located at the top of the page) to tell the system that you want to be notified when this page is modified. The system will notify you when the record is modified, including when someone answers your comment.

Note: If you cannot create a message in the forum or insert a comment, it means you are not member of the Editors group. If you think you should be par of that group, please contact the administrators


Adding more equivalents for a term

If you know another translation for a term found, you can proceed as follows.

Simply modify the page for this term and add an alias in the section Synonyms and Acronyms.

To add an alias, you must enter (alias(other equivalent)), where "alias" is the word "alias" as such, while "other equivalent" is the new equivalent you want to add.

As an example, if you see a page "email client" and want to add "email reader", you modify the page "email client", and add (alias(email reader)).

Note: Do not put spaces between the word alias and the opening parenthesis.

Creating a record for a different meaning of an existing term

Very often, meaning of a term will be different according to the context or the domain. However, in the terminology tool that you are currently using, each word or expression is associated to a given record, and each record can only define one and only one meaning.

To deal with that while achieving the goal of having two records, simply create a new record for the new meaning. The name of the new record will have to be different from the existing one, which can be achieved by adding a few words prefixed by a double dash to avoid the ambiguity.

For example, suppose you want to create a record for term "terminal", in the context of transportation (i.e., the place where people get in or out of an aircraft or train), but find that you already have a record for "terminal" which captures the meaning of that word in the networking context (i.e., a node of a network).

You would create a term called "terminal --transports", and write the appropriate definition in it. It might also be a good idea to rename the other record from "terminal" to something like "terminal--computer science" (simply go to the "terminal" record and click on the Rename button).

IMPORTANT: Do not use parentheses!!!

Avoid creating a term such as "terminal (computer science)", as it is likely to cause problems. In particular, it will make it impossible to create hyperlinks to that term.


Contacting the administrators

Documentation to come...