Hyphenator XT. English manual.

Transcription

1 Hyphenator XT English manual

2 Version : HYPXT_EN_Manual_i2 Date : october 2003 Koraalrood SC Zoetermeer The Netherlands Internet : info@techno-design.com Techno Design. All rights reserved *TALO _ bv. All rights reserved. Copyright reserved. Subject to the exceptions provided for by law, no part of this publication may be reproduced and/or published in print, by photocopying, on microfilm or in any other way without the written consent of the copyright holder(s); the same applies to entire or partial adjustments. The publisher retains the sole right to collect from third parties fees payable in respect of copying and/or to take legal or other action for this purpose. QuarkXPress and QuarkXTension are trademarks of Quark, Inc Other brand names are trademarks of relevant proprietors. 2

3 Contents Chapter 1 Introduction 4 Technology 4 Language modules 5 Key features 5 Chapter 2 Installation 6 Installation instructions for Mac OS X 6 Licensing the product 8 Registration 10 Technical support 10 Chapter 3 Using Hyphenator XT 12 Add/Remove hyphens 12 Hyphenation exceptions 13 Hyphenation module pop-up 14 Chapter 4 Hyphenator XT menu 15 Add/Remove hyphens 15 Suggested hyphenation 16 Exceptions 16 Options 19 Use style sheet language 20 Settings 22 License 23 About 24 Chapter 5 Editing central exception list files 25 Addendum A Software License 26 3

4 Chapter 1 Introduction Hyphenator XT was developed to optimise hyphenation of many languages. As a result, QuarkXPress users no longer have to master a language in order to correctly hyphenate it. Hyphenation tools are implemented into language modules. Each language module consists of three parts: Algorithm, the main algorithm of the relevant language module. Central exception list, a multiple user list of frequently applied hyphens (house style). Personal exception list, a single user list of frequently applied hyphens. When allowing other people to use the same Central exception file, the house style will be maintained. Equally, when creating a separate Central exception file per client, a client s house style will be maintained. Some language modules may contain more than one algorithm. Choose Options from the Hyphenator XT-menu to select the required algorithm. With several fully working language modules, a QuarkXPress Passport user can automatically switch between languages within the same document. The Hyphenator XT interface is localised for English, German, Dutch, French, and Spanish, and will change into the appropriate language automatically when used with Passport versions of QuarkXPress and QuarkCopyDesk. Technology Hyphenator XT is a hyphenation tool for a large number of languages, developed with intelligent syllable technology from *TALO _. General unifying structures for syllabification are completed with linguistic patterns. Each language module acts like a comparator which possesses an almost human understanding of the target language with its own linguistic pattern. Techno Design has implemented this *TALO _ technology into their software modules, the result of which is accuracy of the highest level. It inserts hyphens, whilst keeping the text flow comprehensible. 4

5 Language modules The software developer has decided to classify certain languages in a specific language module. This classification does not have any bearing on the the universal status of these languages. An overview of all currently available language modules, including their algorithms, can be found in appendix A. It is quite possible that since the creation of this manual new algorithms and/or language modules have been added. To obtain the most recent update, please visit our web site at Note! You will need the appropriate QuarkXPress product, (QuarkXPress or QuarkXPress Passport) depending on the language module chosen. QuarkCopyDesk SE and QPSCopyDesk All rules and procedures for Hyphenator XT equally apply to users of QuarkCopyDesk Special Edition and QPSCopyDesk. These users should read CopyDesk instead of QuarkXPress in the following documentation. Key features Key features of Hyphenator XT are: High accuracy (up to 99,95%) Extensive algorithm(s) for each language module Exchange documents without text reflow User-definable Central Exception folder User-definable Personal Exception folder for single users Automatic hyphenation on opening of a document Automatic language detection with multilingual documents Hyphenator XT palette to insert and remove hyphens 5

