DOCSLIB.ORG

DITA Open Toolkit User Guide

Total Page：16

File Type：pdf, Size：1020Kb

Download full-text PDF Read full-text
DITA Open Toolkit User Guide DITA Open Toolkit User Guide Third Edition - April 18, 2007 - DITA Open Toolkit 1.3.1 2 | DITA Open Toolkit | Preface Authoring and publishing information for this document. Title DITA Open Toolkit User Guide Edition, release, Third edition, April 18, 2007. Based on release 1.3.1 of DITA Open Toolkit. All copyright files copyright 2006-2007 by VR Communications, Inc., unless otherwise indicated. Licensing and usage of this document and related materials is regulated by a Common Public License (CPL) granted by OASIS (Organization for the Advancement of Structured Information Standards), http://www.oasis-open.org. Publishing DITA Open Toolkit is an open-source, reference implementation of the OASIS information DITA standard (currently DITA 1.0). Authors Anna van Raaphorst and Richard H. (Dick) Johnson, principals, VR Communications, Inc. (http://www.vrcommunications.com). DITA logo artwork by Elizabeth Tichenor (http://www.elizabethtichenor.com) Major changes in this edition • The document title has been shortened • The document has been significantly restructured • New topics include key concepts, processing overview, localization, content reuse, building from within Eclipse, configuring the Eclipse XMLBuddy editor, creating Eclipse Infocenters, and publishing to XHTML using a frameset Acknowledgements The authors would like to thank those members of the DITA community who have authored or contributed content to this document: Kylene Bruski, Don Day, Anne Gentle, JoAnn Hackos, Jennifer Linton, Deborah Pickett, Michael Priestley, Nat Wyatt, Stephen Zhang, and various anonymous IBM writers. We are also grateful to others in the community who have offered valuable encouragement, feedback, suggestions, and sources of information: Robert Anderson, Bernard Aschwanden, Ricardo Mattiazzi Baumgartner, Bob Doyle, Andy Hall, Erik Hennum, Carolyn Henry, Ellen Livengood, Shawn McKenzie, Scott Prentice, Paul Prescod, Todd Rose, Kate Wilhelm, Stacey Winn, Chris Wong, and Bonnie Yelverton. Invitation to The authors invite others in the DITA community to contribute to future editions contribute to future of this document.To contact us: http://www.vrcommunications.com/aboutus.htm. editions DITA Open Toolkit | TOC | 3 Contents Colophon..............................................................................................2 Introduction...........................................................................................................11 About DITA (Darwin Information Typing Architecture)............................................................11 About DITA Open Toolkit (DITA OT).......................................................................................11 About this document...............................................................................................................12 Key concepts (DITAdemystified).........................................................................15 Documentation lifecycle.........................................................................................................15 Traditional lifecycle.......................................................................................................15 Typical DITA lifecycle...................................................................................................15 Technology trends in the documentation lifecycle.......................................................16 Creating and managing content..................................................................................17 Processing and publishing.....................................................................................................18 Processing and publishing overview............................................................................18 About XML...................................................................................................................19 About DTDs.................................................................................................................21 About schemas............................................................................................................21 About XSLT..................................................................................................................22 About XPath.................................................................................................................22 About Java...................................................................................................................23 Project components................................................................................................................23 Source files..................................................................................................................24 Processing files...........................................................................................................26 Output files..................................................................................................................28 Getting started......................................................................................................33 Getting information (general)..............................................................................35 Evaluating DITA and DITA Open Toolkit..............................................................41 The DITA authoring/production framework.............................................................................41 Use cases...............................................................................................................................43 Use case template..................................................................................................................44 Installing and upgrading DITA Open Toolkit.......................................................47 System requirements and supported applications.................................................................47 Installation overview...............................................................................................................49 DITA Tookit distributions..............................................................................................49 Upgrade considerations...............................................................................................50 Installation considerations...........................................................................................50 Installing your DITA authoring tool..........................................................................................51 Installing the Java SDK (JDK)................................................................................................51 Installing the JDK on Windows....................................................................................51 Installing the JDK on Linux..........................................................................................51 4 | DITA Open Toolkit | TOC Installing the DITA Tookit full package distribution..................................................................52 Installing the DITA Tookit small package distribution..............................................................53 Installing the small package on Windows....................................................................54 Installing the small package on Linux..........................................................................56 Installing on Mac OS..............................................................................................................58 Directories and files in the ditaot directory.............................................................................58 Installing the optional tools.....................................................................................................59 Installing the HTML Help compiler on Windows..........................................................60 Installing FOP on Windows..........................................................................................60 Installing the JavaHelp processor on Windows...........................................................60 Installing FOP on Linux...............................................................................................61 Installing the JavaHelp processor on Linux.................................................................61 DITAblogs (installing and upgrading)......................................................................................61 DITA Open Toolkit plug-ins..................................................................................63 About DITA Open Toolkit plug-ins...........................................................................................63 Installing the plug-ins..............................................................................................................64 Installing the Idiom FO plug-in.....................................................................................64 DITAblogs (plug-ins)...............................................................................................................64 For more information (plug-ins)..............................................................................................64 Setting up your working environment................................................................65 Configuring your authoring tool to use the Toolkit catalog......................................................65 Configuring your authoring tool to use DTD or schema URLs...............................................69
Load more

