Presentation is loading. Please wait.

Presentation is loading. Please wait.

1 Implementing Single Sourcing with XML - Nilanjana Biswas Novell, Bangalore

Similar presentations


Presentation on theme: "1 Implementing Single Sourcing with XML - Nilanjana Biswas Novell, Bangalore"— Presentation transcript:

1 1 Implementing Single Sourcing with XML - Nilanjana Biswas Novell, Bangalore

2 08 Dec 2001STC Conference, Bangalore2 What We’ll Cover 4 What is single sourcing? 4 How does single sourcing help? 4 What is XML? 4 Why XML? 4 Single sourcing with XML 4 Some examples

3 08 Dec 2001STC Conference, Bangalore3 The Problem Company X is launching a new software product that will be deployed on UNIX and Windows. Your job is to create a documentation suite consisting of: 4 online help 4 user manual 4 readme 4 quick start card 4 release notes 4 error messages 4 FAQs

4 08 Dec 2001STC Conference, Bangalore4 Traditional Documentation Scenario ERS User Manual Readme Quick Start Error Messages Release Notes Online Help FAQs Each doc product is an island of information, and needs to be maintained individually.

5 08 Dec 2001STC Conference, Bangalore5 Problems in the Traditional Documentation Scenario 4 Redundancy and repetition of information 4 Maintenance overheads –rework –scope for errors –inconsistencies of style and format 4 No time to improve content and usability 4 Tight integration of format and content leads to a high dependence on tools

6 08 Dec 2001STC Conference, Bangalore6 Single Sourcing Scenario ERS User Manual Readme Quick Start Error Messages Release Notes Online Help FAQs Single Source

7 08 Dec 2001STC Conference, Bangalore7 What Is Single Sourcing? Single sourcing 4 means writing content once and using it many times 4 separates how information “is” from how it “looks” 4 allows you to create and manage information as reusable objects

8 08 Dec 2001STC Conference, Bangalore8 Information as Objects User manual Single source Quick Start

9 08 Dec 2001STC Conference, Bangalore9 How Single Sourcing Helps 4 Eliminates repetitive and redundant information 4 Reduces maintenance errors 4 Increases collaboration through object orientation 4 Increases cost effectiveness by reducing effort on documentation 4 Increases consistency across documents

10 08 Dec 2001STC Conference, Bangalore10 Where does XML fit in?

11 08 Dec 2001STC Conference, Bangalore11 What is XML? eXtensible Markup Language or XML is a data standard that allows you to break up a document into elements and identify the different elements.

12 08 Dec 2001STC Conference, Bangalore12 Why XML? 4 Open source technology –Non-proprietary –Cheap –Versatile 4 Universal data exchange format

13 08 Dec 2001STC Conference, Bangalore13 Some related terms... 4 Styling: a means of displaying XML documents Examples: CSS, XSL, DSSSL 4 Document Type Definition: a collection of elements and the rules governing their relationship (The DocBook DTD is of particular relevance to technical communicators.)

14 08 Dec 2001STC Conference, Bangalore14 Demo 4 Using Jade and DocBook 4 Using XML and XSL

15 08 Dec 2001STC Conference, Bangalore15 Case 1: Using the DocBook with Jade

16 08 Dec 2001STC Conference, Bangalore16 What You Need: 4 Jade: a freely downloadable conversion engine Jade 4 The DocBook DTD: a freely downloadable DTD for technical writing and publishing The DocBook DTD 4 Style sheets: freely downloadable modular style sheets that work with Jade Style sheets 4 An editor: Preferably, an XML editor like Xemacs; otherwise, Notepad will do

17 08 Dec 2001STC Conference, Bangalore17 How to Make It Work: 4 Identify the logical requirements (What are my deliverables?) 4 Identify the physical information requirements (Which parts of the information can I reuse?) 4 Create DocBook-conformant XML files. 4 Use Jade to parse your document to create HTML, RTF or TeX output. 4 Use Jadetex to create PS and PDF files.

18 08 Dec 2001STC Conference, Bangalore18 Case 2: Use XML with XSL

19 08 Dec 2001STC Conference, Bangalore19 What You Need: 4 A text editor (like Notepad) 4 An XML processor (like Xalan or Cocoon)

20 08 Dec 2001STC Conference, Bangalore20 How to Make It Work: 4 Identify the logical information requirements (What are my deliverables?) 4 Identify the physical information requirements (Which parts of the information can I reuse?) 4 Create your XML files. 4 Create style sheets corresponding to each deliverable type. 4 Generate output using an XML processor.

21 08 Dec 2001STC Conference, Bangalore21 Resources Useful Links on XML/XSL Books on XML/XSL 4 Goldfarb, CF and Prescod P (1999): “The XML Handbook”. Prentice Hall, NJ. 4 Elliotte RH (1999):”XML Bible”. IDG Books. India 4 Doug, T (2001): “XSLT”. O’Reilly & Associates.

22 08 Dec 2001STC Conference, Bangalore22 Resources DocBook 4 Jade 4 DSSSL 4 Other XML Editors/Processors

23 08 Dec 2001STC Conference, Bangalore23 Thank you!


Download ppt "1 Implementing Single Sourcing with XML - Nilanjana Biswas Novell, Bangalore"

Similar presentations


Ads by Google