6 Chapter 2 Installation Please follow the steps below to install the software. Installation instructions for Mac OS X 1 Insert the Techno Design cd-rom. Locate and open the Hyphenator XT folder. 2 Double click the installer icon. 3 The Authenticate dialog box displays. Enter your administrator name and password in the appropriate fields, and then click OK. The Authenticate dialog. 4 The Hyphenator XT Installer splash screen is displayed. Click Continue. 5 The Licence Agreement screen is then displayed. Read the Licence Agreement carefully. If you accept the terms in the agreement, click Accept. If you do not accept the terms, click Decline. 6 On Clicking Accept the Hyphenator XT installer screen appears. Click Install to start the installation process. 7 When multiple copies/versions of QuarkXPress are installed, the appropriate QuarkXPress application folder needs to be selected. Click OK. 6

7 The Select Folder dialog The installer places the Hyphenator XT software inside the XTensions folder of the chosen QuarkXPress folder. A Techno Design folder is created on the desktop. This folder contains information on how to change the demo to a fully operational version. If an older version of Hyphenator XT was found in the XTensions folder of QuarkXPress this version is automatically placed in the new Techno Design folder. 8 (Re)start QuarkXPress. After restarting QuarkXPress the Hyphenator XT will be recognised automatically. Note! Since Hyphenator XT becomes part of the QuarkXPress software, it is essential for accurate performance of Hyphenator XT, that QuarkXPress has itself been installed correctly. Upon successful installation of Hyphenator XT, The Hyphenator XT menu appears in the Utilities menu of QuarkXPress. 7

8 Licensing the product After the installation, the XTension will work as a fully-featured demonstration version. This version has no limitations on functionality but can only be used for a limited number of days. To change the demonstration copy into a fully working version you will need to enter a serial number. On purchasing Hyphenator XT, one or more serial numbers are provided for each individual language module purchased. The serial number is located in the following places: On the printed Registration card On the printed Personal data card When purchasing the product via a download service, the serial number may be in the receipt from the service or in the electronic user license agreement received from this service. The serial number consists of 18 characters: XXXX-XXXX-XXXX-XXXX-XX X represents a figure (0-9) or a letter (A-F). Follow these steps to convert the demonstration into a fully working version: 1 Launch QuarkXPress. The Hyphenator XT demo splash screen appears. This dialogue will appear every time you launch Quark- XPress until you register the product. If you don t plan to purchase the product you will need to remove the XTension from the XTensions folder of QuarkXPress. 2 Click the Licence... button to enter you licence information otherwise choose Continue demo. The demo splash screen. 8

9 The Licence dialog 3 If you clicked Licence... the Hyphenator XT Licence dialogue appears on screen (shown above). Enter your information and the supplied serial number in the appropriate fields and click OK. 4 If the serial number entered is valid, you are notified as shown in the window below. The language module is successfully licensed. Click Yes if you want to licence an additional language module. The Hyphenator XT Licence appears. Enter the serial number for the additional language module and click OK. If you do not want to licence additional modules click No. To show the Licence dialogue afterwards you can choose Licence... from the Hyphenator XT menu (Utilities menu). Use the Overview button for this window to show the status of the language modules. 9

10 The Hyphenator XT Overview dialog shows the status of the language modules. Registration It is essential to register your copy of Hyphenator XT in order to receive technical support and information on updates. A registration card is included with the software package, upon receipt of the completed, posted card, registration will take place. It is also possible to register on our web site at. The supplied Personal data card is for your own records. This card contains important information on your product. Please keep it in a safe place. Technical support You must register your product with Techno Design to be eligible for technical support. Technical support for our products is available by phone, fax and from 9:00 am to 17:30 p.m. (Central European Time), Monday to Friday. When contacting our support department, please: Locate the TD Code of the product. You can find this number in the splash screen of the XTensions-module which shows at startup of QuarkXPress. The splash screen can be shown afterwards by selecting About... in the Hyphenator XT menu (Utilities menu) and shows the TD Code of the currently selected language module. To show TD Codes of additional language modules select Licence... in the Hyphenator XT menu and click Overview. The Hyphenator XT Overview dialogue appears. Please provide us with detailed information and if possible supply us with sample documents. 10

