DOC

WordCruncher Documentation

By Kathryn Wells,2014-03-29 00:11
15 views 0
WordCruncher Documentation

WordCruncher

ETA Specification

Page II Table of Contents

WordCruncher Image Library Manager ? Copyright Brigham Young University, 1995

User‟s Manual All rights reserved

     Table of Contents Page i

    th1. Revision Notes: October 12, 1998 .................................................................................1

    1.1 This Release ............................................................................................................................. 1

    1.1 The Previous Revisions ........................................................................................................... 1 th1.1.1 October 12, 1998 ........................................................................................................................... 1 th1.1.1 February 24, 1997 .......................................................................................................................... 1 th1.1.1 October 30, 1996 ........................................................................................................................... 2 th1.1.1 September 6, 1996 ......................................................................................................................... 2 rd1.1.1 June 3, 1996 ................................................................................................................................... 2 th1.1.1 April 26, 1996 ................................................................................................................................ 2 th1.1.1 March 20, 1996 .............................................................................................................................. 2 st1.1.1 September 21, 1995 ....................................................................................................................... 3 th1.1.1 September 11, 1995 ....................................................................................................................... 3 th1.1.1 April 4, 1995 .................................................................................................................................. 4 nd1.1.1 February 2, 1995 ........................................................................................................................... 4 th1.1.1 January 11, 1995 ............................................................................................................................ 4 th1.1.1 October 11, 1994 ........................................................................................................................... 4

    1. Licensing of WordCruncher Technology .......................................................................6

    1. Document Overview ........................................................................................................6

    1.1 ETA Overview ......................................................................................................................... 9

    1.2 Style Include File (SIF) Overview ....................................................................................... 10

    1.2.1 SIF Begin Code Over-ride ............................................................................................................. 11

    1.2.2 SIF End Code Over-ride ................................................................................................................ 11

    1.2.3 Hidden Word Separator Code ........................................................................ 错误?未定义书签。

    1.2.4 DOCUMENT, PARAGRAPH, TEXT, and HYPERLINK_STYLE Codes .................................. 12

    DOCUMENT_STYLE Command....................................................................................................... 13

    CHARACTER_MAP Command ......................................................................................................... 15

    TAB Command ................................................................................................................................... 16

    RULER Command .............................................................................................................................. 17

    LINE Command .................................................................................................................................. 18

    BOX Command ................................................................................................................................... 19

    PARAGRAPH_STYLE Command ..................................................................................................... 20

    Alternate PARAGRAPH_STYLE Command ..................................................................................... 21

    LANGUAGE Command ..................................................................................................................... 22

    FONT Command ................................................................................................................................. 23

    TEXT_STYLE Command ................................................................................................................... 24

    Alternate TEXT_STYLE Command ................................................................................................... 24

    Choice of TEXT_STYLE Command .................................................................................................. 25

    REFLEVEL_STYLES Command ...................................................................................................... 26

    END..................................................................................................................................................... 26

    HYPERLINK_STYLE Command ....................................................................................................... 27

    Alternate HYPERLINK_STYLE Command ....................................................................................... 28

    1.2.5 Reference Levels and Index Options ............................................................................................. 29

    1.3 ETA Formatting Codes ......................................................................................................... 31

    1.3.1 SIF Inclusion Command ................................................................................................................ 31

    1.3.2 Reference Level Codes .................................................................................................................. 31

    1.3.3 Text Style Codes ............................................................................................................................ 33

    Text Style Override Codes .................................................................................................................. 33

    1.3.4 Paragraph Style Codes ................................................................................................................... 35

    Paragraph Style Override Codes.......................................................................................................... 37

    WordCruncher ETA Documentation ? Copyright Brigham Young University, 1984-99 Version 5.3 All rights reserved

