“M” is for Manual: Open Source Tools for Documentation

Slides:

Advertisements

Similar presentations

/ 1Online Educa Conference 2008, Berlin Learning Objects and Resources Mega Content Transformation with Open Source Educational Content Project.

Advertisements

DOCUMENT TYPES. Digital Documents Converting documents to an electronic format will preserve those documents, but how would such a process be organized?

 2001 Prentice Hall, Inc. All rights reserved. 1.

Developing Interfaces and Interactivity for DSpace with Manakin Part 5: Introduction to Manakin’s Theme Tier Eric Luhrs Digital Initiatives Librarian,

XSL XSLT and XPath 11-Apr-17.

XML: Managing Data Exchange Stylesheets. Lesson Contents CSS The basic XSL file XSL transforms Templates Sort Numbering Parameters and Variables Datatypes.

XML Unit 6 October 31. XML, review XML is used to markup data Used to describe information Uses tags like HTML –But all tags are user-defined –Must be.

Made by: Dan Ye. Introduction Basic Last Page ☆ HTML stands for Hyper Text Markup Language; ☆ HTML is not a programming language, it is a markup language;

Advanced Technical Writing 2006 Session #3. Today in Class… ► Teams pitch poster concepts:  Meet with your editorial team, show us how your material.

XML: What, Why, When & How? Hope Greenberg Center for Teaching & Learning June 11 & 18.

Copyright © 2003 Pearson Education, Inc. Slide 1-1 Created by Cheryl M. Hughes, Harvard University Extension School — Cambridge, MA The Web Wizard’s Guide.

OASIS document rules Nigel Shaw Eurostep Limited.

Web Content Management Systems. Lecture Contents Web Content Management Systems Non-technical users manage content Workflow management system Different.

15 November 2005Linking Outside the Box1 Cross referencing between XML documents Bob Stayton Sagehill Enterprises

August Chapter 1 - Introduction Learning XML by Erik T. Ray Slides were developed by Jack Davis College of Information Science and Technology Radford.

Luc Audrain Hachette Livre Head of digitalization

METS-Based Cataloging Toolkit for Digital Library Management System Dong, Li Tsinghua University Library

EAD: A Technical Introduction Julie Hardesty, Metadata Analyst June 3, 2014.

Using Wikis. What is a wiki? Hawaiian Word – meaning ‘quick’ A website or a document Real strength lies in its collaborative nature  Multiple people.

Introduction to XML cs3505. References –I got most of this presentation from this site –O’reilly tutorials.

An Introduction to XML Presented by Scott Nemec at the UniForum Chicago meeting on 7/25/2006.

Tutorial 1 Developing a Basic Web Page. New Perspectives on HTML, XHTML, and XML, Comprehensive, 3rd Edition Objectives – Lesson 1 Introduction to the.

Demystifying the eXtensible Markup Language Nick Roberts & Jim Few

Introduction of XML editors Naruki Mtisuda Wakayama Univ.

1 XML: an introduction David Nathan. 2 XML  an in-line markup system  single sequence of plain text only (but can be unicode)  equivalent to a tree.

FIGIS’ML Hands-on training - © FAO/FIGIS An introduction to XML Objectives : –what is XML? –XML and HTML –XML documents structure well-formedness.

Status and way forward with Publishing DICOM in XML Cor Loef Chair ad hoc group on Publishing DICOM in XML.

Short Status Report: Documentation Geant4 Workshop at Noorwijk 4 October, 2010 Dennis Wright (for Katsuya Amako)

Open repositories made accessible through XML transformations Mireia Ribera Turró Universitat de Barcelona DAISY 2009.

DITA Single Source technology. What is Single Source? Single source technology is a concept of publishing documents when same content can be used in different.

IBM Software Group ® Context-Sensitive Help with the DITA Open Toolkit Jeff Antley IBM October 4, 2007.

Chapter 23 - World Wide Web Documents (HTML) Introduction Display Hardware Varies A Browser Translates And Displays A Web Document A Consequence Of The.

Using Wikis. What is a wiki? Hawaiian Word – meaning ‘quick’ A website or a document Real strength lies in its collaborative nature  Multiple people.

XML Steve Fisher/RAL. 20 October 2000XML - Steve Fisher/RAL2 Warning Information may not be all completely up to date.

Advanced Technical Writing 2006 Session #4. Today in Class… ► Meet with your editorial team, refine/post deliverables ► Send URL for deliverables to Bill.

XSLT: How Do We Use It? Nancy Hallberg Nikki Massaro Kauffman.