11 The Hyphenator XT Overview dialog shows TD Codes of the licenced language modules. The Hyphenator XT splash screen shows the TD Code of the currently selected language module. Registered users will receive technical support free of charge within 90 days from the date of purchase. Additional support plans can be purchased separately (in which case please contact the Techno Design sales department). Techno Design Phone Fax Tech support Sales 11

12 Chapter 3 Using Hyphenator XT After installing Hyphenator XT and (re)launching QuarkXPress the the additional item Show (or Hide...). When selecting Show Hyphenator XT, the following palette appears on screen: The Hyphenator XT palette. Add/Remove hyphens Use the Add/Remove hyphens buttons to edit the area of the document to be hyphenated. Hyphenator XT checks the text and inserts soft-hyphens (discretionary hyphens). There are four options: Document the entire document Story the active text box or text chain (linked text boxes) Selection the selected text Word a specific word Hyphenation is applied according to the hyphenation rules and justification settings of QuarkXPress. QuarkXPress lets you group hyphenation rules and justification settings as a single H&Js setting that you can apply to paragraphs. For more information on H&Js please refer to the QuarkXPress manual. 12

13 By default the Hyphenator XT palette buttons show the add hyphens buttons (plus-symbol). Press the ALT key to access the Remove hyphens buttons (minus-symbol). Press the alt key to access the Remove hyphens buttons. Hyphenation exceptions The Exceptions button gives you access to the Hyphenator XT Exceptions window. Exceptions are useful when there is a reason to modify the hyphenation process. Hyphenator XT always checks whether or not a word is included in the exceptions list, before applying its own linguistic algorithm. Please refer to chapter X for more information exception lists. The Hyphenator XT Exceptions dialog box 13

14 Hyphenation module pop-up Choose a language module from the pop-up list of languages to influence the type of hyphenations. For each language module, a serial number is required to create a fully working version. 14

15 Chapter 4 Hyphenator XT menu The Hyphenator XT menu in the Utilities menu gives the user access to the functions and settings of the Hyphenator XT. Add/Remove hyphens Use the Add/Remove hyphens options to edit the area of the document to be hyphenated. Hyphenator XT checks the text and inserts soft-hyphens (discretionary hyphens). There are four option: Document the entire document Story the active text box or text chain (linked text boxes) Selection the selected text Word a specific word Menu Hyphenator XT Hyphenation is applied according to the hyphenation rules and justification settings of QuarkXPress. QuarkXPress lets you group hyphenation rules and justification settings as a single H&J setting that you can apply to paragraphs. For more information on H&Js please refer to the QuarkXPress manual. 15

16 Use the options in the Add hyphens submenu and Remove hyphens submenu to edit the area of the document to be hyphenated. Use the option Remove hyphens to remove hyphens from selected areas of the document. This submenu has identical options as the Add hyphens submenu. Note The suggested hyphenation is based on the H&J setting of that paragraph using the linguistic algorithms of Hyphenator XT. Suggested hyphenation The default setting of the shortcut for suggested hyphenation is identical to the shortcut of QuarkXPress: Alt, Command, Shift, H (Macintosh) or Alt, Control, Shift, H (Windows). Use this shortkey to invoke a dialogue box with a suggested hyphenation which can be applied or cancelled. Suggested hyphenation The language stated at the bottom left of the dialogue box above, indicates that the word suggested will be hyphenated according to the hyphenation rules of the English, International module. Exceptions Exceptions are useful when there is a reason to modify the hyphenation process. Hyphenator XT always checks whether or not a word is included in the exceptions list before applying its own linguistic algorithm. Hyphenator XT distinguishes between two kinds of exception files: Personal exceptions Central exceptions The Personal exceptions list can be edited from within QuarkXPress using the Exceptions dialogue. This window can be displayed by selecting the Exceptions button in the Hyphenator XT menu or by selecting Exceptions from the Hyphenator XT menu (Utilities menu). The Exceptions are stored in a external text file. The path to this file is stored with your local Hyphenator XT preferences file. 16

