AUTOMATIC FOR THE NUMBERS: UNDERSTANDING Presented … · THE 5-STAGE JOURNEY . Stage 1 Stage 2 ....

AUTOMATIC FOR THE

NUMBERS: UNDERSTANDING

AND USING FLARE’S AUTONUMBERING

CAPABILITIES

Presented by: Daniel Ferguson

DANIEL FERGUSON Founder of Smart Output Certified MadCap Flare Consultant

< />

[email protected] @ferg_daniel

linkedin.com/in/DanielSFerguson smartoutput.com

2 Daniel Ferguson | Smart Output | [email protected]


JOIN THE COMMUNITY

madcapsoftware.com/community

THE 5-STAGE JOURNEY

Stage 1 Stage 2 Stage 3 Stage 4 Stage 5

Hey cool! I can autonumber in Flare!

Realization

Hmmm…this might take some time to figure out

Confusion

THESE BLASTED AUTONUMBERS!!! WHY AREN’T THEY WORKING?!?

Anger

Oh GOOD! There is a webinar on Autonumbers. Hey, look, I can BREATHE again!!!

Acceptance

IT WORKS!!! IT WORKS!!! IT WORKS!!!

Exuberance


WHY SHOULD I USE THEM THEN?

Gives your output a professional edge Increases consistency Set it and forget it -- allows you to focus on content Meets documentation requirements in some cases


EXAMPLE: FIGURE CAPTIONS

p.FigureCaption{ mc-auto-number-format: 'CF: {b}Figure {chapnum}-{n+}{/b}: '; }


EXAMPLE: TABLE CAPTIONS p.TableCaption{

mc-auto-number-format: 'T:{b}Table {A+}{/b}: '; }


EXAMPLE: NUMBERED HEADINGS h1{

mc-auto-number-format: 'CH:{chapnum}. '; } h2{ mc-auto-number-format: 'CH:{chapnum}.{n+} '; } h3{ mc-auto-number-format: 'CH:{chapnum}.{n}.{n+} '; }


EXAMPLE: PARAGRAPHS

p.level1{ mc-auto-number-format: 'A:{n+}. '; mc-auto-number-position: outside-head; mc-auto-number-offset: 0.5in; margin-left: 0.5in; } p.level2{ mc-auto-number-format: 'A:{n}.{n+} '; mc-auto-number-position: outside-head; mc-auto-number-offset: 0.5in; margin-left: 1in; } p.level3{ mc-auto-number-format: 'A:{n}.{n}.{n+} '; mc-auto-number-position: outside-head; mc-auto-number-offset: 0.5in; margin-left: 1.5in; }


EXAMPLE: NUMBERED LISTS