XML Tools (Chapter 4 of XML Book). What tools are needed for a complete XML application? n Fundamental components n Web infrasructure n XML development.

Advanced Technical Writing 2006 Session #3. Today in Class… ► Show-n-tell your CSS Objects from exercise 1 ► Meet with your editorial team, refine/post.

1 Model Driven Health Tools Design and Implementation of CDA Templates Dave Carlson Contractor to CHIO

XSLT, XML Schema, and XPath Matt McClelland. Introduction XML Schema ▫Defines the content and structure of XML data. XSLT ▫Used to transform XML documents.

1 Introducing Web Developer Tools Rapid application development tools ASP.NET-compatible web editors –Visual Studio.NET Professional Edition –Visual Studio.

© 2009 Multimedia & E-Learning Services, IT Services, University of Zurich Creating, handling and implementing e-learning courses using the open source.

CF Conventions Support at PCMDI Kyle Halliday June 19, 2006 UCRL-PRES-XXXXXX

Fedora Documentation Project Paul W. Frields Volunteer Contributor August 2007.

Beyond HTML: Extensible Markup Language (XML)

Writing Technical Documentation with DocBook and Publican Jared Smith Shakthi Kannan This presentation is licensed under the Creative Commons Attribution-ShareAlike.

Fedora Project Paul W. Frields Red Hat, Inc. Fedora Project Leader This presentation is licensed under a Creative Commons Attribution-ShareAlike (BY-SA)

Fedora: More than Just Another Pretty Linux Paul W. Frields Fedora Project Leader – Red Hat, Inc. This presentation is made available under a Creative.

Utah Open Source Conference Writing Books with Open Source Tools Paul W. Frields Jared Smith.

Software Documentation in an Agile Environment

XML Introduction Bill Jerome.

Unit 4 Representing Web Data: XML

Contributing to documentation

NGUYEN THI THANH NHA HMCL

Core WG Meeting November 16th, 2017.

Fedora Project Paul W. Frields Red Hat, Inc. Fedora Project Leader

Chapter 1 HTML, XHTML, and the World Wide Web

Chapter 7 Representing Web Data: XML

Roy Tennant California Digital Library

Creating a Successful Web Presence

Chapter 1 HTML, XHTML, and the World Wide Web

Chapter 1 HTML, XHTML, and the World Wide Web

XML Data Introduction, Well-formed XML.

Creating Web Page.

Introduction to Problem Solving & Programming using Processing 2

Introduction to Problem Solving & Programming using Processing 2

WEB DESIGNING THROUGH HTML

Wikis Skills (application development): wiki editing and management

Introduction to Problem Solving & Programming using Processing 2

Presentation transcript:

“M” is for Manual: Open Source Tools for Documentation Paul W. Frields Fedora Project Leader – Red Hat, Inc. This presentation is made available under a Creative Commons Attribution-ShareAlike (BY-SA) 3.0 license.

About...

Outline What is DocBook? Best practices Documentation toolkits Publican

What is DocBook?

GEEKSPEAK

XML spec for technical docs

HUMANSPEAK

Markup language for creating books, articles, etc.

Sample DocBook <book> <title>How to write a book</title> <bookinfo> <author> <firstname>Johnny</firstname> <surname>Author</surname> </author> </bookinfo> <chapter> <title>Chapter the First</title> <para>Let's begin with a story! Once upon a time in Portland, there was a great conference...</para> </chapter> </book>

Why DocBook?

Plain text for easy revision control

Human-readable tags

Separates content from presentation

XML transformation: LaTeX, HTML, PDF, *wiki, etc.

Which tags to use

RTFM (kidding!): http://www.docbook.org/tdg/

Use an XML-aware editor

Free XML editors Emacs (with nXML mode) XMLmind Personal edition Vim Syntext Serna Free XMLBuddy for Eclipse

Best practice: XInclude

Remix your book!

Best practice: Entities

OK, I learned DocBook. Now what?

Validate it: xmllint

Transform it: xsltproc

Included stylesheets: HTML XHTML XHTML 1.1 HTML Help Java Help Epub Man pages FO (use FOP►PDF)

Clean it up: xmltidy

Toolchains: Make it simple

Translation: gettext and Transifex

Introducing Publican...

Publican Toolchain for creating and using DocBook Another Red Hat contribution to the open source community Makes it very simple to create HTML and PDF output from your DocBook text Fedora is using Publican for official docs Let's see a demo!

Revision control!

Paul W. Frields pfrields@fedoraproject.org pfrields@redhat.com Questions?