17 The Hyphenator XT Exceptions dialogue box (personal exceptions). The support for Central exceptions files allow users to use the same list of exceptions across a workgroup. Where the Personal exceptions list can be altered through the Exceptions dialogue, the Central exceptions list needs to be created and edited manually using a text editor. Typically Central exceptions files are stored on a file server. The path to this location can be set in Hyphenator XT s Settings window. For more information on editing a central exceptions file please refer to Chapter 5. Exceptions dialog Use this dialogue box to specify (new) exceptions which will be saved in a Personal exceptions file. Users can alter, add or remove exceptions using the options in this window. When adding an exception which is not regarded as such, a message will appear on the bottom of this dialogue box, indicating that your selection is in fact no exception. It will not be added to the Personal exception list. The added hyphenation exception is not an exception 17

18 Note! Since Sim-ul-ta* ends with an asterisk (*), Hyphenator XT will consider all words beginning with simulta, no matter how many characters follow, e.g.: simultaneous simultaneousness simultaneously simultaneity simultaneities Import/Export Use these buttons to either import or export exceptions. After selection, a dialogue box will appear on screen through which a file can be selected to import or save the hyphenation exceptions. Delete Use this button to remove a selected entry from the Personal exception list. Replace/Add Use the Replace button to modify existing exceptions. When entering a new word in the edit field below the list, the Replace button will change into Add. Save/Cancel Use these buttons to either save or cancel the Personal exception list. Language Every language module has it s own exceptions list. Select a language from the pop-up list to specify the list of exceptions needing to be altered. 18

19 Options Use the Options to influence the hyphenation process. When selecting Options... in the Hyphenator XT menu (Utilities menu), the following dialogue box appears on screen: Hyphenator XT Options Hyphenate when opening the document When opening a document, required hyphens will be inserted into the document. QuarkXPress hyphens are replaced by correct Hyphenator XT ones. Hyphenator XT inserts soft-hyphens (discretionary hyphens), these hyphens are invisible marks in the document. They will not influence the functionality of other extensions. Use this Hyphenator as default Use this option to bypass the QuarkXPress dialogues for Suggested Hyphenation and Hyphenation Exceptions. When this checkbox is activated the corresponding Hyphenator XT dialogues can be accessed using the QuarkXPress features in the Utilities menu. Only hyphens at end of line Activate this checkbox to only hyphenate words at the end of the text lines. Should the text change after hyphenation, the words nearby shift and former hyphenations at the end of lines shift accordingly. You should then rehyphenate the document. 19

20 Note! When selection the Use style sheet language the Hyphenator XT palette will not show the language pop-up menu. Use style sheet language Activate this option to instruct Hyphenator XT to use the style sheet language(s) as set within your paragraph (QuarkXPress Passport only). This option allows you to choose between several hyphenation methods for the following languages: Swedish Hyphen between c and k Keep ck unified French Use the etymological rules Use the phonological rules German Use the reformed rules Use the old rules Swiss German Use the reformed rules Use the old rules Norwegian Use the rules of Norwegian consolidated Use the rules of Norwegian morphological US English Use the rules of US English Use the rules of International English Use the rules of South African English International English Use the rules of International English Use the rules of US English Use the rules of South African English Dutch Use the rules of Dutch Use the rules of South African Afrikaans For more background information on hyphenation modules please refer to the pdf-booklet The Language by *TALO s Language Technology (2002), supplied on the Techno Design CD-ROM. 20

21 Hyphenator XT Options The following languages have certain default settings: Swedish: hyphen between c and k French: use the phonological rules German: use the reformed rules Swiss German: use the reformed rules Norwegian: use the rules of Norwegian consolidated US: use the rules of US English UK: use the rules of International English Dutch: use the Dutch rules The above options are only available when using a Passport version of QuarkXPress set according to the relevant language module. 21

