O'Reilly logo

Stay ahead with the world's most comprehensive technology and business learning platform.

With Safari, you learn the way you learn best. Get unlimited access to videos, live online training, learning paths, books, tutorials, and more.

Start Free Trial

No credit card required

HTML to MadCap Flare

Book Description

HTML to MadCap Flare shows you how to import content, including dynamic content, into MadCap Flare effectively and efficientlyy.

Table of Contents

  1. eBook Introduction
  2. Foreword
  3. Preface
    1. 1. Who needs this book?
    2. 2. How is this book organized?
      1. 2.1. Part I: Getting Started
      2. 2.2. Part II: Preparing for Import
      3. 2.3. Part III: Importing HTML
      4. 2.4. Part IV: Scripting
      5. 2.5. Part V: Template Projects with Global Project Linking
      6. 2.6. Appendices
  4. I. Getting Started
    1. 1. Flare and HTML
      1. 1.1. Dynamic documentation
    2. 2. What You Need to Know About Flare
      1. 2.1. Flare project structure
    3. 3. The Tool Kit
      1. 3.1. tidy
      2. 3.2. Pandoc
        1. 3.2.1. Converting to HTML
          1. 3.2.1.1. The default HTML template
      3. 3.3. xmllint
      4. 3.4. Cygwin
      5. 3.5. unix2dos
      6. 3.6. XML editor
      7. 3.7. PHP
      8. 3.8. Browser
    4. 4. CSS and Flare
      1. 4.1. Flare-specific styles
      2. 4.2. CSS and print
        1. 4.2.1. Quirks of print styling
          1. 4.2.1.1. Spaces
          2. 4.2.1.2. Labeling and numbering
          3. 4.2.1.3. Numbering ordered lists
          4. 4.2.1.4. Fonts
  5. II. Preparing for Import
    1. 5. Preprocessing
      1. 5.1. Avoiding class conflict
      2. 5.2. The HTML <title> tag
      3. 5.3. Styling <ol> tags
      4. 5.4. Removing links to resources
      5. 5.5. Adding bookmarks
    2. 6. Tables of Contents
      1. 6.1. The HTML ToC
      2. 6.2. Creating a Flare TOC from an HTML ToC
      3. 6.3. TOCs and System Variables in Flare 2017
        1. 6.3.1. Setting a TOC entry to a system variable
      4. 6.4. Validating your TOC file using xmllint
    3. 7. Glossaries
      1. 7.1. HTML glossaries
      2. 7.2. Creating glossary topics
      3. 7.3. Creating a Flare glossary
      4. 7.4. Creating a glossary for print output
      5. 7.5. Creating <MadCap:glossaryTerm> tags
  6. III. Importing HTML
    1. 8. Importing HTML Files
      1. 8.1. Permanently importing HTML files
        1. 8.1.1. What happened?
          1. 8.1.1.1. The project file
          2. 8.1.1.2. Content files
          3. 8.1.1.3. Changes to HTML files
          4. 8.1.1.4. The Project directory
          5. 8.1.1.5. Permanent import summary
      2. 8.2. Synchronized documentation
    2. 9. After Importing HTML
      1. 9.1. Updating TOC files
        1. 9.1.1. Updating TOC files for synchronized files
      2. 9.2. Glossary files
        1. 9.2.1. Glossary files and skins
      3. 9.3. Resource files
      4. 9.4. Checking links
        1. 9.4.1. Checking and converting links
      5. 9.5. Converting internal links to cross-references
        1. 9.5.1. Styling cross-references
      6. 9.6. Troubleshooting
        1. 9.6.1. Using Project Analysis
          1. 9.6.1.1. Broken links
          2. 9.6.1.2. Broken bookmarks
          3. 9.6.1.3. Topics not in selected TOC
        2. 9.6.2. Building an HTML target
  7. IV. Scripting
    1. 10. Dynamic Content in Flare
      1. 10.1. Including content
        1. 10.1.1. Flare snippets
        2. 10.1.2. Variables
          1. 10.1.2.1. Flare variables
        3. 10.1.3. Using XInclude
      2. 10.2. Other XML objects
        1. 10.2.1. Conditional text
          1. 10.2.1.1. Conditions and TOC files
        2. 10.2.2. Proxies
          1. 10.2.2.1. Mini-TOC
          2. 10.2.2.2. List-Of proxy
        3. 10.2.3. Master pages
          1. 10.2.3.1. Master pages and topics
          2. 10.2.3.2. Master pages and targets
        4. 10.2.4. Togglers and popups
    2. 11. Scripting Tasks
      1. 11.1. Removing empty <p> tags
      2. 11.2. Improving search results
      3. 11.3. Changing comments to annotations
      4. 11.4. Formatting JSON text
      5. 11.5. Setting a maximum line length
      6. 11.6. Automating the build process
      7. 11.7. Pre/Post Build Processes (Flare 2016 r2 and later)
    3. 12. Scripting Creation of Projects
      1. 12.1. Exporting a project
      2. 12.2. Reviewing the exported project
      3. 12.3. Creating PDF targets
      4. 12.4. Creating a document title
      5. 12.5. Creating a new project from a prototype
      6. 12.6. Creating custom documents
  8. V. Template Projects with Global Project Linking
    1. 13. The Flare Solution
      1. 13.1. Terminology
      2. 13.2. Auto-sync
        1. 13.2.1. Linked file naming conventions
      3. 13.3. Creating a source project
        1. 13.3.1. Source projects versus prototype projects
        2. 13.3.2. Selecting content files for a source project
          1. 13.3.2.1. Topic files
          2. 13.3.2.2. Image files
          3. 13.3.2.3. Snippet files
          4. 13.3.2.4. Linked CSS files
          5. 13.3.2.5. Layouts
          6. 13.3.2.6. Summary content table
        3. 13.3.3. Selecting project files for a source project
          1. 13.3.3.1. Conditions
          2. 13.3.3.2. Glossary files
          3. 13.3.3.3. Skins
          4. 13.3.3.4. Targets
          5. 13.3.3.5. Flare TOC files
          6. 13.3.3.6. Linked files and variables
          7. 13.3.3.7. Project files suitable for a source project
    2. 14. Creating the Template
      1. 14.1. Creating an empty project
      2. 14.2. Using the Import Flare Project Wizard
      3. 14.3. Saving as a template
    3. 15. Creating Derived Projects
      1. 15.1. First steps after creating a derived project
        1. 15.1.1. Removing links
        2. 15.1.2. The local.css file
      2. 15.2. Manually updating source files
      3. 15.3. Understanding imported projects
    4. 16. Linking Existing Projects
      1. 16.1. Preparation
      2. 16.2. Excluding files
        1. 16.2.1. Omitting files from the Include Files list
        2. 16.2.2. Adding files to the Exclude Files list
        3. 16.2.3. Excluding files using conditions
        4. 16.2.4. Excluding files by unlinking
        5. 16.2.5. Excluding files by manipulating XML
      3. 16.3. Running the Import Flare Project Wizard
    5. 17. Managing Linked Projects
      1. 17.1. Managing the source project
      2. 17.2. Managing derived projects
        1. 17.2.1. Changing settings in the Project Import Editor
        2. 17.2.2. Managing existing linked files
        3. 17.2.3. Auto-syncing all projects
      3. 17.3. Managing a template project
  9. A. Using Apache Ant with Flare
    1. A.1. Installing Ant
    2. A.2. Using Ant
    3. A.3. Build files
    4. A.4. The Ant properties file (build.properties)
    5. A.5. The Ant build file (build.xml)
    6. A.6. Importing files into build.xml
    7. A.7. Advanced Ant
      1. A.7.1. Using macros
      2. A.7.2. Including files
      3. A.7.3. Applying XSLT
    8. A.8. Targets and pre-build commands
  10. B. Cheat Sheets
  11. C. Glossary Scripts for Flare Version 11
    1. C.1. Creating a Flare Glossary
    2. C.2. Creating a Print Glossary
    3. C.3. Creating <glossaryTerm> Tags
  12. D. Sample Glossary Output File for Print
  13. E. Importing DocBook
    1. E.1. Output format
    2. E.2. The chunking parameters
    3. E.3. ToC parameters
    4. E.4. Labels and numbering
    5. E.5. CSS parameters
    6. E.6. JavaScript parameter
    7. E.7. Tables
    8. E.8. Styling DocBook admonitions
    9. E.9. Glossaries and indexes
    10. E.10. Summary
  14. Glossary
  15. Bibliography
  16. Index
  17. F. Copyright and Legal Notices