IDM's Dictionary Publishing System Dictionary Editor tutorial
IDM – Dictionary Publishing System – Editor's documentation
Table of Contents I.Introduction......................................................................................................................... 2 The DPS : purpose and scope......................................................................................... 2 Intended users............................................................................................................. 2 Concepts and scopes.................................................................................................. 2 Dictionary Editor presentation.......................................................................................... 3 The table of content view............................................................................................. 4 The tree view............................................................................................................... 4 The preview................................................................................................................. 5 The toolbar................................................................................................................... 5 About this tutorial............................................................................................................. 5 II.Configuring your Dictionary Editor..................................................................................... 6 Defining the DPS server................................................................................................... 6 Customizing the GUI........................................................................................................ 6 Frame configuration..................................................................................................... 6 Colours and fonts......................................................................................................... 6 III.Editing basics................................................................................................................... 7 Downloading an editing task file....................................................................................... 7 Working on the editing task............................................................................................ 10 Expanding and conflating the structure...................................................................... 10 Content editing........................................................................................................... 11 Structure editing......................................................................................................... 14 Submit / Commit modifications...................................................................................... 18 Save on local hard drive............................................................................................ 18 Upload to server......................................................................................................... 19 IV.Advanced features......................................................................................................... 20 Managing user templates............................................................................................... 20 Saving a user template.............................................................................................. 20 Deleting / Renaming a template................................................................................. 21 Cross-references............................................................................................................ 23 Searching in the dictionary database............................................................................. 24 Search entries............................................................................................................ 24
Copyright IDM 2003-2004
Page 1 / 27
IDM – Dictionary Publishing System – Editor's documentation
I. Introduction The DPS : purpose and scope Intended users The Dictionary Publishing System (DPS) is used to create mono and bilingual dictionary databases, for both printed and electronic products. It enables the Lexicographers to focus on the creative process of lexicography and to work effectively and efficiently throughout the editorial cycle, without being constrained by the mechanics of dictionary production. On the other hand, Editors can easily manage tasks and assign them to Lexicographers, from a comprehensive and straightforward web administration tool.
Concepts and scopes A project defines a dictionary-editing project. Projects have a name, a description and are stored in a database on the main dictionary server. A role describes the part an employee takes in a project. For example: lexicographer, editor... A job could be seen as the way employees are allocated to a project, with a defined role. For example, an employee must have a job in a project to be allocated tasks. An entry is the DPS’s "minimum revisable unit", which is managed by the DPS system. All entries are gathered in a centralised database repository. Entries are made of elements (also called tags, like “Sense” or “Example”) organized and displayed under the constraints of a Document Type Definition (DTD). A task file is a set of entries temporarily allocated to a job (represented by an employee).
Copyright IDM 2003-2004
Page 2 / 27
IDM – Dictionary Publishing System – Editor's documentation
Dictionary Editor presentation The Dictionary Editor is the editing tool for creating and maintaining content of mono and bilingual dictionaries. It uses current IT technologies to fulfil your needs as a lexicographer. The XML editor automatically adapts itself to a specific project’s DTD, allowing you to structure the definitions accordingly. The dictionary editor window can be divided into four areas:
•
The Table of contents view
•
The Tree view
•
The Preview pane
•
The Toolbar.
These elements are presented in detail on the next pages.
Copyright IDM 2003-2004
Page 3 / 27
IDM – Dictionary Publishing System – Editor's documentation
The table of content view This frame shows the list of headwords of entries available in the downloaded Task File. Headwords of entries shown in blue represent entries that are currently displayed in the tree and preview panes. Headwords of entries, which do not meet the constraints of the DTD, are shown on an orange background (by default).
The tree view This is a structured view of the document in which structural elements are clearly identified (by their colour) from the editable data. All tags are visible and some of them are editable (according to the task configuration). Every tag (or element) has a name and an associated content.
You can use this view to edit structure and content of the document. When available, the absolute path to the current element is shown above this frame: . Copyright IDM 2003-2004
Page 4 / 27
IDM – Dictionary Publishing System – Editor's documentation
The preview This is a presentation format that is similar to the presentation used in the final product ( printed and / or electronic format ). Some tags are visible and some tags are editable depending on the task configuration set-up.
Sense numbers and delimiters can be automatically displayed in the preview pane, according to the project configuration.
The toolbar The toolbar contains clickable icons that manage the task file, modify structure, configure the editor and other features.
About this tutorial This tutorial is aimed at teaching editing processes using the Dictionary Editor. After a short presentation of the working environment, basic operations, and then more advanced features, are covered. Each section of the tutorial provides a brief description of the subject taken on. It is then put into practice, with an example you may reproduce on your system (paragraphs enclosed in a red frame).
Copyright IDM 2003-2004
Page 5 / 27
IDM – Dictionary Publishing System – Editor's documentation
II.Configuring your Dictionary Editor Defining the DPS server Prior to working with the Dictionary Editor, the DPS project server must be defined in the configuration window. Click on the Configuration button in the toolbar: Check that the Server string in the Configuration window is euralex2004.dps.dev.idm.fr, modify it if necessary then click the Save button to commit your changes.
Customizing the GUI Frame configuration The three frames that display the task file can be customised. To change the size of the frames in the editing environment, drag their inner borders when possible. The Preview and Table of Contents (TOC) panes can also be hidden at any time, and shown again if needed: •
to hide the Preview or TOC, use the toggle buttons in the toolbar (
•
once hidden, click the appropriate buttons to show the Preview or TOC (
or
) or
).
Colours and fonts The text appearance and layout are configured in a standalone CSS (Cascading Style Sheet) file. The administrator carefully designs it, in order to provide a well-balanced, relevant and attractive editing environment.
Copyright IDM 2003-2004
Page 6 / 27
IDM – Dictionary Publishing System – Editor's documentation
III.Editing basics Downloading an editing task file Each lexicographers group downloads its own task file. Before downloading a task file, make sure that the server you'd like to download from is properly specified in the configuration window ( see chapter II, Defining the DPS Server ) Click on the Download icon in the toolbar: Wait for the connection to the DPS server to be established, then following window is displayed:
Enter the user name and password that you were provided with, and click on OK. A list of available task files for download opens.
Copyright IDM 2003-2004
Page 7 / 27
IDM – Dictionary Publishing System – Editor's documentation
Tasks are broken down into four categories: to download, already downloaded, to revise and to revise (already downloaded). Not all categories are displayed, only those which actually contain files.
Copyright IDM 2003-2004
Page 8 / 27
IDM – Dictionary Publishing System – Editor's documentation
Only one task file should be displayed, click on the Download button to retrieve it. A new window is displayed:
Choose the original file version (in the example there is no other version, because you haven't worked on it before) of the task file, then click the Load File button.
Copyright IDM 2003-2004
Page 9 / 27
IDM – Dictionary Publishing System – Editor's documentation
Working on the editing task Expanding and conflating the structure In the tree view, the structure can be contracted and expanded by clicking the + and – just as you would do in the Windows Explorer.
Expand and collapse the elements at will.
Copyright IDM 2003-2004
Page 10 / 27
IDM – Dictionary Publishing System – Editor's documentation
Content editing Inserting, deleting text Select any element to edit by clicking it, either in the tree view or in the preview pane. The element turns green, which means it is now editable. On the screen shot below, the lexicographer has clicked on the Example content area, "a gallant young gentleman". The whole line has now a green background.
The editor behaves like most word processors. Try following manipulations: •
press the ARROW keys to move the cursor inside the text, and HOME / END to move to the bounds of the element
•
press SHIFT + (LEFT|RIGHT) ARROWS to make or extend a selection
•
CTRL + (LEFT|RIGHT) ARROWS makes the cursor move from one word to another
•
cutting, copying and pasting a selection can be done by respectively CTRL-C, CTRLX and CTRL-V shortcuts.
Validation and Undo commands follow the same logic: Enter some text in an EXAMPLE field. •
When you press ENTER the program validates the content of the current element, and moves the cursor to the next element that contains text.
•
If you press SHIFT-ENTER, the program validates the content of the current element, and moves the cursor to the previous element, which becomes editable.
•
the ESCAPE key cancels current modifications; the element's name background becomes dark blue, i.e. selected
•
the CTRL+Z combination undoes the last validated modification.
Copyright IDM 2003-2004
Page 11 / 27
IDM – Dictionary Publishing System – Editor's documentation
The Defining Vocabulary The DPS Administrator can associate a list of words that are allowed to use in the content of selected elements. The purpose is to restrict the words used in definitions ( or examples ) to a relevant semantic field. When a word that does not belong to the Defining Vocabulary is used in such an element, it is underlined in red:
Your DPS administrator may provide an element in the DTD associated with the task file to bypass the Defining Vocabulary restrictions. Type any well spelled text in a definition (DEF) field, then press ENTER. Notice how the word is underlined if it doesn't belong to the Defining Vocabulary. Searching text / elements You can search through a task file and the structure of the tree view using a dedicated search window. Press CTRL-F from anywhere in the application to launch the box:
To perform a search within the document: 1. enter a specific word or character string in the Search field, or leave it blank if you are only looking for a specific element, regardless to it's content, 2. select an element in the In and / or Parent drop-down lists, if you want to target your search to specific elements, 3. choose a search direction (Up or Down) from the current cursor position, selecting the appropriate radio button in the Direction frame, 4. if the search is to be case-sensitive (i.e. distinguishing upper case and lower case characters) check the Case-sensitive check box, 5. check the Wrap at the end of file check box, if you wish to restart the search process at the beginning of the file when the end is reached. Select any element in the tree view, and press CTRL-F. Enter an element name in the search field ( for example an entry name ) and click Next. Click Cancel once you have found an element matching the string you entered. Copyright IDM 2003-2004
Page 12 / 27
IDM – Dictionary Publishing System – Editor's documentation
Check Spelling
A standard spell checker can be associated to one or more elements. The spell checker automatically opens if the field contains possibly misspelled or non-existent words at validation time, and it suggests the most relevant words to replace them (i.e. those that are closest to the word not found in the spell checker dictionary). In the example above, the word “mesage” has been misspelled with only one “s”; the spell checker catches the error and the Check Spelling dialog box is displayed. Notice that the closest word is highlighted among a list of several alternatives. The Check Spelling dialog box contains several fields, which quote the current misspelled word (first text box) and show its position within the examined content (at the bottom), and suggest several alternative words you can choose from. Clicking the appropriate button on the right, you can either: •
Ignore the proposal for each misspelled word (confirmation required),
•
Ignore All proposals for every misspelled word encountered in the field,
•
Change the active word and replace it by the highlighted suggestion or
•
Change All misspelled words with the most relevant suggestion. Intentionally misspell a word and use the spell checker to correct it.
Copyright IDM 2003-2004
Page 13 / 27
IDM – Dictionary Publishing System – Editor's documentation
Structure editing To illustrate the element creation procedure, we will add a sense to an entry. Elements can be created within the structure of the definitions (gathered in the tree view) thanks to the Template Picker. Adding a sibling element Sister elements are tags of the same level in the tree. For instance, all dictionary Entries, Head and Sense elements within an entry ... Insert a new Sense element after any Sense of your choice. First select the Sense element, then to launch the Template Picker, either: • • •
right click on the element and choose Template Picker from the context menu, or click on the Template Picker button in the toolbar, or press CTRL-A
The template Picker is displayed:
Make sure that the After tab is active, choose the Sense element from the list and click Insert. The new Sense tag has been inserted after the selected element. It's content area is highlighted in yellow:
A Sense element cannot contain anything but other tags, we needn't enter any content in the field. Next step is to add child elements to the new Sense we are defining. Copyright IDM 2003-2004
Page 14 / 27
IDM – Dictionary Publishing System – Editor's documentation
Adding a child element Daughter elements make up the content of their related “mother” element. For instance, Head and Sense are daughters of Entry. To go on with the creation of our new sense, we are going to add a definition and an example tag. Select the new Sense element, and to launch the Template Picker, either: • • •
right click on the selected element and choose Template Picker from the contextual menu, or click on the Template Picker button in the toolbar, or press CTRL-I
The Template Picker is displayed:
Make sure that the Indented tab is active (automatic if you used the CTRL-I shortcut, otherwise select it manually), choose the DEF element from the list an click Insert. The daughter element DEF has been inserted under the new Sense:
Unlike the Sense element, the content of the DEF element can (and must) be edited. Click inside the content area. As a consequence, the whole field has now a green background and the default value ( [DEF] ) is highlighted. Key in any text ( for instance “This is my new definition” ) and press Enter. Press F5 to update the sense numbering in the preview pane.
Copyright IDM 2003-2004
Page 15 / 27
IDM – Dictionary Publishing System – Editor's documentation
No other element is mandatory within the Sense tag. However, definitions are usually clarified with an example. Use one of the insertion methods to add an EXAMPLE element to the new sense. TIP: the EXAMPLE tag can either be inserted as a child element of Sense, or as a sibling element of DEF.
Moving elements There are three ways to move elements within the tree view (i.e. within the element node hierarchy) : 1. Drag and drop the element with your mouse, 2. with buttons on the toolbar: • select the element you want to move • click , , or whether you want to move the selected element up, down, to the left or to the right, 3. with the keyboard, holding CTRL+ARROWS with the desired element selected. Select any element in the tree view and move it around. Notice that the name of the entry may become highlighted in orange in the Table of Content pane. This is a warning, which means that the structure of the entry no longer meets the structure guidelines.
Copyright IDM 2003-2004
Page 16 / 27
IDM – Dictionary Publishing System – Editor's documentation
Copying / Pasting elements You can easily copy elements within the tree view, either with or without their content.
1.select an example element and begin dragging it 2.move the pointer to drag the element where you want it to be copied. A green line between the node squares on the left helps you locate the exact paste target:
3.press CTRL (a plus sign should appear beside the mouse pointer) and release the mouse button to paste the element and its content. Repeat the procedure holding CTRL+SHIFT instead of CTRL: an empty element is pasted.
Merging the content of an element with another one The content of some elements can be merged with the previous or the next element of the tree view. Select the node (i.e. the name of the element) of the second example you have just created. Click the Append content to previous node button in the toolbar: . As a result, it's content is appended to the previous element. Press CTRL+Z to undo this action, then select the node of the first example and click the Insert content in next node toolbar button: . As a result, it's content is inserted before the content of the next example element. Press CTRL+Z again to restore the initial situation.
Deleting elements Select any element you want to delete and press CTRL+DEL.
Copyright IDM 2003-2004
Page 17 / 27
IDM – Dictionary Publishing System – Editor's documentation
Submit / Commit modifications Save on local hard drive The DPS is a full client/server software application and as such, it can be used from a client machine in a fully standalone mode, i.e. with no permanent connection to the dictionary server, when downloaded. Lexicographers manipulate task files as they would handle any text file or spreadsheet stored locally on their PC. First try to exit the program without having saved your work previously, you will be warned by a pop-up dialogue box:
Click Cancel to return to current page and save your work in its current state: press CTRL-F or click the Save taskfile button in the toolbar: If activated, an auto-save feature periodically records your latest modifications into a file. This is transparent for the user, and the auto-saved version can be recalled later from the file-loading dialogue.
Copyright IDM 2003-2004
Page 18 / 27
IDM – Dictionary Publishing System – Editor's documentation
Upload to server When you consider that your task is completed, you may want to submit the revised task file to the editor. Make sure you are connected to the Internet so the DPS server is accessible, and click the Upload taskfile button in the toolbar: A summary pop-up shows up to inform you whether the upload was successful or not:
Click OK to close this confirmation window.
Copyright IDM 2003-2004
Page 19 / 27
IDM – Dictionary Publishing System – Editor's documentation
IV.Advanced features Managing user templates Saving a user template DPS allows you to add your own customised "user templates" to the Template Picker, in three simple steps. Select any structure in the tree view that you would like to save in a template (mark the first node); for instance, to record a Sense template containing one definition and two examples elements:
Press CTRL-T.
You are shown the User Template adding dialogue window.
Fill in the desired template name ( a relevant name could be “Sense + 1 DEF + 2 EXAMPLE“ ) and click the OK button or press enter to validate your entry.
Copyright IDM 2003-2004
Page 20 / 27
IDM – Dictionary Publishing System – Editor's documentation
Deleting / Renaming a template We are now going to edit the user Template we have just created.
In the Dictionary Editor tree view, select an Entry node or a Sense node.
As the root element of the user Template is Sense, we could insert it either from the After tab if the Template Picker is called from another Sense element, or from the Indented tab if the Template Picker is called from an Entry element.
Open the Template Picker, select our user template from the list and click the More button.
As you can see, a lower pane has appeared. It is used to rename or delete user templates. The caption of the More button has changed into Less, allowing you to hide the lower pane if clicked.
Enter a new name in the text box and click the Rename button, in order to change the name of your template.
Copyright IDM 2003-2004
Page 21 / 27
IDM – Dictionary Publishing System – Editor's documentation
In addition, you can open a preview pane for any system or user template, as shown on the screen shot, by clicking the Preview button.
Click the Preview button twice, to show and hide the template preview pane. Click the Delete button in order to remove the selected user template.
Copyright IDM 2003-2004
Page 22 / 27
IDM – Dictionary Publishing System – Editor's documentation
Cross-references In the DPS, a cross-reference is a link between two elements of an entry: the source and the target. A cross-reference is defined in two steps: 1. cross-reference editing 2. cross-reference resolution. As a lexicographer, the editing step is the only one you are expected to deal with. Crossreference resolution is processed afterwards by the editor, on the server side. To create a cross-reference, the source must exist, but not necessarily the target. To add or modify a cross-reference, you only need to type the headword corresponding to the entry. Select any Sense element of an Entry Press CTRL+I to launch the Template Picker with the Indented tag selected Insert a Crossref element Press CTRL+I again, and insert a Crossrefto element The chosen Sense element should now look like this:
Click on the UNRESOLVED() field Following dialogue window is displayed:
Status “BROKEN” means that the cross-reference has not been resolved on the serverside yet. This is the editor's duty, which he will perform once you have uploaded your task file. Enter the Headword you wish to link this sense to ( Hwd field ), possibly a Description Copyright IDM 2003-2004
Page 23 / 27
IDM – Dictionary Publishing System – Editor's documentation
in the appropriate text box, then click Ok.
Searching in the dictionary database Search entries Click on the Home icon in the Dictionary Editor toolbar: This launches the Internet Explorer program, and redirects you to your home page on the DPS server. Enter your login and password in the connection window, and click OK or press ENTER to proceed to the DPS projects administration. Click on the Demonstration link in the home page navigation frame. The standard project content frame is displayed, listing all active tasks meeting the filtering criteria. Click on the Search entries button in the upper left corner.
Copyright IDM 2003-2004
Page 24 / 27
IDM – Dictionary Publishing System – Editor's documentation
The Search entries window is displayed. This form provides you with a wide range of filtering possibilities, allowing a precise selection of the targeted task file content. It includes seven criteria. The logical link between each criterion is an "AND". When opening the "Search entries" page, all the criteria are set to their default settings.
Try different searches using one or several search criteria.
Once in the Search Entries window, enter a headword range. No other criterion is required, so you may leave the other fields at their default values. The Search result window is now displayed, containing all the matching entries in form of clickable links. Click on any Headword to see the content of the entry.
Copyright IDM 2003-2004
Page 25 / 27