22 Settings When selecting Settings... from the Hyphenator XT menu (Utilities menu) the following dialogue box appears on screen: Settings Hyphenator XT Show startup screen after restart When activating this option Hyphenator XT s startup screen will be displayed at every launch of QuarkXPress. This option is only available when using the full version of Hyphenator XT. Personal exception folder The selected folder contains the default Personal exceptions files (the path to which was created on installation). The exceptions list can be edited using the Exceptions... dialogue, which can be shown in the Hyphenator XT menu of the Utilities menu. To change the path to the Personal Exceptions folder use the following procedure: 1 Click on the Change button under Personal Exception folder. 2 Select a folder containing your Personal exception files. 3 Click on Select this folder. Central exceptions folder The selected folder contains the default Central exceptions files (the path to which was created on installation). To prevent users altering this list from Hyphenator XT, these exceptions files can only be edited using a text editor. 22

23 Should the list of Central exceptions be placed elsewhere, please note the following procedure: 1 Click on the Change button under Central exception folder. 2 Select a folder containing your Central exception files. 3 Click on Select this folder. Shortkey for hyphenation of the entire document Use this field to define a shortkey to hyphenate the entire document. Language module Choose a language module from the pop-up list of languages to influence the type of hyphenations. For each language module, a serial number is required to create a fully working version. Available modules in QuarkXPress and QuarkCopyDesk Passport Cancel/OK Use these buttons to cancel or save your settings. License The Licence option shows the Hyphenator XT License window as described in chapter 2. 23

24 About Use this option to display Hyphenator XT s startup screen containing information on the version, the licence name and the number of users. 24

25 Chapter 5 Editing central exception list files Exception list files used by Hyphenator XT are ASCII text files, with a tilde (~) as the character used to designate valid break points. When manually editing or creating exceptions files, all characters need to be lower case. Hyphenator XT will ignore exceptions containing upper case characters. An example Central exceptions list opened in a text editor Exception lists used by Hyphenator XT can easily be backed up, edited, reviewed or distributed, due to their storage in standard ASCII format. Every module has it s own Personal and Central exceptions file. For example: the International English Personal exceptions file is called ENG-ENG-STD.MQPEX and Central exceptions file for this module is called ENG-USA-STD.MQPEX. Exceptions file suffixes Central exception suffix Personal exception suffix MQCEX MQPEX Centralised exceptions file The Central exceptions file can be stored on a file server. Server access privileges can be set to the Central exceptions folder to prevent users adding or deleting exceptions accidentally and maintain the consistency of this exception list. The storage folder for exceptions files can be defined in the Settingsdialogue of the Hyphenator XT menu (Utilities menu). 25

