1 / 48

SAIF DITA Training

SAIF DITA Training. Fall 2010. Part I – Introduction to DITA. Objectives Learn about DITA Set up your DITA environment Become familiar with the oXygen interface. Part 1.1 – Learn about DITA. What is DITA? Benefits of using DITA Challenges of using DITA SAIF DITA strategy and goals.

hallie
Download Presentation

SAIF DITA Training

An Image/Link below is provided (as is) to download presentation Download Policy: Content on the Website is provided to you AS IS for your information and personal use and may not be sold / licensed / shared on other websites without getting consent from its author. Content is provided to you AS IS for your information and personal use only. Download presentation by click this link. While downloading, if for some reason you are not able to download a presentation, the publisher may have deleted the file from their server. During download, if you can't get a presentation, the file might be deleted by the publisher.

E N D

Presentation Transcript

  1. SAIF DITA Training Fall 2010

  2. Part I – Introduction to DITA Objectives • Learn about DITA • Set up your DITA environment • Become familiar with the oXygen interface

  3. Part 1.1 – Learn about DITA • What is DITA? • Benefits of using DITA • Challenges of using DITA • SAIF DITA strategy and goals

  4. DITA overview • DITA is an XML-based architecture for creating topic-oriented, information-typed content that can be reused and single-sourced in a variety of ways. • DITA is an extensible architecture that allows creating new information types and specialized elements.

  5. Benefits of using DITA • Topic-based authoring

  6. Benefits of using DITA • Topic-based authoring • Consistent look and feel

  7. Benefits of using DITA • Topic-based authoring • Consistent look and feel • Publishable in many output formats

  8. Benefits of using DITA • Topic-based authoring • Consistent look and feel • Publishable in many output formats • Easy to restructure table of contents

  9. Benefits of using DITA • Topic-based authoring • Consistent look and feel • Publishable in many output formats • Easy to restructure table of contents • Content reuse

  10. Benefits of using DITA • Topic-based authoring • Consistent look and feel • Publishable in many output formats • Easy to restructure table of contents • Content reuse • Interoperability and portability

  11. Benefits of using DITA • Topic-based authoring • Consistent look and feel • Publishable in many output formats • Easy to restructure table of contents • Content reuse • Interoperability and portability • Customizable (filtering of information)

  12. Challenges to using DITA • Moving from Word to DITA

  13. Challenges to using DITA • Moving from Word to DITA • Learning curve

  14. Challenges to using DITA • Moving from Word to DITA • Learning curve • Challenge of converting legacy docs

  15. Challenges to using DITA • Moving from Word to DITA • Learning curve • Challenge of converting legacy docs • Easy to create output but difficult to customize w/o scripting knowledge

  16. Challenges to using DITA • Moving from Word to DITA • Learning curve • Challenge of converting legacy docs • Easy to create output but difficult to customize w/o scripting knowledge • Handling images in different output formats

  17. Challenges to using DITA • Moving from Word to DITA • Learning curve • Challenge of converting legacy docs • Easy to create output but difficult to customize w/o scripting knowledge • Handling images in different output formats • Deciding which DITA template to use for specific material

  18. SAIF Documentation – Paper based

  19. SAIF Documentation – DITA based

  20. Short-term goals of the SAIF DITA project • Convert the SAIF documents from Word to DITA. • Compile a SAIF “book” using DITA. • Publish the book to the HL7.org web site.

  21. Long-term SAIF DITA strategy • Set up a common, shared infrastructure for future maintenance of the SAIF material. • Make the SAIF DITA document available to other HL7 work groups and organizations working on related projects.   • If the SAIF DITA project is successful, HL7 will be more likely to use DITA for other projects.

  22. Part 1.2 - Components of a DITA project • Ditamap files • DITA topic files • Graphics files

  23. Ditamaps • A ditamap organizes the topics in a DITA document. • A ditamap can include other ditamaps. • You can specify a relationship table of links in a ditamap file.

  24. SAIF master ditamap Sub-ditamaps within the master ditamap

  25. SAIF introduction ditamap

  26. Ditamap templates

  27. What is a DITA topic? • A topic is a discrete piece of content that is about a specific subject, has an identifiable purpose, and can stand alone. • Each DITA topic is normally in its own file. • A large DITA project can have hundreds of topic files.

  28. DITA topic templates (1) • DITA provides templates for different types of topics. • The SAIF book uses the following topic types: • Concept • Reference • Generic topic • Glossterm

  29. DITA topic templates (2)

  30. DITA topic templates (3) • If you are writing a training document, DITA provides 4 learning topic types: • Learning assessment • Learning content • Learning overview • Learning summary

  31. DITA examples • The next few slides show examples of the different types of DITA topics.

  32. SAIF concept topic example

  33. SAIF reference topic example

  34. Task topic example

  35. SAIF glossterm topic example

  36. Part 1.3 – Setting up your DITA environment

  37. Set up your DITA environment • Install and configure oXygen. • Set up your source file directories. • Ensure that you have permissions to SVN for http://gforge.hl7.org/svn/saeaf/trunk/docs/saeaf-dita/. • Learn the oXygen interface and menu commands.

  38. Installing and configuring oXygen • Download & install oXygen from http://www.oxygenxml.com/download_oxygenxml_editor.html. • See Wilfred Bonney for the license key. • The oXygen license is name based, so you can install it on as many computers as you use.

  39. Set up your source file directories • Check out the DITA source files from http://gforge.hl7.org/svn/saeaf/trunk/docs/saeaf-dita/saif-dita-source-files/. • Copy these files to another location on your computer. • When you are finished updating your DITA files, validate the SAIF ditamap. • Copy the files back to the checked out SVN directories. • Commit these files at least weekly. • Create an output directory for storing DITA output. • Back up the DITA files stored on your computer. • Coordinate work with others who might be working on DITA files from the same SVN directory to avoid overwriting each other’s changes.

  40. Transferring the oXygen license • To remove the oXygen license, delete the license.xml file from the home folder on your computer. • It is not necessary to uninstall the oXygen application if you want to preserve it until you need it again. When needed again, you can start oXygen and re-enter the license key. Windows 7 -C:\Users\(Admin)\AppData\Roaming\com.oxygenxml\license.xml

  41. The oXygen interface

  42. Author view (main window) • Shows the DITA topic that you are editing or writing

  43. Grid view • Displays grid structure (useful for working with tables and databases)

  44. Text view • Displays the source XML code

  45. Outline view • Shows the DITA tags and displays the structure of a DITA document

  46. Displaying DITA tags • Full tags with attributes <fig id="bf_transactions" frame="topbot"> • Tags <fig> (shows all tags w/o attributes) • Block tags <fig> (paragraph level) • Inline tags (text level) • Partial tags (triangles show styled text) • No tags (looks like Word)

  47. Demo #1 • Take a tour of the DITA functions in oXygen

  48. Part I Summary You have: • Learned about DITA • Set up your DITA environment • Become familiar with the oXygen interface

More Related