Page ii错误?使用“开始”选项卡将 Heading 1 应用于要在此处显示的文字。. 错误?使用“开始”选项

    卡将 Heading 1 应用于要在此处显示的文字。

    1.3.5 Hyperlink Codes ............................................................................................................................ 39

    1.3.6 Inline Images .................................................................................................................................. 41

    1.3.7 Operation Hyperlinks ..................................................................................................................... 42

    2. Appendix A: Reference List Hyperlink Structure .....................................................44 3. Appendix B: Margins, Indents and Tabs ..................................................................45 4. Appendix C: Stylizing Reference Level Codes in an ETA File ................................46 5. Appendix D: System Limit Specifications .................................................................47 6. Appendix E: Multiple Language Documents ............................................................49 7. Appendix F: Keyboard Mapping ...............................................................................50 8. Appendix G Hyperlink Style Information .................................................................51 9. Appendix H: An Example of a SIF (CONST.SIF) ...................................................52 10. Appendix J: How tagged word markup codes are used ...............................................54 11. Appendix K: Table of Language Identifiers ..............................................................55 WordCruncher ETA Documentation ? Copyright Brigham Young University, 1991-99

    Version 5.3 All rights reserved

    错误?使用“开始”选项卡将 Heading 1 应用于要在此处显示的文字。. 错误?使用“开始”选项

    卡将 Heading 1 应用于要在此处显示的文字。Page 1

    rd1. Revision Notes: September 23 , 1999

    1.1 This Release

     Added colors for reading bar in 32-bit viewer.

     Added the "phrase" hyperlink support.

     Modified storage of Reference Level data to allow a zero length for a level in the 32 bit

    Indexer. The converter software uses this as a flag to compute the smallest storage

    possible for a given text by examining all of the level names for a given Reference Level

    and using the longest name as the default length for that Reference Level. 1.2 The Previous Revisions

    th1.2.1 July 25, 1999

     Modify documentation only -- no changes to the SIF or mark up codes. We had some

    sections that needed clarification with the 32-bit software.

    th1.2.2 October 12, 1998

     Modified SIF codes to remove case sensitivity

     Changed “Language Group” terminology to “Search Category”

     All SGML references were removed from this document. This option is no longer

    supported. It is being supplanted by the RTF support.

     Added Internet URL hyperlink

     Added E-mail hyperlink

    th1.2.3 February 24, 1997

     Inline images are defined.

     Operation Hyperlinks are defined.

     Button class added to list of hyperlink styles supported

     Removed the <Fpoint> command and replaced it with <Spoint> command. This was

    done because the relative and absolute font size overrides are peer commands. Added support for tagged stem word markup codes (see Appendix J: How tagged

    word markup codes are used) and the TEXT_STYLE record in the SIF for an

    explanation of details.

     Modified the inline image syntax.

     Modified the presentation of Reference Level commands for the SIF. Added MAX_LENGTH label to definition of Reference Levels;

     Added ZERO_CODE label to definition of Reference Levels.

     Added TYPE label to definition of Reference Levels.

     Added comments about the consequences of not defining FONT records to go with WordCruncher ETA Documentation ? Copyright Brigham Young University, 1984-99 Version 5.3 All rights reserved

Page 2错误?使用“开始”选项卡将 Heading 1 应用于要在此处显示的文字。. 错误?使用“开始”选项

    卡将 Heading 1 应用于要在此处显示的文字。

    TEXT_STYLE records.

     Clarified next_word hyperlinks and their relationship to the FONT record in he

    HYPERLINK_STYLE record

    th1.2.4 October 30, 1996

     Added the REFLEVEL_STYLE code

    th1.2.5 September 6, 1996

     Fixed the definition of some new text and paragraph style override codes. Reorganized the ETA formatting sections (Section 2.3).

     Redefined the Paragraph Style and Text Style overrides.

    rd1.2.6 June 3, 1996

     We have modified the Document_Style record to remove unneeded fields. We have modified the Language_Style record and amplified the language name field

    with Appendix K, which lists the acceptable language spellings. These language

    names are converted into a code that allows for multilingual library searches. We have modified the Text Viewing Commands to use etc. so as not

    to conflict with the lexicon / thesaurus phrase displacement command of <1> (before

    or after and within 1 word).

    th1.2.7 April 26, 1996

     We have modified the structure of the External Task Hyperlink to include the

    definition of directory tags that are resolved at run time.

     We have added the capability in the SIF to map multiple keyboards to one language.

    This will allow the user to select which keyboard to use with choice of text style cases

    or in cases where there is more than one accepted keyboard for a given language. We have added five ETA text markup codes. Four are for selectively hiding text and

    the other is for turning off the indexing of a section of a document. It is now possible to define a character or set of characters that will be interpreted and

    replaced by WordCruncher with a non-display word delimiter/separator. This is very

    useful for languages what use suffixes and prefixes to add things like articles and

    pronouns to words. This code is called the Hidden Word Separator Code.

    th1.2.8 March 20, 1996

     This documentation was upgraded to Microsoft Word format.

     The documentation was upgraded to Microsoft Word format.

     Multiple language support has been added to Reference Levels.

     Reference level text styles have been changed (see the TEXT_STYLE command). And

    override command has for reference level text styles has been added to the Block

    Commands (see the Block Command <Rname>).

    WordCruncher ETA Documentation ? Copyright Brigham Young University, 1991-99

    Version 5.3 All rights reserved

