DOCSLIB.ORG

Xmetal Authoring Guide

Total Page：16

File Type：pdf, Size：1020Kb

Download full-text PDF Read full-text
Xmetal Authoring Guide Dell KACE XMetaL Author 8 Version 1.1 Authoring Guide March 2014 DRAFT DRAFT © 2012-2014 Dell Inc. All rights reserved. Reproduction of these materials in any manner whatsoever without the written permission of Dell Inc. is strictly forbidden. Dell and the DELL logo are trademarks of Dell Inc. Other trademarks and trade names may be used in this document to refer to either the entities claiming the marks and names or their products. Dell Inc. disclaims any proprietary interest in trademarks and trade names other than its own. Contents 1 Getting started.................................................................5 2 Working with DITA and XMetaL Author...................................7 Structuring and reusing information with DITA............................................................7 DITA topics.................................................................................................7 XML elements and attributes............................................................................9 Content references.......................................................................................9 Conditional text...........................................................................................9 Familiarizing yourself with XMetaL Author................................................................11 Navigating the XMetaL Author interface.............................................................11 About view modes.......................................................................................13 3 Writing and managing content............................................15 Determining the topics that you need and their structure.............................................15 Converting an outline into the content and structure of your project..........................15 Base your topic creation on task documentation...................................................17 Determine the maps and hierarchy...................................................................18 Set up the DITA directory...............................................................................18 Set up the project............................................................................................19 Create a DITA map.......................................................................................20 Add metadata to a master map.......................................................................20 Create a topic............................................................................................21 Import submaps into an XMetaL project.............................................................23 Import topics into an XMetaL project................................................................24 Optional: Insert multiple topics into a DITA Map...................................................24 Working with elements.......................................................................................25 Create a Menu Cascade.................................................................................25 Change an element......................................................................................DRAFT26 Change a note type from Note to Important or other DSG identifier...........................26 Delete an element.......................................................................................27 Testing element appearance...........................................................................27 Working with topics...........................................................................................28 Basic elements of a topic...............................................................................28 Submit Documentation Feedback 3 Dell KACE XMetaL Author 8 Version 1.1 Authoring Guide Short descriptions (<shortdesc>) are important for usability of the UI.........................29 Copying and pasting content...........................................................................29 Cross-references, related links, and relationship tables..........................................30 Index your topic..........................................................................................33 Combining tasks into a supertask.....................................................................34 Mark a step as optional.................................................................................36 Using tables...............................................................................................37 Reusing common steps, paragraphs, and other elements from a separate resource topic...39 Adding comments to a topic for reviews or to impart background information...............42 Working with graphics........................................................................................44 Creating a raster graphic screen capture............................................................45 Creating a vector graphic image......................................................................47 Inserting figures and images into a topic............................................................47 Creating appendixes..........................................................................................50 Insert the appendix container topic in the map....................................................50 Creating a glossary............................................................................................51 Create and insert a glossary topic....................................................................51 4 Generating output...........................................................53 Validate the content..........................................................................................53 Generate the output..........................................................................................54 Configure a draft PDF for commenting by reviewers....................................................55 Fix the bookmarks in release note PDFs...................................................................55 A DITA tag elements ..........................................................57 B Fix a link in the PDF output...............................................65 Glossary..........................................................................67 Index..............................................................................DRAFT69 4 Submit Documentation Feedback 1 Getting started You can use this document to become familiar with how the technical publications group creates documentation using DITA and XMetaL Author. This document has been authored in XMetaL Author and serves three purposes: • It helps writers get up-to-speed on XMetaL Author. • It serves as a sample document for testing XMetaL Author capabilities and reviewing or tweaking the WebHelp and PDF output files. • It is a repository of Best Practices for how Dell KACE writers work with DITA and XMetaL Author. DITA Best Practices: A Roadmap for Writing, Editing, and Architecting in DITA, by Laura Bellamy, Michelle Carey, and Jenifer Schlotfeldt is the standard guide adopted by the technical publications group. Refer to it for issues not addressed in this Authoring Guide. DRAFT Submit Documentation Feedback 5 Dell KACE XMetaL Author 8 Version 1.1 Authoring Guide DRAFT 6 Submit Documentation Feedback 2 Working with DITA and XMetaL Author Darwin Information Typing Architecture (DITA) is an architecture that enables you to reuse information in different contexts and to publish in various formats. XMetaL Author is the software application you use for creating and editing DITA documents in XML. Topics in this section: • Structuring and reusing information with DITA on page 7 • Familiarizing yourself with XMetaL Author on page 11 Structuring and reusing information with DITA Conceived as a tool to facilitate minimalist and topic-based writing, DITA enables the writer to create concise units of information that can stand independent of any other, but that can be reused and organized according to different goals. The basic unit of organization in DITA is the topic. This relatively small unit (as opposed to a section or book) facilitates information reuse and repurposing. You organize your topics in a master map and submaps. Maps organize topics for a particular deliverable. A topic can appear in multiple maps across deliverables. This architecture creates a standard structure that you can use to create consistently organized content that can be reused in various contexts and published in any format using the DITA Open Toolkit. For example, you may need an online help system that contains many of the same topics found in a printed (PDF) user guide. Or, it is possible to use a single master map to output both help system and user guide from the same set of topics. Note: DITA is structured and requires more up-front planning of your heading hierarchy. Unlike Word or HTML, headings cannot be placed wherever you want. Creating a fairly complete outline or table of contents while writing a project's doc plan will form the basis for implementing the structure. DITA topics DITA topics are categorized to provide users of technical information with the types of content they need: background or conceptual information, procedural information, and additional reference material. DRAFT Three distinct topic types come out of this categorization: Concepts, Tasks, and References. There is a fourth topic type, Glossary, that has a reference-ish purpose, but is specialized enough to have its own type
Load more

