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 Fourth Edition - December 3, 2007 - DITA Open Toolkit 1.4.1 OpenTopic | TOC | 3 Contents Abstract................................................................................................................................13 Chapter 1: Introduction................................................................................15 About DITA (Darwin Information Typing Architecture).......................................................................16 About DITA Open Toolkit (DITA OT)...................................................................................................16 About this document..............................................................................................................................17 Chapter 2: Key concepts (DITAdemystified)..............................................19 Documentation lifecycle.........................................................................................................................20 Traditional lifecycle....................................................................................................................20 Typical DITA lifecycle...............................................................................................................20 Technology trends in the documentation lifecycle.....................................................................21 Creating and managing content..................................................................................................22 Processing and publishing......................................................................................................................23 Processing and publishing overview..........................................................................................23 About XML................................................................................................................................24 About DTDs...............................................................................................................................26 About schemas...........................................................................................................................26 About XSLT...............................................................................................................................27 About XPath...............................................................................................................................27 About Java..................................................................................................................................28 Project components................................................................................................................................28 Source files.................................................................................................................................29 Processing files...........................................................................................................................31 Output files.................................................................................................................................33 Chapter 3: Getting started............................................................................37 Phase 1: Planning and setting up your environment..............................................................................38 Phase 2: Setting up.................................................................................................................................38 Phase 3: Implementing...........................................................................................................................38 Chapter 4: Getting information (general)...................................................39 General information...............................................................................................................................40 Tools and downloads..............................................................................................................................40 Training and education...........................................................................................................................40 Consulting..............................................................................................................................................41 Standards, releases.................................................................................................................................42 Usage......................................................................................................................................................43 4 | OpenTopic | TOC User groups............................................................................................................................................43 Conferences............................................................................................................................................43 Chapter 5: Evaluating DITA and DITA Open Toolkit...............................45 The DITA authoring/production framework..........................................................................................46 Use cases................................................................................................................................................48 Use case template...................................................................................................................................49 Chapter 6: Installing and upgrading DITA Open Toolkit..........................51 System requirements and supported applications..................................................................................52 Installation overview..............................................................................................................................54 DITA Tookit distributions...........................................................................................................54 Upgrade considerations..............................................................................................................54 Installation considerations..........................................................................................................55 Installing your DITA authoring tool.......................................................................................................55 Installing the Java SDK (JDK)...............................................................................................................55 Installing the JDK on Windows..................................................................................................55 Installing the JDK on Linux.......................................................................................................56 Installing the DITA Tookit full package distribution.............................................................................56 Installing the DITA Tookit small package distribution..........................................................................58 Installing the small package on Windows..................................................................................58 Installing the small package on Linux........................................................................................61 Installing on Mac OS..............................................................................................................................63 Directories and files in the ditaot directory............................................................................................63 Installing the optional tools....................................................................................................................64 Installing the HTML Help compiler on Windows......................................................................64 Installing FOP on Windows........................................................................................................65 Installing the JavaHelp processor on Windows..........................................................................65 Installing FOP on Linux.............................................................................................................65 Installing the JavaHelp processor on Linux...............................................................................66 DITAblogs (installing and upgrading)....................................................................................................66 Chapter 7: DITA Open Toolkit plug-ins......................................................67 About DITA Open Toolkit plug-ins........................................................................................................68 Installing the plug-ins.............................................................................................................................68 Installing the Idiom FO plug-in..................................................................................................69 DITAblogs (plug-ins).............................................................................................................................69 For more information (plug-ins).............................................................................................................69 Chapter 8: Setting up your working environment......................................71 Configuring your authoring tool to use the Toolkit catalog...................................................................72
Load more

