13
PRESENTED BY Top Five Content Reuse Features in MadCap Flare Paul Pehrson @docguy | www.docguy.training Track 1: Newbie

Top Five Content Reuse (Single Sourcing) Features in MadCap Flare

  • Upload
    docguy

  • View
    392

  • Download
    1

Embed Size (px)

Citation preview

Page 1: Top Five Content Reuse (Single Sourcing) Features in MadCap Flare

PRESENTED BY

Top Five Content Reuse Featuresin MadCap Flare

Paul Pehrson@docguy | www.docguy.training

Track 1: Newbie

Page 2: Top Five Content Reuse (Single Sourcing) Features in MadCap Flare

About Me• (Ab)using Flare for 10

years• Full time technical writer

at Venafi• Part time Flare consultant

and trainer at DocGuy Training

Page 3: Top Five Content Reuse (Single Sourcing) Features in MadCap Flare

Content Reuse? Single-Sourcing?• Single source content, used in multiple places in your

project– Images– Content chunks (snippets)– Variables

• Multi-channel publishing– Online vs. PDF– Different audiences

Page 4: Top Five Content Reuse (Single Sourcing) Features in MadCap Flare

How does Flare help me single source?• Variables• Snippets• Conditions• Snippet Conditions• Nested TOCs• Target Conditions

Page 5: Top Five Content Reuse (Single Sourcing) Features in MadCap Flare

Variables• Strings of unformatted text• Variable formats

– Plain text– Multi-select– Date/Time

Page 6: Top Five Content Reuse (Single Sourcing) Features in MadCap Flare

Snippets• Chunks of formatted content• Small as a word• Large as an entire topic• Ways to use

– Single sourcing– Boilerplate content

Page 7: Top Five Content Reuse (Single Sourcing) Features in MadCap Flare

Conditions• Customize content for

– Output Format– Deliverables

• Apply condition to:– Character, word, phrase, sentence (span conditions)– Paragraph, multi-paragraph, div (element conditions)– Topic, folder (Content Explorer)– TOC node– Glossary terms (Flare 12)

Page 8: Top Five Content Reuse (Single Sourcing) Features in MadCap Flare

Snippet Conditions• Special type of snippet where condition applies at the

snippet level instead of the project level• Not audience- or deliverable-based• Topic destination-based• Apply condition at topic level (Flare 11 or 12)• Apply condition at snippet-level (Flare 12 only)• Special use of variables in snippets (Flare 12 only)

Page 9: Top Five Content Reuse (Single Sourcing) Features in MadCap Flare

Nested TOCs• Insert TOCs in other TOCs to prevent duplication of

content• Especially useful for multiple writers in a project

Page 10: Top Five Content Reuse (Single Sourcing) Features in MadCap Flare

Target Conditions and Variables• How to set condition and variable settings in the target

Page 11: Top Five Content Reuse (Single Sourcing) Features in MadCap Flare

Best Practices• Tie conditions to a deliverable

– Admin guide vs. Standard Guide (only need 1 condition)– Admin guide vs. Installation Guide vs. Standard guide (maybe need 2 or

3 conditions)• Have strategy for creating and using conditions• Minimize number of condition tag sets, variable sets• Create separate variable and condition sets for snippet-level

conditions and variables• Create boiler-plate snippets for an easy starting point

Page 12: Top Five Content Reuse (Single Sourcing) Features in MadCap Flare

Q&A

Page 13: Top Five Content Reuse (Single Sourcing) Features in MadCap Flare

Thank You!

Visit my website for more information on consulting and training opportunities

www.docguy.training