You are previewing MadCap Flare for Programmers.
O'Reilly logo
MadCap Flare for Programmers

Book Description

MadCap Flare for Programmers shows how Flare manages and parses content and how you can interact with Flare outside the user interface.

Table of Contents

  1. MadCap Flare for Programmers
    1. eBook Introduction
    2. Foreword
    3. 1. Introduction
      1. 1.1. Audience for this book
        1. 1.1.1. Programmers
        2. 1.1.2. Technical writers
        3. 1.1.3. Managers
      2. 1.2. Purpose of this book
      3. 1.3. Structure of this book
    4. 2. Flare Projects
      1. 2.1. Project files
      2. 2.2. Root folder and explorers
        1. 2.2.1. Content folder
        2. 2.2.2. Project folder
        3. 2.2.3. Analyzer and Output folders
        4. 2.2.4. Conclusion
    5. 3. Flare, Topic-based Authoring, and DITA
      1. 3.1. Topic-based authoring
      2. 3.2. DITA
      3. 3.3. Topic-based authoring in Flare
        1. 3.3.1. Single source / multichannel
        2. 3.3.2. Conditional content
      4. 3.4. Flare and other tools and standards
        1. 3.4.1. Imports and exports
          1. 3.4.1.1. Imports
          2. 3.4.1.2. Exports and targets
        2. 3.4.2. DITA
        3. 3.4.3. Microsoft Word
        4. 3.4.4. FrameMaker
    6. 4. Flare Topics
      1. 4.1. Flare topics overview
        1. 4.1.1. Authoring Flare topics
        2. 4.1.2. Styling Flare topics
      2. 4.2. Topic structure
        1. 4.2.1. Contents of a Flare topic
          1. 4.2.1.1. XHTML element tags
          2. 4.2.1.2. MadCap element tags
          3. 4.2.1.3. Links, cross references, and bookmarks
          4. 4.2.1.4. Snippets
          5. 4.2.1.5. Conditions
          6. 4.2.1.6. Variables
          7. 4.2.1.7. Proxies
      3. 4.3. Topic output
        1. 4.3.1. HTML5 and web outputs
        2. 4.3.2. PDF and print outputs
        3. 4.3.3. XHTML
        4. 4.3.4. DITA
      4. 4.4. Import behavior
      5. 4.5. Manipulating topic files
      6. 4.6. Topic code samples
        1. 4.6.1. Modifying topics programmatically
        2. 4.6.2. XSLT examples
        3. 4.6.3. .NET examples
        4. 4.6.4. JavaScript example
    7. 5. Flare Tables of Contents
      1. 5.1. TOC structure
        1. 5.1.1. Nested TOCs
        2. 5.1.2. Other TOC node types
          1. 5.1.2.1. Browse sequences
          2. 5.1.2.2. Projects and targets
          3. 5.1.2.3. HTML Help
          4. 5.1.2.4. External help
          5. 5.1.2.5. Mimic
        3. 5.1.3. Import behavior for TOC hierarchies
      2. 5.2. Manipulating TOCs
      3. 5.3. TOCs in output
        1. 5.3.1. Export behavior
        2. 5.3.2. HTML5 and web-based output
          1. 5.3.2.1. Exploring the HTML5 TOC data files
        3. 5.3.3. Print output
      4. 5.4. TOC code samples: creating and modifying a TOC
        1. 5.4.1. XSLT example
        2. 5.4.2. .NET examples
        3. 5.4.3. JavaScript example
        4. 5.4.4. Java example
    8. 6. Flare Indexes, Glossaries, and Search
      1. 6.1. Flare indexes
        1. 6.1.1. Index proxies
        2. 6.1.2. Index link sets
        3. 6.1.3. Auto Index Sets
          1. 6.1.3.1. Create an Auto Index Set
      2. 6.2. Flare glossaries
        1. 6.2.1. Glossary proxies
        2. 6.2.2. Glossary files
        3. 6.2.3. Creating and modifying glossaries programmatically
          1. 6.2.3.1. Web output JavaScript example
      3. 6.3. Search
        1. 6.3.1. Customizing search
          1. 6.3.1.1. Programmatic access to search in HTML5 output
            1. 6.3.1.1.1. Search filters
            2. 6.3.1.1.2. Open search results for HTML5 output example
        2. 6.3.2. Batch testing search performance
    9. 7. JavaScript in Flare Topics, Master Pages, Snippets, and Skins
      1. 7.1. Toolbar JavaScript through the Skin Editor
        1. 7.1.1. Connecting a Toolbar function to a button
        2. 7.1.2. Connecting Toolbar functions to other actions
      2. 7.2. Scripts in topics, master pages, and snippets
    10. 8. Document Automation and Batch Files
      1. 8.1. Batch files
      2. 8.2. Creating a manageable template for batch files
      3. 8.3. Automating imports
      4. 8.4. Building subsystems in parallel
      5. 8.5. Batch file generator utility
        1. 8.5.1. Using the utility
    11. 9. Connecting Applications to Flare Help Outputs
      1. 9.1. HTML5 tri-pane help
        1. 9.1.1. HTML5 URL examples
        2. 9.1.2. HTML5 JavaScript helpers
        3. 9.1.3. Java example
        4. 9.1.4. Visual Basic 6
        5. 9.1.5. Visual Basic .NET and C#
        6. 9.1.6. Pascal
        7. 9.1.7. PHP
      2. 9.2. WebHelp
      3. 9.3. CHM and HTML Help
      4. 9.4. DotNet Help
      5. 9.5. Eclipse Help
    12. 10. Flare Application and Flare Plugins
      1. 10.1. Creating a plugin project
        1. 10.1.1. Initialize(IHost host)
        2. 10.1.2. Execute()
        3. 10.1.3. GetAuthor(), GetDescription(), GetName(), GetVersion()
        4. 10.1.4. IsActivated()
        5. 10.1.5. Stop()
      2. 10.2. Building and deploying a plugin
      3. 10.3. Menus
      4. 10.4. Editors
      5. 10.5. Documents
      6. 10.6. Insert element example
    13. 11. Formatting and Pasting Code Samples into Flare
      1. 11.1. Plugin for pasting code samples
    14. 12. Strategies for Combining Generated and Authored Content
      1. 12.1. Strategy: Don’t touch generated content
        1. 12.1.1. Variations
      2. 12.2. Strategy: Generate once and edit freely
      3. 12.3. Strategy: Generate content but only keep the topics
      4. 12.4. Strategy: Generate content as snippets
      5. 12.5. Strategy: Generate topics and snippets
      6. 12.6. Conclusion
    15. Acknowledgments
    16. A. Batch File Generator Utility
    17. B. Element List
    18. C. Glossary
    19. About the Authors
    20. Index
    21. About XML Press
    22. D. Copyright and Legal Notices