错误?使用“开始”选项卡将 Heading 1 应用于要在此处显示的文字。. 错误?使用“开始”选项

    卡将 Heading 1 应用于要在此处显示的文字。Page 3

     A Reference Level Text Style override command has been added.

     The LANGUAGE record has been modified.

     Window colors have been removed from the ETE section of the SIF. These windows

    now use the standard windows colors set by the user.

     The FONT record has been modified to allow the “default” option for many of the

    fields. This makes it possible to load unusual fonts where the name of the font is

    known but the other information is not. If default is specified with only a point size

    and a font name, Windows will get the correct font every time.

     The LANGUAGE record has been modified to use CODE_PAGE and

    LANGUAGE_GROUP as fields to aid in exporting searches to libraries. Multiple language support has been added to Reference Levels.

     Reference level text styles have been changed (see the TEXT_STYLE command). And

    override command has for reference level text styles has been added to the Block

    Commands (see the Block Command <Rname>).

     A Reference Level Text Style override command has been added.

     The LANGUAGE record has been modified.

     Window colors have been removed from the ETE section of the SIF. These windows

    now use the standard windows colors set by the user.

     The FONT record has been modified to allow the “default” option for many of the

    fields. This makes it possible to load unusual fonts where the name of the font is

    known but the other information is not. If default is specified with only a point size

    and a font name, Windows will get the correct font every time.

     The LANGUAGE record has been modified to use CODE_PAGE and

    LANGUAGE_GROUP as fields to aid in exporting searches to libraries.

    st1.2.9 September 21, 1995

     Reference Level descriptive data has been added to the ETA specification. The default Begin Code has been changed from ASCII 30 to ASCII 60.

     The default End Code has been changed from ASCII 31 to ASCII 62.

    th1.2.10 September 11, 1995

     This revision documents changes to be implemented with version 5.1 of

    WordCruncher for Windows with regard to multiple-language documents. This

    includes the following:

    1. Changing the DOCUMENT_STYLE record to support multiple-language

    documents

    2. A CHARACTER_MAP record has been added (to support keyboard mapping

    and appropriate character echoing of keyboard input).

    3. LANGUAGE records have been renamed to FONT records.

    4. A new LANGUAGE record has been defined to control the display of

    multiple languages on the WordWheel, in Citations, and different keyboards

    to use this data.

    5. TEXT_STYLE records have been modified to use the FONT record and the WordCruncher ETA Documentation ? Copyright Brigham Young University, 1991-99

    Version 5.3 All rights reserved

Page 4错误?使用“开始”选项卡将 Heading 1 应用于要在此处显示的文字。. 错误?使用“开始”选项

    卡将 Heading 1 应用于要在此处显示的文字。

    new LANGUAGE record.

    6. An appendix has been added to explain the use of multiple languages within

    one document.

     The appendix on Reference List Hyperlink Structure has been completely re-

    written.

     The appendix on Keyboard Mapping has been added

    th1.2.11 April 4, 1995

     The character size override code was added to the codes valid in the ETA. The footnote for external task hyperlinks was modified.

    nd1.2.12 February 2, 1995

     The graphic hyperlink has been discontinued. It will automatically be converted into

    an image hyperlink. The image hyperlink has a file name associated with it. Excerpt On/Off hyperlinks have been withdrawn from convert support. Both the SIF= and ISBN= commands have been modified so they are no longer case

    sensitive.

     The CHAR_SET command within a LANGUAGE description in the SIF has

    additional documentation dealing with font selection.

    th1.2.13 January 11, 1995

     The JUSTIFICATION field in PARAGRAPH_STYLE was changed to support left,

    right or center. The “both” option has been removed.

     Paragraph Style Updates are defined but not implemented with this document release.

    th1.2.14 October 11, 1994

     Some typos have been fixed.

     SEARCH_SETs have been modified slightly

     RULER “based on” example has been removed because it is not supported.

     TEXT_COLORS removed from ETE processing. This data is now set with styles. Begin/End codes are no longer used in the SIF. This simplifies the creation of the file.

     Each line ends with a CRLF.

     In the ETE section, considerable changes have occurred in the SEARCH_SET section

    to track the changes that occurred in the SearchManager section of WCVWIN in the

    last release. Of special note is the change in the way that search sets are defined. A DIRECTION field has been added to the DOCUMENT_STYLE section. DOCUMENT_SYTLE section was introduced, and the RULER section was modified. Representation of CHOICE_OF_TEXT_STYLE code was changed to look exactly

    like a TEXT_STYLE code.

     Changes where made to the LINE object, and the Box object.

    WordCruncher ETA Documentation ? Copyright Brigham Young University, 1991-99

    Version 5.3 All rights reserved