Recommended publications
  • MM — a Macro Package ______For Generating Documents
    MM — A Macro Package for Generating Documents ________________________ 1. INTRODUCTION This document is the user’s guide and reference manual for the Memorandum Macros (MM), a general- purpose package of text formatting macros for use with the UNIX system text formatters troff and nroff. The user must be familiar with the UNIX system and with the use of an editor. Some familiarity with the request summary in the Troff User’s Manual is helpful. A Troff Tutorial provides a general overview of formatter capabilities, while Troff User’s Manual provides detailed information as well as a summary of requests. 1.1 Purpose The purpose of MM is to provide a unified, consistent, and flexible tool for producing many common types of documents. Although the UNIX system provides other macro packages for various specialized formats, MM has become the standard, general-purpose macro package for most documents. MM can be used to produce: • Letters • Reports • Technical Memoranda • Released Papers • Manuals • Books The uses of MM range from single-page letters to documents of several hundred pages in length, such as user guides, design proposals, etc. 1.2 Conventions Each section of this memorandum explains a single facility of MM. In general, the earlier a section occurs, the more necessary it is for most users. Some of the later sections can be completely ignored if MM defaults are acceptable. Likewise, each section progresses from normal-case to special-case facilities. Read a section in detail only until there is enough information to obtain the desired format, then skim the rest of it because some details may be of use to just a few people.
    [Show full text]
  • Copyrights Quick Reference Series
    Copyrights Quick Reference Series Designing a t-shirt? Showing a movie on campus? Creating a website? For these things and more it is important to understand the laws and rules surrounding copyrighted material. Check out the information below to understand how copyright affects your student org. Copyright Material In the United States Code, Title 17, Section 107 of the Copyright Law allows for the “fair use” of a copyrighted work for purposes such as criticism, comment, news reporting, teaching, scholarship, or research. The Fair Use Doctrine allows for limited use of copyrighted materials without obtaining permission from the copyright holder, but the limitations are significant. The factors to be considered in determining if the copying is fair use are: The purpose and character of the use (education is more likely to be fair use and use that causes the work to be used for a new purpose is more likely to be fair use) The nature of the copyrighted work (a fact-based work is more likely to be fair use than a creative fictional work) The amount and substantiality of the copied portion compared to the work as a whole (a small portion and/or not copying the “best” portion(s) of the work is more likely to be fair use) The effect of the use on the potential market (copying that does not cause someone to not buy the whole work is more likely to be fair use) Copyright and Trademark Symbols © is the copyright symbol and signifies a creator’s exclusive rights to publish, reproduce, or sell an original work.
    [Show full text]
  • 1 Symbols (2286)
    1 Symbols (2286) USV Symbol Macro(s) Description 0009 \textHT <control> 000A \textLF <control> 000D \textCR <control> 0022 ” \textquotedbl QUOTATION MARK 0023 # \texthash NUMBER SIGN \textnumbersign 0024 $ \textdollar DOLLAR SIGN 0025 % \textpercent PERCENT SIGN 0026 & \textampersand AMPERSAND 0027 ’ \textquotesingle APOSTROPHE 0028 ( \textparenleft LEFT PARENTHESIS 0029 ) \textparenright RIGHT PARENTHESIS 002A * \textasteriskcentered ASTERISK 002B + \textMVPlus PLUS SIGN 002C , \textMVComma COMMA 002D - \textMVMinus HYPHEN-MINUS 002E . \textMVPeriod FULL STOP 002F / \textMVDivision SOLIDUS 0030 0 \textMVZero DIGIT ZERO 0031 1 \textMVOne DIGIT ONE 0032 2 \textMVTwo DIGIT TWO 0033 3 \textMVThree DIGIT THREE 0034 4 \textMVFour DIGIT FOUR 0035 5 \textMVFive DIGIT FIVE 0036 6 \textMVSix DIGIT SIX 0037 7 \textMVSeven DIGIT SEVEN 0038 8 \textMVEight DIGIT EIGHT 0039 9 \textMVNine DIGIT NINE 003C < \textless LESS-THAN SIGN 003D = \textequals EQUALS SIGN 003E > \textgreater GREATER-THAN SIGN 0040 @ \textMVAt COMMERCIAL AT 005C \ \textbackslash REVERSE SOLIDUS 005E ^ \textasciicircum CIRCUMFLEX ACCENT 005F _ \textunderscore LOW LINE 0060 ‘ \textasciigrave GRAVE ACCENT 0067 g \textg LATIN SMALL LETTER G 007B { \textbraceleft LEFT CURLY BRACKET 007C | \textbar VERTICAL LINE 007D } \textbraceright RIGHT CURLY BRACKET 007E ~ \textasciitilde TILDE 00A0 \nobreakspace NO-BREAK SPACE 00A1 ¡ \textexclamdown INVERTED EXCLAMATION MARK 00A2 ¢ \textcent CENT SIGN 00A3 £ \textsterling POUND SIGN 00A4 ¤ \textcurrency CURRENCY SIGN 00A5 ¥ \textyen YEN SIGN 00A6
    [Show full text]
  • DITA Open Toolkit 2.0 This Document Describes the DITA Open Toolkit Project—What the Project Is, and How to Use the Site
    DITA Open Toolkit 2.0 This document describes the DITA Open Toolkit project—what the project is, and how to use the site. What is the DITA Open Toolkit? The DITA Open Toolkit, or DITA-OT for short, is a set of Java-based, open source tools that provide processing for DITA maps and topic content. You can download the OT and install it for free on your computer to get started with topic-based writing and publishing. The DITA-OT is licensed under the CPL 1.0 and Apache 2.0 open source licenses. Note: While the DITA Standard itself is owned and developed by OASIS, the DITA Open Toolkit is an independent, open source implementation of the standard. Key output formats for the toolkit include: XHTML PDF (formerly known as PDF2) ODT (Open Document Format) Eclipse Help TocJS (XHTML with a JavaScript frameset) HTML Help Java Help Eclipse Content (normalized DITA plus Eclipse project files) Word RTF (with some limitations) Docbook Troff Toolkit documentation There are two primary sources for documentation about the toolkit. Stable documentation about toolkit usage, parameters, and project management can be found on this page, using the navigation panel on the left. New information about the latest toolkit builds, plans for the next release, and other changing information can be found on the DITA-OT landing page at the dita.xml.org site (link below). That site also contains the release notes for all upcoming and previous releases. Related concepts Distribution packages Related information Main DITA-OT page at dita.xml.org Project News for DITA Open Toolkit Shortcuts to important information DITA-OT stable release DITA-OT latest development build Getting Started with the DITA Open Toolkit The Getting Started Guide is designed to provide a guided exploration of the DITA Open Toolkit.
    [Show full text]
  • The Brill Typeface User Guide & Complete List of Characters
    The Brill Typeface User Guide & Complete List of Characters Version 2.06, October 31, 2014 Pim Rietbroek Preamble Few typefaces – if any – allow the user to access every Latin character, every IPA character, every diacritic, and to have these combine in a typographically satisfactory manner, in a range of styles (roman, italic, and more); even fewer add full support for Greek, both modern and ancient, with specialised characters that papyrologists and epigraphers need; not to mention coverage of the Slavic languages in the Cyrillic range. The Brill typeface aims to do just that, and to be a tool for all scholars in the humanities; for Brill’s authors and editors; for Brill’s staff and service providers; and finally, for anyone in need of this tool, as long as it is not used for any commercial gain.* There are several fonts in different styles, each of which has the same set of characters as all the others. The Unicode Standard is rigorously adhered to: there is no dependence on the Private Use Area (PUA), as it happens frequently in other fonts with regard to characters carrying rare diacritics or combinations of diacritics. Instead, all alphabetic characters can carry any diacritic or combination of diacritics, even stacked, with automatic correct positioning. This is made possible by the inclusion of all of Unicode’s combining characters and by the application of extensive OpenType Glyph Positioning programming. Credits The Brill fonts are an original design by John Hudson of Tiro Typeworks. Alice Savoie contributed to Brill bold and bold italic. The black-letter (‘Fraktur’) range of characters was made by Karsten Lücke.
    [Show full text]
  • Intellectual Property Fundamentals
    Intellectual Property Fundamentals Presented by: The Intellectual Property Advisory Group © 2016 by the State of California, Department of General Services What is intellectual property? Intellectual property (IP) is a legal term that refers to creations of the mind, including an idea, invention or process that are protectable under copyright, patent, trademark, and trade secrets law. Common examples include: Books Sculpture Designs Discoveries Logos Phrases Software Symbols Words There are four main types of intellectual property: 1. Copyrights 2. Trademarks 3. Trade Secrets 4. Patents What is copyright? Copyright protects original work of authorship such as literary works, audio/video recordings, software, photos, and maps created by a state agency, department or by one of its consultants or vendors. Copyright law is governed by the U.S. Copyright Act of 1976 (Title 17, U.S.C., section 101 et seq.) Examples of works of authorship: Presentations Books Brochures Copyright Protection The person who created the work is called the “author.” An author automatically has copyright protection for his or her original works of authorship once they have been expressed in a tangible form. Tangible: is it real; can it be touched or reproduced; is it something that can be perceived by the senses. The author has the exclusive right to do and authorize others to: 1. Reproduce the work 2. Prepare derivative work 3. Distribute copies of the work 4. Perform the work 5. Display the work Creation of Copyrighted Materials Copyright does NOT protect thoughts
    [Show full text]
  • SYMETRA SEPARATE ACCOUNT SL Form N-6 Filed 2021-06-10
    SECURITIES AND EXCHANGE COMMISSION FORM N-6 Registration statement for separate accounts (unit investment trusts) Filing Date: 2021-06-10 SEC Accession No. 0000806180-21-000038 (HTML Version on secdatabase.com) FILER SYMETRA SEPARATE ACCOUNT SL Mailing Address Business Address 777 108TH AVE NE 777 108TH AVE NE CIK:806180| IRS No.: 910742147 | State of Incorp.:WA | Fiscal Year End: 1231 SUITE 1200 SUITE 1200 Type: N-6 | Act: 40 | File No.: 811-04909 | Film No.: 211007623 BELLEVUE WA 98004 BELLEVUE WA 98004 877-796-3872 SYMETRA SEPARATE ACCOUNT SL Mailing Address Business Address 777 108TH AVE NE 777 108TH AVE NE CIK:806180| IRS No.: 910742147 | State of Incorp.:WA | Fiscal Year End: 1231 SUITE 1200 SUITE 1200 Type: N-6 | Act: 33 | File No.: 333-256975 | Film No.: 211007622 BELLEVUE WA 98004 BELLEVUE WA 98004 877-796-3872 Copyright © 2021 www.secdatabase.com. All Rights Reserved. Please Consider the Environment Before Printing This Document As filed with the Securities and Exchange Commission on June 10, 2021. File Nos. ____________/811-04909 SECURITIES AND EXCHANGE COMMISSION Washington, D.C. 20549 FORM N-6 REGISTRATION STATEMENT X UNDER THE SECURITIES ACT OF 1933 Pre-Effective Amendment No. Post-Effective Amendment No. REGISTRATION STATEMENT X UNDER THE INVESTMENT COMPANY ACT OF 1940 Amendment No. 43 X (Check appropriate box or boxes.) SYMETRA SEPARATE ACCOUNT SL (Exact Name of Registrant) Symetra Life Insurance Company (Name of Depositor) 777 108th Ave NE, Suite 1200, Bellevue, WA 98004 (Address of Depositor's Principal Executive Offices)
    [Show full text]
  • Punctuation Makes a Difference in Translation
    Punctuation Marks Make a Difference in Translation: Practical Examples Mogahed M. Mogahed Faculty of Education, Mansoura University Curriculum & Instruction Department 2012 1 “The writer who neglects punctuation, or mispunctuates, is liable to be misunderstood.” American Writer: Edgar Allan Poe ABSTARCT This article deals with the issue of using punctuation marks correctly. The misuse of punctuation marks affects meaning; therefore, it affects translation. As a result, the writer should pay more attention to punctuation marks and not to use them randomly. Simultaneously, the reader has to take care of the punctuation marks when interpreting a certain text for translation. The article tackles the jobs done by punctuation marks such as the use of the comma to set off nonessential information, the comma to set off interrupters, the comma separating direct-address expressions, the comma with short introductory statements and the comma before a relative pronoun. Moreover, the difficulties caused by lack of a comma will be discussed. The problematic use of comma before "and" will be handled. Cases in which no comma is needed in the target language will be provided. The current article provides some practical and illustrative examples, especially the comma and the full stop. Translation from English into Arabic and vice versa is considered. Keywords Punctuation, Translation, English, Arabic, Meaning, Writing, Reading, Contrastive Analysis 1. Introduction Punctuation plays a vital role in the interpretation of a certain text. So using it haphazardly leads to misunderstanding the text and consequently the wrong translation. There are many differences between languages with regard to punctuation marks, particularly Arabic and English, which have to be taken into consideration by translators.
    [Show full text]
  • University of Iowa Editorial Style Office of Strategic Communication
    University of Iowa Editorial Style Office of Strategic Communication 2 References Living learning communities Percent Place names with compass points Rankings 2 Abbreviations Prepositions Semester hours Addresses: compass points Proper nouns Telephone numbers Addresses, words in Ranks and titles Time: noon, midnight Ampersand Regents, Board of Days Room names 24 Online style Expressions: i.e., e.g., etc. Scientific names of plants, animals Website names General Education Program Teacher Education Program URLs Grade-point average “The” in names and titles Measure, units of The University of Iowa 25 Proprietary marks Months University organizations Copyright, trademark, Names of agencies, organizations service mark Names of cities: Fort, Mount, Port, 16 Ellipses Brand names and generic terms Saint Ellipses in text Names of companies Ellipses in display type, layout 25 Punctuation Names of people Colons and capitalization Names of people: Jr., Sr., II Faculty, administrators Colon in display type States and territories See “Titles: People and Things” Comma in series Teacher Education Program Comma with adjectives The University of Iowa 17 Headlines Comma with expressions Time: a.m. and p.m. Capitalization Comma with year United States Decks Letter grades Quote marks in quotations 6 Academic degrees 17 Hyphens/dashes in compounds Quote marks with titles Abbreviation Adverbs ending in “ly” Quote marks with other punctuation Capitalization Clarity Reference to a word or term Double major or two degrees? Common element in series Semicolon in
    [Show full text]
  • Oxygen XML Editor 12.2
    Oxygen XML Editor 12.2 Oxygen XML Editor | TOC | 3 Contents Chapter 1: Introduction................................................................................17 Key Features and Benefits of Oxygen XML Editor ..............................................................................18 Chapter 2: Installation..................................................................................21 Installation Requirements.......................................................................................................................22 Platform Requirements...............................................................................................................22 Operating System.......................................................................................................................22 Environment Requirements........................................................................................................22 JWS-specific Requirements.......................................................................................................22 Installation Instructions..........................................................................................................................23 Windows Installation..................................................................................................................23 Mac OS X Installation................................................................................................................24 Linux Installation.......................................................................................................................24
    [Show full text]
  • MASFAA Handbook 2020
    Handbook of Standing Rules Updated on August 2020 Table of Contents Chapter 1 – MASFAA Overview & History History 3 Past Presidents 19 Mission and Vision 20 Chapter 2 – Governance Executive Council 21 Chapter 3 – Committees General Committee Information 33 Awards 39 Access, Inclusion, and Diversity 40 Communication 41 Conference 42 Development 43 Early Awareness and Outreach 44 EASFAA Representative 45 FAFSA Day Massachusetts 46 Finance 47 Financial Wellness and Education 48 Government Relations 49 Graduate and Professional Concerns 50 Membership 51 Nominating 52 Professional development and Training 53 Technology 56 Chapter 4 – Finances Policies and Procedures 57 Exhibitor Guidelines 61 Dues 63 Chapter 5 – Membership Membership 64 Chapter 6 – Annual Conference Annual Conference 67 Chapter 7 – Publications Publications 71 Chapter 8 – Awards Awards 73 Chapter 9 – Scholarships Scholarships 80 Chapter 10 – Organizational Matters Organizational Matters 81 MASFAA Handbook of Standing Rules 2 August 2020 CHAPTER ONE – MASFAA OVERVIEW & HISTORY THE HISTORY OF MASFAA The Massachusetts Association of Student Financial Aid Administrators (MASFAA) is a state-wide, non- profit corporation of individual members who have the responsibility for the administration of student financial assistance at institutions of postsecondary education and interested in promoting effective management of student aid funds. MASFAA began in 1969 when five financial aid administrators began a communications network among themselves. MASFAA now has over 800 members representing 200 public, private, and proprietary institutions of higher education as well as numerous associate members from related organizations and industries. The Association is led by the MASFAA Council, which is comprised of the Executive Council, Committee Chairs, and the EASFAA Representative.
    [Show full text]
  • Symbols & Glyphs 1
    Symbols & Glyphs Content Shortcut Category ← leftwards-arrow Arrows ↑ upwards-arrow Arrows → rightwards-arrow Arrows ↓ downwards-arrow Arrows ↔ left-right-arrow Arrows ↕ up-down-arrow Arrows ↖ north-west-arrow Arrows ↗ north-east-arrow Arrows ↘ south-east-arrow Arrows ↙ south-west-arrow Arrows ↚ leftwards-arrow-with-stroke Arrows ↛ rightwards-arrow-with-stroke Arrows ↜ leftwards-wave-arrow Arrows ↝ rightwards-wave-arrow Arrows ↞ leftwards-two-headed-arrow Arrows ↟ upwards-two-headed-arrow Arrows ↠ rightwards-two-headed-arrow Arrows ↡ downwards-two-headed-arrow Arrows ↢ leftwards-arrow-with-tail Arrows ↣ rightwards-arrow-with-tail Arrows ↤ leftwards-arrow-from-bar Arrows ↥ upwards-arrow-from-bar Arrows ↦ rightwards-arrow-from-bar Arrows ↧ downwards-arrow-from-bar Arrows ↨ up-down-arrow-with-base Arrows ↩ leftwards-arrow-with-hook Arrows ↪ rightwards-arrow-with-hook Arrows ↫ leftwards-arrow-with-loop Arrows ↬ rightwards-arrow-with-loop Arrows ↭ left-right-wave-arrow Arrows ↮ left-right-arrow-with-stroke Arrows ↯ downwards-zigzag-arrow Arrows 1 ↰ upwards-arrow-with-tip-leftwards Arrows ↱ upwards-arrow-with-tip-rightwards Arrows ↵ downwards-arrow-with-tip-leftwards Arrows ↳ downwards-arrow-with-tip-rightwards Arrows ↴ rightwards-arrow-with-corner-downwards Arrows ↵ downwards-arrow-with-corner-leftwards Arrows anticlockwise-top-semicircle-arrow Arrows clockwise-top-semicircle-arrow Arrows ↸ north-west-arrow-to-long-bar Arrows ↹ leftwards-arrow-to-bar-over-rightwards-arrow-to-bar Arrows ↺ anticlockwise-open-circle-arrow Arrows ↻ clockwise-open-circle-arrow
    [Show full text]