Recommended publications
  • XML for Java Developers G22.3033-002 Course Roadmap
    XML for Java Developers G22.3033-002 Session 1 - Main Theme Markup Language Technologies (Part I) Dr. Jean-Claude Franchitti New York University Computer Science Department Courant Institute of Mathematical Sciences 1 Course Roadmap Consider the Spectrum of Applications Architectures Distributed vs. Decentralized Apps + Thick vs. Thin Clients J2EE for eCommerce vs. J2EE/Web Services, JXTA, etc. Learn Specific XML/Java “Patterns” Used for Data/Content Presentation, Data Exchange, and Application Configuration Cover XML/Java Technologies According to their Use in the Various Phases of the Application Development Lifecycle (i.e., Discovery, Design, Development, Deployment, Administration) e.g., Modeling, Configuration Management, Processing, Rendering, Querying, Secure Messaging, etc. Develop XML Applications as Assemblies of Reusable XML- Based Services (Applications of XML + Java Applications) 2 1 Agenda XML Generics Course Logistics, Structure and Objectives History of Meta-Markup Languages XML Applications: Markup Languages XML Information Modeling Applications XML-Based Architectures XML and Java XML Development Tools Summary Class Project Readings Assignment #1a 3 Part I Introduction 4 2 XML Generics XML means eXtensible Markup Language XML expresses the structure of information (i.e., document content) separately from its presentation XSL style sheets are used to convert documents to a presentation format that can be processed by a target presentation device (e.g., HTML in the case of legacy browsers) Need a
    [Show full text]
  • Xmetal® Author Enterprise - SP Edition Bring the Efficiency of XML and DITA to Your Sharepoint Implementation
    PRODUCT OVERVIEW SP Edition XMetaL® Author Enterprise - SP Edition Bring the Efficiency of XML and DITA to your SharePoint Implementation Microsoft® SharePoint® helps accelerate and more clearly define shared business processes and facilitates more productive use and sharing of information, using a platform familiar to a company’s IT professionals and developers.With XMetaL® Author Enterprise, you can use XML to manage your content even more effectively. Content Efficiency Drives Your Competitive • More control over your global brand Advantage A Proven Authoring Tool with Seamless Today’s globally-focused, customer-driven Connectivity organizations face extraordinary challenges. Under growing expectations from customers, businesses Repeatedly voted as the top choice of end users, are increasingly expected to deliver product, service XMetaL’s flexibility and usability makes it easy for and support information in each customer’s native anyone in your organization to create, share, reuse, language, in the format they want, when they need and deliver XML-based content, including less it. Businesses are also under pressure to deliver frequent content contributors such as engineers, professional content quickly, to reduce publishing and managers, and customer service staff. A single localization costs, and to keep publications consistent seamlessly integrated interface for authoring, and up-to-date. searching, and managing valid XML content will enable front-line staff to more effectively manage To meet these challenges, many companies are content, helping you reach new levels of efficiency turning to XML, and in particular to a variety of XML and quality. named the Darwin Information Typing Architecture (DITA). Among the available technologies for creating Together, XMetaL and SharePoint offer a and storing content, XML is the gold standard comprehensive content lifecycle solution that enables for scalable content reuse, robust support for all you to harness the value of your organization’s languages, and clean output to multiple deliverables.
    [Show full text]
  • SDL Tridion Docs Release Notes
    SDL Tridion Docs Release Notes SDL Tridion Docs 14 SP1 December 2019 ii SDL Tridion Docs Release Notes 1 Welcome to Tridion Docs Release Notes 1 Welcome to Tridion Docs Release Notes This document contains the complete Release Notes for SDL Tridion Docs 14 SP1. Customer support To contact Technical Support, connect to the Customer Support Web Portal at https://gateway.sdl.com and log a case for your SDL product. You need an account to log a case. If you do not have an account, contact your company's SDL Support Account Administrator. Acknowledgments SDL products include open source or similar third-party software. 7zip Is a file archiver with a high compression ratio. 7-zip is delivered under the GNU LGPL License. 7zip SFX Modified Module The SFX Modified Module is a plugin for creating self-extracting archives. It is compatible with three compression methods (LZMA, Deflate, PPMd) and provides an extended list of options. Reference website http://7zsfx.info/. Akka Akka is a toolkit and runtime for building highly concurrent, distributed, and fault tolerant event- driven applications on the JVM. Amazon Ion Java Amazon Ion Java is a Java streaming parser/serializer for Ion. It is the reference implementation of the Ion data notation for the Java Platform Standard Edition 8 and above. Amazon SQS Java Messaging Library This Amazon SQS Java Messaging Library holds the Java Message Service compatible classes, that are used for communicating with Amazon Simple Queue Service. Animal Sniffer Annotations Animal Sniffer Annotations provides Java 1.5+ annotations which allow marking methods which Animal Sniffer should ignore signature violations of.
    [Show full text]
  • SDL Contenta 5.7.1 Release Notes
    SDL Contenta Release Notes SDL Contenta 5.7.1 September 2019 Legal notice Copyright and trademark information relating to this product release. Copyright © 2009–2019 SDL Group. SDL Group means SDL PLC. and its subsidiaries and affiliates. All intellectual property rights contained herein are the sole and exclusive rights of SDL Group. All references to SDL or SDL Group shall mean SDL PLC. and its subsidiaries and affiliates details of which can be obtained upon written request. All rights reserved. Unless explicitly stated otherwise, all intellectual property rights including those in copyright in the content of this website and documentation are owned by or controlled for these purposes by SDL Group. Except as otherwise expressly permitted hereunder or in accordance with copyright legislation, the content of this site, and/or the documentation may not be copied, reproduced, republished, downloaded, posted, broadcast or transmitted in any way without the express written permission of SDL. Contenta is a registered trademark of SDL Group. All other trademarks are the property of their respective owners. The names of other companies and products mentioned herein may be the trademarks of their respective owners. Unless stated to the contrary, no association with any other company or product is intended or should be inferred. This product may include open source or similar third-party software, details of which can be found by clicking the following link: “Acknowledgments” on page 55. Although SDL Group takes all reasonable measures to provide accurate and comprehensive information about the product, this information is provided as-is and all warranties, conditions or other terms concerning the documentation whether express or implied by statute, common law or otherwise (including those relating to satisfactory quality and fitness for purposes) are excluded to the extent permitted by law.
    [Show full text]
  • SDL Knowledge Center Release Notes
    SDL Knowledge Center Release Notes SDL Knowledge Center 13 November 2017 Legal notice Copyright and trademark information relating to this product release. Copyright © 2003–2017 SDL Group. SDL Group means SDL PLC. and its subsidiaries and affiliates. All intellectual property rights contained herein are the sole and exclusive rights of SDL Group. All references to SDL or SDL Group shall mean SDL PLC. and its subsidiaries and affiliates details of which can be obtained upon written request. All rights reserved. Unless explicitly stated otherwise, all intellectual property rights including those in copyright in the content of this website and documentation are owned by or controlled for these purposes by SDL Group. Except as otherwise expressly permitted hereunder or in accordance with copyright legislation, the content of this site, and/or the documentation may not be copied, reproduced, republished, downloaded, posted, broadcast or transmitted in any way without the express written permission of SDL. SDL Knowledge Center is a registered trademark of SDL Group. All other trademarks are the property of their respective owners. The names of other companies and products mentioned herein may be the trademarks of their respective owners. Unless stated to the contrary, no association with any other company or product is intended or should be inferred. This product may include open source or similar third-party software, details of which can be found by clicking the following link: “Acknowledgments” on page 2. Although SDL Group takes all reasonable measures to provide accurate and comprehensive information about the product, this information is provided as-is and all warranties, conditions or other terms concerning the documentation whether express or implied by statute, common law or otherwise (including those relating to satisfactory quality and fitness for purposes) are excluded to the extent permitted by law.
    [Show full text]
  • XML Tools for Databases Will Help Usher in the Era of Electronic Government
    XML tools for databases will help usher in the era of electronic government Company Product Platforms Query language Interfaces Integration modules and Other features Typical applications Price tools Infonyte GmbH Infonyte- Java XPath 1.0, XQL '99 and W3C Document Object Integration with Java Web Persistent DOM with Interactive electronic technical $980 for develop- Darmstadt, Germany DB Plaform extensions; XSLT 1.0 sup- Model Level 2 API; Java servers, J2EE application transparent main memory documentation, enterprise application er license, $2,480 49 (0) 700 4636 69 83 (Windows, ports XQL, XPath and XSLT API for XML processing servers, WebDAV Web access, self-optimizing integration, report generation, docu- for server runtime www.infonyte.com Linux, algebraic query optimizer; servers; specific inter- cache, thread-safe imple- ment workflows, cross-media pub- license, $198 for Solaris, XQuery pending W3C rec- faces to back-end sys- mentation, up to 1T storage lishing, content management single-user run- HP-UX) ommendation tems on request for XML documents time license; gov- ernment dis- counts available Interwoven Inc. TeamXML Windows, XPath proprietary query lan- Command line tools, Integration modules with Services include workflow, XML and regulated document Depends on size Sunnyvale, Calif. Sun Solaris guage; open to any XML Java, Simple Object XML authoring tools and versioning, search and management, content globalization of implementation 401-774-2000 standard query language Access Protocol and XML content production tools retrieve, classification and automation, e-learning content www.interwoven.com and commercial software over HTTP including Adobe, tagging, deployment and syn- development and management, supporting those standards ArborText, Corel and dication, connectors to docu- product information management, DeskNet ment management systems, multichannel publishing (Web, print, and transformation from more wireless, PDA), marketing and sales than 150 formats to XML information management Ipedo Inc.
    [Show full text]
  • Drew Hodge 926 Charlton Drive 613-804-8121 Ottawa, Ontario [email protected] K1K 3Z2
    Drew Hodge 926 Charlton Drive 613-804-8121 Ottawa, Ontario [email protected] K1K 3Z2 www.drewhodge.org Profile Technical writer with eighteen years experience working with a wide range of software products, writing API and user documentation, and developing and maintaining document processing tools. Twenty years experience as a biomedical engineering technologist working in medical electronics. Strong communication, problem solving, and analytical skills. Keen student who enjoys learning and taking on new challenges. Computer Skills Programming languages: XSLT, some familiarity with: Java, C, C++, C#, Python, Javascript, and NodeJS Markup languages: XML (familiar with standard XML dialects, DITA, DocbookX), XHTML, HTML5, HTML, LaTeX, and Markdown Operating systems: Apple Mac OS X, Microsoft Windows, Linux Tools: IxiaSoft DITA CMS, oXygen XML Editor, XMetaL, XML Spy, Doc-O-Matic, Frame Maker, several text editors, Eclipse, WebStorm, Camtasia Studio, Microsoft Visual Studio, Microsoft Office, LibreOffice, Saxon, Xalan, FOP, Ant, SVN, Git, and other open source tools Career History Wind River Systems Inc. April 2014 – present Staff Technical Writer/Infrastructure Tools Developer Planning and writing user documentation for Wind River Intelligent Device Platform and Wind River Installer. Configuring, customizing, and maintaining document processing tools to produce a variety of document formats, including PDF and Eclipse HTML, from sets of XML source files. • Writing documentation for developers and end-users in the form of programmer's guides and on-line help to support the company's Internet of Things and custom installer products. • Configuring and maintaining the company's IxiaSoft DITA Content Management System. • Developing custom XSLT transformations to generate DITA XML to convert legacy FrameMaker documentation into DITA XML.
    [Show full text]
  • Analisi Di Editor XML XML Editor Analysis
    Istituto di Teoria e Tecniche per la Documentazione Giuridica ITTIG-CNR Enrico Francesconi Analisi di editor XML XML editor analysis Firenze 2002 Rapporto Tecnico n. 20 Istituto per la Documentazione Giuridica Analisi di editor XML Enrico Francesconi 18/2/2002 In questo documento viene presentata una rassegna dei principali editor XML attualmente disponibili, sia come risorse freeware che come risorse di mercato. Tale rassegna è stata realizzata consultando le documentazioni dei prodotti presenti sul Web. L’analisi ha lo scopo di verificare, per gli editor analizzati, la disponibilità della gestione della struttura di un documento XML tramite le classi e i metodi dell’interfaccia DOM (Standard W3C), attraverso le sue più diffuse implementazioni (C++, Java, VisualBasic, Javascript, VBScript, Delphi). Attualmente in IDG è stato sviluppato, per l’editor XMetal, un software nello standard DOM Javascript che consente la gestione di un documento XML. L’utilizzo di tale standard garantisce la modularità dell’architettura software attualmente sviluppata, in modo tale che la gestione tramite DOM dei documenti XML possa essere riutilizzata nell’ambito di altri editor che supportano tale standard. In questo documento gli editor XML analizzati sono stati suddivisi in tre categorie: 1) Prodotti per i quali viene dichiarato esplicitamente il supporto dell’interfaccia DOM; 2) Prodotti per i quali più genericamente è garantito l’accesso alla struttura di un documento XML tramite API; 3) Prodotti per i quali non vengono esplicitamente dichiarate le due precedenti proprietà. 1 Editor XML che supportano DOM 1 Editor che dichiarano esplicitamente il supporto dell’interfaccia DOM XML Pro Version: 2.0 Developer: Vervet Logic License: Commercial; demo version available Platforms: Windows 95/98/NT, Solaris, Linux.
    [Show full text]
  • Xmetal® XMAX 15.0
    PRO DUC T OVER VIEW NEW FEATURES XMetaL® XMAX 15.0 • XMAX now supports zoom in or out on XML Integrate structured authoring capabilities for deployment across the enterprise content for more comfortable reading. and contributors across the enterprise. Provide technical subject matter experts with a means to provide their valuable input • The XMetaL Forms without requiring them to learn to use another application. Minimize IT spending on desktop applications. XMetaL® XMAX Toolkit has been is an embeddable ActiveX component designed for developers to integrate into custom environments. Use XMAX wherever updated. you need to create a lightweight, easy-to-use XML editor that you can deploy without the IT overhead of desktop installers— • New APIs many global companies rely on thin-client XMAX-based components tightly integrated with dynamic web publishing systems, content management systems, customer relationship management systems, and other critical business applications. • Customer defect repairs Securely Access Content from Across the Enterprise exactly the functionality that your users need with no extra XMAX can be deployed over a network in thin-client complexity, it is the perfect solution for subject matter applications, typically running in an Internet Explorer experts, stakeholders, and other valuable-though-occasional web browser or custom purpose-built application. With contributors to quickly view, revise, and write business or process critical structured content. Making it easier to appropriate security permissions can choose to view or edit review content translates to fewer errors and more up-to- XML content at any time, without needing to install a bulky date information. Allowing developers to create and deliver desktop-based editor.
    [Show full text]
  • Developerworks : XML : XML Matters #6
    developerWorks : XML : XML Matters #6 IBM Home Products Consulting Industries News About IBM Search IBM : developerWorks : XML library XML Matters #6 A roundup of editors David Mertz, Ph.D. Transformer, Gnosis Software, Inc. January 2001 In this column David Mertz gives an up-to-date review of a Contents: half-dozen leading XML editors. He compares the strengths, Working with weaknesses and capabilities of each -- especially for handling marked-up prose text-heavy prose documents. The column addresses the very practical Use a text editor and a question of just how one goes about creating, modifying, and maintaining prose-oriented XML documents. validator Basic enhanced editors Working with marked-up prose Perhaps it is obvious enough that the very first requirement of any approach XML development to working with XML documents is assurance that we are producing valid environments documents in the process. When we use a DTD (or an XML schema), we do Worth mentioning so because we want documents to conform to its rules. Whatever tools are Resources used must assure this validity as part of the creation and maintenance process. About the author Most of the tools and techniques I discuss are also a serviceable means of working with more data-oriented XML documents, but the emphasis in this column is working with marked-up prose. A few main differences stand out between prose-oriented XML and data-oriented XML. Some XML dialects, moreover, fall somewhere between these categories, or outside of them altogether (MathML or vector graphic formats are neither prose nor data in the usual ways).
    [Show full text]
  • Xmetal Author Enterprise Edition for Documentum Webtop
    XMetaL® Express for Documentum® Webtop 6.7 Administrator’s Guide Published by JustSystems Canada, Inc. 1055 - 555 Burrard Street Vancouver, BC V7X 1M8 T 604 602 9928 F 604 602 9938 Document version XMetaL® Express for Documentum Webtop Administrator’s Guide (August 2013) JustSystems Canada, Inc. makes no warranty of any kind with respect to the completeness or accuracy of this document. JustSystems Canada, Inc. may make improvements and/or changes to the product(s) and/or programs described in this document at any time and without notice. This document applies to Version 8.0 or higher of XMetaL Express and Version 6.7 SP2 or higher of the Webtop CMS. Copyrights, Trademarks, Registered Trademarks, and Proprietary Names Copyright © 2004-2013 JustSystems Canada, Inc. and its Licensors. All rights reserved. XMetaL is a trademark of JustSystems Canada, Inc. Other product names mentioned in this document may be trademarks or registered trademarks of hardware, software, or service providers and are used herein for identification purposes only. The contents of this document and the associated Integration software are the property of JustSystems Canada, Inc. and are copyrighted. Any reproduction in whole or in part, except as specifically laid out in this publication, is strictly prohibited. Notice Defence agencies of the United States Government please note: RESTRICTED RIGHTS LEGEND: Use, duplication, or disclosure by the Government is subject to restrictions as set forth in subparagraph (c)(1)(ii) of the Rights in Technical Data and Computer Software clause at 252.227-7013. Civilian agencies of the United States Government please note: RESTRICTED RIGHTS LEGEND: Use, duplication, or disclosure by the Government is subject to restrictions as set forth in subparagraph (a) through (d) of the Computer Software Restricted Rights clause at 252.227-19.
    [Show full text]
  • SDL Livecontent Architect 11.0 Release Notes
    SDL LiveContent Architect 11.0 Release Notes SDL LiveContent Architect 11.0 July 2014 Legal Notices Copyright and trademark information relating to this product release. Copyright © 2011-2014 SDL Group. SDL Group means SDL PLC. and its subsidiaries. All intellectual property rights contained herein are the sole and exclusive rights of SDL Group. All references to SDL or SDL Group shall mean SDL PLC. and/or its subsidiaries details of which can be obtained upon written request. All rights reserved. Unless explicitly stated otherwise, all intellectual property rights including those in copyright in the content of this website and documentation are owned by or controlled for these purposes by SDL Group. Except as otherwise expressly permitted hereunder or in accordance with copyright legislation, the content of this site, and/or the documentation may not be copied, reproduced, republished, downloaded, posted, broadcast or transmitted in any way without the express written permission of SDL. SDL LiveContent is a registered trademark of SDL Group. All other trademarks are the property of their respective owners. The names of other companies and products mentioned herein may be the trademarks of their respective owners. Unless stated to the contrary, no association with any other company or product is intended or should be inferred. This product may include open source or similar third-party software, details of which can be found by clicking the following link: “Acknowledgments ” on page 89 Although SDL Group takes all reasonable measures to provide accurate and comprehensive information about the product, this information is provided as-is and all warranties, conditions or other terms concerning the documentation whether express or implied by statute, common law or otherwise (including those relating to satisfactory quality and fitness for purposes) are excluded to the extent permitted by law.
    [Show full text]