Recommended publications
  • Altova Xmlspy 2019 Enterprise Edition 1 7 Project Management 81 7.1 Benefits O..F
    Altova XMLSpy 2019 Tutorial Altova XMLSpy 2019 Tutorial All rights reserved. No parts of this work may be reproduced in any form or by any means - graphic, electronic, or mechanical, including photocopying, recording, taping, or information storage and retrieval systems - without the written permission of the publisher. Products that are referred to in this document may be either trademarks and/or registered trademarks of the respective owners. The publisher and the author make no claim to these trademarks. While every precaution has been taken in the preparation of this document, the publisher and the author assume no responsibility for errors or omissions, or for damages resulting from the use of information contained in this document or from the use of programs and source code that may accompany it. In no event shall the publisher and the author be liable for any loss of profit or any other commercial damage caused or alleged to have been caused directly or indirectly by this document. Published: 2019 © 2019 Altova GmbH Table of Contents 1 XMLSpy Interface 2 1.1 The Views.. .................................................................................................... 4 1.2 The Windo..w..s.. ................................................................................................ 6 1.3 Menus and.. .T..o..o.l.b..a..r.s. ....................................................................................... 8 1.4 Text View... .S..e..t.t.in..g..s. ....................................................................................... 10 2 XML Schemas: Basics 14 2.1 Creating .a. .N...e..w... .X..M...L... .S..c.h..e..m...a. .F..i.l.e.. ............................................................... 15 2.2 Defining .N..a..m...e..s.p..a..c.e..s.. .................................................................................. 17 2.3 Defining .a. .C...o..n.t.e..n..t.
    [Show full text]
  • 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]
  • Xmlspy 2007 Datasheet.Qxp
    Altova® XMLSpy ® 2007 – The industry standard XML development environment. Bring your development plans to light Altova® XMLSpy® 2007 is the industry standard XML development environment for modeling, editing, transforming, and debugging XML-related technologies. Offering the world’s leading XML editor, the original graphical schema designer, a code generator, file converters, debuggers, profilers, a revolutionary new WSDL designer, support for SOAP, XSLT, and XQuery, plus Visual Studio® .NET and Eclipse integration, it’s the essential tool for mastering XML. Simplify and Accelerate XML Development Today, eXtensible Markup Language (XML) technologies play a critical role in all software development projects. XML has received widespread support and adoption in the computer industry because of its simplicity, extensibility, interoperability, and flexibility, all of which stem from its power to represent data independent of programming language, platform, or operating system. In XML-based applications, XML is used alongside complementary technologies such as XML Schema, XSLT, XQuery, Web services, and others. Today's developer needs a tool for creating, editing, and debugging these XML-related technologies in an efficient, standards-based manner. Altova XMLSpy 2007 delivers all the power you need to create the most advanced XML applications, yet at the same time it's flexible enough to allow you to work with XML using the views and options that best suit your specific requirements and preferences. XMLSpy 2007 increases productivity by allowing
    [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]
  • Altova Xmlspy Tutorial (For Home Edition)
    Tutorial Altova XMLSpy Tutorial (for Home Edition) All rights reserved. No parts of this work may be reproduced in any form or by any means - graphic, electronic, or mechanical, including photocopying, recording, taping, or information storage and retrieval systems - without the written permission of the publisher. Products that are referred to in this document may be either trademarks and/or registered trademarks of the respective owners. The publisher and the author make no claim to these trademarks. While every precaution has been taken in the preparation of this document, the publisher and the author assume no responsibility for errors or omissions, or for damages resulting from the use of information contained in this document or from the use of programs and source code that may accompany it. In no event shall the publisher and the author be liable for any loss of profit or any other commercial damage caused or alleged to have been caused directly or indirectly by this document. Published: 2006 © 2006 Altova GmbH Table of Contents 1 The interface 2 2 Creating a schema from scratch 3 2.1 Creating a new Schema...................................................................................................... file 4 2.2 Adding elements...................................................................................................... to a schema 7 2.3 Adding elements...................................................................................................... using drag and drop 10 2.4 Completing the.....................................................................................................
    [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]
  • XML Validation Guide
    XML Validation Guide Questions or comments about this document should be directed to: Email [email protected] Phone 517‐335‐0505 x3 Table of Contents Introduction .........................................................................................................................................................................2 XML File Validation ...............................................................................................................................................................5 Software Installation ......................................................................................................................................................5 Validating an XML File against the Schema File .......................................................................................................... 11 XML Schema Validation ..................................................................................................................................................... 13 Software Installation ................................................................................................................................................... 13 Plug‐in Installation ...................................................................................................................................................... 19 Validating a Schema File ............................................................................................................................................. 24 How to Read the Error
    [Show full text]
  • Altova Xmlspy 2010 User & Reference Manual
    User Manual and Programmers' Reference Altova XMLSpy 2010 User & Reference Manual All rights reserved. No parts of this work may be reproduced in any form or by any means - graphic, electronic, or mechanical, including photocopying, recording, taping, or information storage and retrieval systems - without the written permission of the publisher. Products that are referred to in this document may be either trademarks and/or registered trademarks of the respective owners. The publisher and the author make no claim to these trademarks. While every precaution has been taken in the preparation of this document, the publisher and the author assume no responsibility for errors or omissions, or for damages resulting from the use of information contained in this document or from the use of programs and source code that may accompany it. In no event shall the publisher and the author be liable for any loss of profit or any other commercial damage caused or alleged to have been caused directly or indirectly by this document. Published: 2010 © 2010 Altova GmbH Table of Contents Welcome to XMLSpy 3 User Manual 6 1 New Features 7 2 Introduction 8 2.1 The Graphical.........................................................................................................................................9 User Interface (GUI) 2.1.1 Main Window............................................................................................................................10 2.1.2 Project Window............................................................................................................................11
    [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]
  • Altova Xmlspy 2013 User and Reference Manual
    User Manual and Programmers' Reference Altova XMLSpy 2013 User and Reference Manual All rights reserved. No parts of this work may be reproduced in any form or by any means - graphic, electronic, or mechanical, including photocopying, recording, taping, or information storage and retrieval systems - without the written permission of the publisher. Products that are referred to in this document may be either trademarks and/or registered trademarks of the respective owners. The publisher and the author make no claim to these trademarks. While every precaution has been taken in the preparation of this document, the publisher and the author assume no responsibility for errors or omissions, or for damages resulting from the use of information contained in this document or from the use of programs and source code that may accompany it. In no event shall the publisher and the author be liable for any loss of profit or any other commercial damage caused or alleged to have been caused directly or indirectly by this document. Published: 2013 © 2013 Altova GmbH Table of contents Welcome to XMLSpy 3 User Manual 6 1 Introduction 8 1.1 The Graphical.........................................................................................................................................9 User Interface (GUI) 1.1.1 Main Window............................................................................................................................10 1.1.2 Project Window............................................................................................................................11
    [Show full text]