26 Addendum A Software License PLEASE READ THIS LICENSE CAREFULLY BEFORE USING THE SOFTWARE. BY USING THE SOFTWARE, YOU ARE AGREEING TO BE BOUND BY THE TERMS OF THIS LICENSE. IF YOU DO NOT AGREE TO THE TERMS OF THIS LICENSE, PROMPTLY RETURN THE UNUSED SOFTWARE TO THE PLACE WHERE YOU OBTAINED IT. 1. LICENSE. The application, demonstration and other software accompanying this License, whether on disk or on other media (the Software") and related documentation are licensed to you by Techno Design. You own the disk on which the Software is recorded but Techno Design retains title to the Software and related documentation. You are allowed to make one copy of the Software, to be used as backup version and one copy to be placed on the hard disk. At any moment you are limited to own two copies of each XTension and you must reproduce on such copies the Techno Design copyright notice and any other proprietary legends that are on the original copy of the Software. Each computer should have its own XTension. 2. RESTRICTIONS. The Software contains copyrighted material, trade secrets, and other proprietary information and in order to protect them you may not decompile, reverse engineer, disassemble or otherwise reduce the Software to a human-perceivable form. You may not modify, rent, lease, loan, distribute or create derivative works based upon the Software in whole or in part. 3. TERMINATION. This License is effective until terminated. You may terminate this License at any time by destroying the Software and related documentation and all copies thereof. This License will terminate immediately without notice from Techno Design if you fail to comply with any provision of this License. Upon termination you must destroy the Software and related documentation and all copies thereof. 4. DISCLAIMER OF WARRANTY ON SOFTWARE. You expressly acknowledge and agree that use of the Software and related documentation are provided AS IS" and without warranty of any kind Techno Design EXPRESSLY DISCLAIM ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WAR- RANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. TECHNO DESIGN DOES NOT WARRANT THAT THE FUNCTIONS CONTAINED IN THE SOFTWARE WILL MEET YOUR REQUIREMENTS, OR THAT THE OPERATION OF THE SOFTWARE WILL BE UNINTERRUPTED OR ERROR-FREE, OR THAT DEFECTS IN THE SOFTWARE AND/OR MATERIALS WILL BE CORRECTED. FURTHERMORE,TECHNO DESIGN DOES NOT WARRANT OR MAKE ANY REPRESENTATIONS REGARDING THE USE OR THE RESULTS OF THE USE OF THE SOFTWARE OR MATERIALS IN TERMS OF THEIR CORRECTNESS, ACCURACY, RELIABILITY, OR OTHERWISE. NO ORAL OR WRIT- TEN INFORMATION OR ADVICE GIVEN BY TECHNO DESIGN OR AN TECHNO DESIGN AUTHORIZED REPRE- SENTATIVE SHALL CREATE A WARRANTY OR IN ANY WAY INCREASE THE SCOPE OF THIS WARRANTY. SHOULD THE SOFTWARE AND/OR MATERIALS PROVE DEFECTIVE, YOU (AND NOT TECHNO DESIGN OR AN TECHNO DESIGN AUTHORIZED REPRESENTATIVE) ASSUME THE ENTIRE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. SOME JURISDICTIONS DO NOT ALLOW THE EXCLUSION OF IMPLIED WARRANTIES, SO THE ABOVE EXCLUSION MAY NOT APPLY TO YOU. 5. COMPLETE AGREEMENT. This License constitutes the entire agreement between the parties with respect to the use of the Software and Materials, and supersedes all prior or contemporaneous understandings or agreements, written or oral, regarding such subject matter. No amendment to or modification of this License will be binding unless in writing and signed by a duly authorized representative of Techno Design. QUARK DISCLAIMER The following disclaimer is required by Quark Inc. It applies only to Quark software. All other software is covered by Quark's limited warranty. QUARK INC. MAKES NO WARRANTIES, EITHER EXPRESS OR IMPLIED, RE- GARDING THE ENCLOSED COMPUTER SOFTWARE PACKAGE, ITS MERCHANTABILITY, OR ITS FITNESS FOR ANY PARTICULAR PURPOSE. QUARK INC. DISCLAIMS ALL WARRANTIES INCLUDING, BUT NOT LIMITED TO THE WARRANTIES OF THE DISTRIBUTORS, RETAILERS AND DEVELOPERS OF THE ENCLOSED SOFTWARE. WITHOUT LIMITING THE FOREGOING, IN NO EVENT SHALL QUARK INC. BE LIABLE FOR ANY SPECIAL, INDIRECT, INCI- DENTAL OR CONSEQUENTIAL DAMAGES IN ANY WAY RELATING TO THE USE OR ARISING OUT OF THE USE OF THE ENCLOSED SOFTWARE. QUARK, INC.'S LIABILITY SHALL IN NO EVENT EXCEED THE TOTAL AMOUNT OF THE PURCHASE PRICE/LICENSE FEE ACTUALLY PAID FOR THE USE OF THE ENCLOSED SOFTWARE. SOME STATES DO NOT ALLOW LIMITATIONS ON IMPLIED WARRANTIES AND/OR LIMITATION OF INCIDENTAL OR CONSEQUENTIAL DAMAGES, SO THESE EXCLUSIONS AND LIMITATIONS MAY NOT APPLY TO PARTICULAR DE- VELOPERS. 26