p.StepL1_First{ mc-auto-number-class: StepsGreen; mc-auto-number-format: 'N:{n=1}'; mc-auto-number-offset: .25in; mc-auto-number-position: outside-head; mc-next-class: StepL1; } p.StepL1{ mc-auto-number-class: StepsGreen; mc-auto-number-format: 'N:{n+}'; mc-auto-number-offset: .25in; mc-auto-number-position: outside-head; } span.StepsGreen{ background-color: #0A0; border-radius: 30px; color: #fff; font-size: 20px; font-weight: bold; margin-right: 30px; padding: 10px 15px; }


EXAMPLE: GENERATED TEXT

p.Note{ border-bottom: 1px solid #00A4E4; border-top: 1px solid #00A4E4; mc-auto-number-format: '{b}Note{/b}: '; padding: 10px 0px; }


EXAMPLE: OUTLINE

p.OutlineL1{ mc-auto-number-format: '{family Cambria}{size 14pt}{R+}{ =0} {/size}{/family}'; } p.OutlineL2{ margin-left: 0.25in; mc-auto-number-format: '{family Cambria}{size 14pt}{ }{A+}{ =0} {/size}{/family}'; } p.OutlineL3{ margin-left: 0.5in; mc-auto-number-format: '{family Cambria}{size 14pt}{ }{ }{r+} {/size}{/family}'; }


WHERE DO I START?

1. Determine what content you want autonumbered and how you want it numbered (outside of Flare). e.g. Tables, Figures, Paragraphs, Headings, Notes, Lists, etc.

2. Determine what style classes you’ll need to support your autonumbering structure

3. In Flare, create the style classes with the appropriate autonumber style

4. Apply the classes to the content in your topics

5. Create chapter and section breaks as necessary in your TOC


DECIPHERING THE AUTONUMBER SYNTAX 'CF: {b}Figure {chapnum}-{n+}{/b}:

Series Label Specifies different types of autonumber series (like tables, figures, or lists). Can also indicate whether a series applies to a chapter, section, or entire book.

Formatting Determines the look of the autonumbered content. For example, font, font weight, font color, etc.

Counters Indicates what types of numbers should be used and how they should be incremented.

Text Any plain text to include as part of the autonumber


Chapter, Section Volume

Organize your content into chapters, sections, and volumes and apply number sequences to them

UNDERSTANDING SERIES LABELS


Series labels establish independent “lanes” of autonumbers in the same body of content


Table A

Figure 4-2

Table C

Figure 4-4

Problem: p.TableCaption and p.ImageCaption are NOT separated with series labels—they are in the same “lane”

p.TableCaption { mc-auto-number-format: ‘ {b}Table {A+}{/b}: '; } p.ImageCaption { mc-auto-number-format: ‘ {b}Figure {chapnum}-{n+}{/b}: '; }


p.TableCaption { mc-auto-number-format: ‘ T:{b}Table {A+}{/b}: '; } p.ImageCaption { mc-auto-number-format: ‘ F:{b}Figure {chapnum}-{n+}{/b}: '; }

Solution: Add series labels to move them into separate lanes. The actual label value is arbitrary

Table A

Figure 4-1

Table B

Figure 4-2

EXTENDING SERIES LABELS BEYOND TOPICS


Using the C, S, or G series label prefix extends autonumber formats beyond just topics • CH: Specifies a chapter-wide series labeled “H” • SH: Specifies a section-wide series labeled “H” • GH: Specifies a global series labeled “H”

If no series label prefix is used, autonumbering restarts with each topic

QUIZ: SERIES LABELS


p.TableCaption { mc-auto-number-format: ‘ T:{b}Table {A+}{/b}: '; }

p.ImageCaption { mc-auto-number-format: ‘ F:{b}Figure {chapnum}-{n+}{/b}: '; }

Modify Table Captions to be a Global series Modify Image Captions to be a Chapter-wide series

Answer: Answer:

p.TableCaption { mc-auto-number-format: ‘ GT:{b}Table {A+}{/b}: '; }

p.ImageCaption { mc-auto-number-format: ‘ CF:{b}Figure {chapnum}-{n+}{/b}: '; }

UNDERSTANDING COUNTERS


Counters specify what types of numbers should be used and how they should be incremented

HOW COUNTERS ARE CONSTRUCTED


{n+} Display Style Increment Command

HOW COUNTERS ARE CONSTRUCTED


{n+} Display Style n Numeric R Uppercase roman r Lowercase roman A Uppercase alphabetic a Lowercase alphabetic

Don’t display a value

Increment Command {n} Retains current counter value and

displays it

{n=1} Resets the counter value to 1 and displays it. Can use any number

{ =0} Resets the counter value to 0 and does not display. Can use any number

{n+} Increments the counter value and displays it

{ } Retains the current counter value and does not display it

CHAPTERS, SECTIONS, AND VOLUMES


{chapnum} Displays the current chapter number {secnum} Displays the current section number {volnum} Displays the current volume number

Rely chapter breaks or section breaks in the TOC, which you set manually

QUIZ: CHAPTERS AND COUNTERS


Result mc-auto-number-format

'Chapter {chapnum}: ' Chapter 1

'N:Step {A=1} ' 'N:Step {A+} '

Step A Step B

'CF: Figure {chapnum}-{r+}: ' Figure 1-i Figure 1-ii



Result mc-auto-number-format

Figure 1-i Figure 1-ii Where “1” is the chapter number

'CF: Figure {chapnum}-{r+}: '

1. 2. 2.1 2.1.1

'O:{n+}. ‘

'O:{n}.{n+} ' 'O:{n}.{n}.{n+} '

3 separate paragraph classes in the stylesheet



Result mc-autonumber-format

I II A B i ii C III

'{R+}{ =0} '

'{ }{A+}{ =0} '

'{ }{ }{r+} '

3 separate paragraph classes in the stylesheet

The remainder of this presentation is live Flare demonstration.


TAKE ADVANTAGE OF CERTIFIED TRAINING

As a webinar attendee, receive $100 OFF your next advanced training course.

MadCap Flare Single Sourcing July 18-19, 2016 (web-based)

MadCap Flare CSS July 20-21, 2016 (web-based)

For more details, click here or email [email protected]

Note: Courses subject to change. Availability based on student registration. Certain restrictions apply; cannot be combined with any other offer or promotion. Not valid on courses already purchased.

http://www2.madcapsoftware.com/webinar-training-discount/

mailto:[email protected]

www.madworldconference.com

http://www.madworldconference.com/

Date post:	09-Oct-2020
Category:	Documents
Upload:	others
View:	6 times
Download:	0 times

AUTOMATIC FOR THE NUMBERS: UNDERSTANDING Presented … · THE 5-STAGE JOURNEY . Stage 1 Stage 2 ....

Documents