错误?使用“开始”选项卡将 Heading 1 应用于要在此处显示的文字。. 错误?使用“开始”选项

    卡将 Heading 1 应用于要在此处显示的文字。Page 5

     The LANGUAGE object had additional font data added.

     The margin over-ride command has been removed. See LINE_WRAP in

    DOCUMENT_STYLE.

     ETE creation codes are now allowed in the SIF.

     The ETE file will now contain color codes for the windows used in WCVWIN. All FONT_POINTSIZE variables have been changed to allow for fractional point sizes. All FONT_WIDTH variables have been changed to allow for fraction point width

    sizes.

     The maximum number of tabs that can now be defined in a tab field are 64. An LST_NAME variable has been added to the language record. This will enable

    future support for multiple LST documents (e.g. intermixing non-compatible

    languages).

     Changes where made to the color specification section of the SIF Stylization of reference level codes has been modified. See the appendix on Stylizing

    Reference Level Codes in an ETA File.

     Document Styles have been split into PARAGRAPH_STYLEs and TEXT_STYLEs.

    This was done because of the way the two sets of data are implemented. CHOICE_OF_TEXT_STYLES are introduced.

    WordCruncher ETA Documentation ? Copyright Brigham Young University, 1991-99 Version 5.3 All rights reserved

错误?使用“开始”选项卡将 Heading 1 应用于要在此处显示的文字。. 错误?使用“开始”选项

    卡将 Heading 1 应用于要在此处显示的文字。Page 6

    2. Licensing of WordCruncher Technology

    An exclusive license to the WordCruncher technology has been purchased by

     WordCruncher Publishing Technology

     12450 South 405 East, Suite B

     Draper, UT 84020

     (801) 816-9904

    WordCruncher Publishing Technologies (WPT) should be the contact for all questions concerning WordCruncher technologies. This document was written by the BYU Instructional Application Services (IAS) staff and is maintained by them was part of the WordCruncher technology.

    3. Document Overview

    WordCruncher for Windows is an information presentation software tool. It includes a very quick, robust and sophisticated searching subsystem and some textual analysis tools. The design philosophy for WordCruncher is the facilitation of textual research by a wide range of students: from the casual reader to a textual content expert. There is a cause and effect relationship

    BETWEEN

    the markup codes are added to the source text

    AND

    the features of WordCruncher that will be

    available for use with that text.

    The intent of this documentation is to help the document preparer understand the choices he or she has in marking up a document and the consequences of those choices in the way the final product works with the WordCruncher for Windows viewing software. Please by careful attention to the footnotes that annotate many of the commands. Much of the most important information in this document is contained in its footnotes. The version number 5.3 refers to the file formats of the ETA/ETB/ETX files and not the viewing or indexing files that use and make these files.

    All WordCruncher files have extension names that begin with ET (which stands for electronic text). The first and most important file is the source material. We call this file the ETA (the „A‟ stands for Alpha, which is the first letter of the Greek alphabet, and is used as a synonym for first). Some typical WordCruncher ETA file names might be:

    WordCruncher ETA Documentation ? Copyright Brigham Young University, 1984-99

    Version 5.3 All rights reserved

Report this document

For any questions or suggestions please email
cust-service@docsford.com