How do I create a cross-reference to a numbered step?

This forum is for all Flare related Tips and Tricks.
Have a tip or trick you use while working in Flare? Share it here.

How do I create a cross-reference to a numbered step?

Postby Patt on Fri Apr 11, 2008 10:41 am

I'm new to Flare and still learning my way around. Here's my question of the day. I have a numbered list and I want one of the steps to be "Repeat steps x - y", where x and y refer to previous steps in the procedure. I want to make x and y a cross-reference to the numbered steps so that when I change the procedure, as I've just done, the right numbers are displayed.

Thanks
Patt
Propeller Head
 
Posts: 40
Joined: Thu Apr 03, 2008 7:43 am

Re: How do I create a cross-reference to a numbered step?

Postby forfear on Fri Apr 11, 2008 6:46 pm

You can only do this to paragraphs and headings with auto-numbers in the styles defined.

Repeat x to z.

Numbered steps are a type of special list. They are not paragraphs.
The numbers in list items will not show as you want them to.

Currently there is no option to display the numbers only in numbered steps in List types. You can do it i.e. if your headings are auto-numbered. 1.0 Heading 1, 1.1 Heading 2.

To create cross-reference to numbered steps (option)
Create a new paragraph style i.e MyNumberedSteps
With Auto-Numbers, set each new instance of a step to auto-increase in number, like 'S:{n+}. '
Bookmark the two steps you want cross-referenced. (Insert Bookmark, i.e. Start and End)
Now create a new Cross-Reference Style, called ShowAutoNumbersOnly
For this cross-reference format, set the format to {paranumonly}.
Now insert the sentence

Repeat x and y.

Replace x and y with cross-references to the Start and End bookmarks.

Done.
If you submit your bug feedback request here, the more likely it'll get fixed or included in a future release
Open Utilities PageLayout Resizer for Flare/Blaze | Batch builder
forfear
Propellus Maximus
 
Posts: 766
Joined: Sat Feb 16, 2008 3:37 am
Location: Jungle Jingles

How do I create a cross-reference to a numbered step?

Postby RamBal on Mon Jul 29, 2013 3:00 am

The following workaround configures the list [li] tags and any style changes to the list are propogated to all list items.

This is a test topic for demonstrating numbered list with cross-reference functionality.
1.After you start this list, open Paragraph Properties dialog (click the paragraph extension icon [\] on the ribbon).
2.Test extra line added above first cross-referred step. (add this line after first implementation of the following procedure).
3. In Enter format (preview below), type {color white}{ }{n+}{/color}. Click OK.
4.Test extra line added between two cross-referred steps.
5.To create a new line, press ENTER key.
6.The cursor position for your first character input will appear misaligned by a single character position.
7.Ignore this misalignment and enter your input for the next line.
8.To create as many line items as required, repeat step 5 to 7 as required.
9.When your required number of lines are created, position the cursor on step 5 and click Insert > Bookmark.
10.In Manage Bookmarks dialog, under New bookmark (do not use spaces), type your bookmark name. Click Add.
11.Repeat steps 9 to 10 on step 7.
12.Click (Insert a Cross-Reference) icon.
13.In the Insert Cross-Reference dialog, under Cross-Reference Properties and XRef Class, select MadCap:xref.
14.Click New.
15.In the New Cross-Reference Style Class dialog, and in XRef Class, type StepXRef as your new style format.
16.In Available commands, select Show Paragraphs Commands.
17.Under Command column, select Paranumonly. Click OK.
18.Apply the newly created cross-reference style format to each bookmark.
19.When you insert an additional line item between step 5 and 7, the cross-referenced step number(s) is updated.
RamBal
Jr. Propeller Head
 
Posts: 1
Joined: Mon Jul 29, 2013 2:30 am

Re: How do I create a cross-reference to a numbered step?

Postby berniexmeyer on Tue Apr 22, 2014 2:07 pm

This seems like a feature almost everybody would want at some time or other. The first query was in 2008. So Madcap has had 6 years to think about this. Is it slated to be implemented at some point? Having to create a special paragraph type to pull this off seems unreasonably klugy. Madcap, comments?
berniexmeyer
Propeller Head
 
Posts: 34
Joined: Thu Dec 23, 2010 3:09 pm
Location: Oregon, USA

Re: How do I create a cross-reference to a numbered step?

Postby Nita Beck on Tue Apr 22, 2014 2:58 pm

The best way to urge MadCap is to put in a feature request. The more people who request the same feature, the more likely MadCap is to act. Otherwise, telling your peers here just yields a lot of nodding heads!

You can submit a feature request here: https://www.madcapsoftware.com/feedback/featurerequest.aspx
Nita
Image
Content Strategist / Information Architect / Flare Consultant: http://beck-communications.com
Manager, Rochester Flare User Group: http://www.facebook.com/RochesterFlareUserGroup
Nita Beck
Senior Propellus Maximus
 
Posts: 2730
Joined: Thu Feb 02, 2006 9:57 am
Location: Pittsford, NY

Re: How do I create a cross-reference to a numbered step?

Postby berniexmeyer on Tue Apr 22, 2014 3:10 pm

Good suggestion, thanks for the link. I dood it!
berniexmeyer
Propeller Head
 
Posts: 34
Joined: Thu Dec 23, 2010 3:09 pm
Location: Oregon, USA

Re: How do I create a cross-reference to a numbered step?

Postby ChoccieMuffin on Wed Apr 23, 2014 1:27 am

Added another request. This is a real nuisance, particularly as ALL the other authoring programs I've played with - even Word - allow this really easily.
Started as a newbie with Flare 6.1, now using Flare 2017.
Report bugs at http://www.madcapsoftware.com/bugs/submit.aspx.
Request features at https://www.madcapsoftware.com/feedback ... quest.aspx
ChoccieMuffin
Propellus Maximus
 
Posts: 1428
Joined: Wed Apr 14, 2010 8:01 am

Re: How do I create a cross-reference to a numbered step?

Postby LTinker68 on Fri Apr 25, 2014 8:55 am

ChoccieMuffin wrote:Added another request. This is a real nuisance, particularly as ALL the other authoring programs I've played with - even Word - allow this really easily.

The problem is, they're not really analogous. When you use an HTML list, the numbers are not added into the content at all. If you build the output and look at the page code, you still only see <li> tags -- you don't see 1, 2, 3, etc. It's the browser that determines at run time what the value of each <li> is. In order to xref to a specific number, the browser would first have to render the page to determine the resulting list numbers, then re-render the page to fill in the xref with the values that were determined in the first pass. Browsers aren't programmed to do that, so in order to do what you want, Flare would have to add functionality to build a new auto-number sequence at build time, change the HTML list structure (ol and li tags) to paragraphs using that auto-number format, then convert the xref tags to point to the appropriate resulting paragraph item. The above would result in in-page style definitions being created for the auto-number formats and possibly the xref tags, which would bloat the topic code, and those in-page style definitions would override your stylesheet definitions because you'd no longer be using ol/li tags but in-page defined <p> styles. How many people have had problems styling their lists because in order to make a hanging outdent (?) list, Flare has to use a table structure to simulate that effect and people didn't know they had to style the table tags in order to control the look in the output?

If you know you're going to want to xref to a numbered item in a list, then start with the auto-numbered paragraph instead of an HTML list. Once you get the auto-number format set up in the stylesheet, it's just as easy to use that as to use the HTML list, plus you can xref to it. (Well, not quite as easy -- if you want to simulate a list-within-a-list then you have to select a different paragraph class for the first indented item then select the original class when you want to outdent, but that's still not that labor-intensive.)
Image

Lisa
Eagles may soar, but weasels aren't sucked into jet engines.
Warning! Loose nut behind the keyboard.
LTinker68
Master Propellus Maximus
 
Posts: 7234
Joined: Thu Feb 16, 2006 9:38 pm

Re: How do I create a cross-reference to a numbered step?

Postby Dmuir on Fri Nov 20, 2015 11:26 am

LTinker68 wrote:In order to xref to a specific number, the browser would first have to render the page to determine the resulting list numbers, then re-render the page to fill in the xref with the values that were determined in the first pass. Browsers aren't programmed to do that, so in order to do what you want, Flare would have to add functionality to build a new auto-number sequence at build time, change the HTML list structure (ol and li tags) to paragraphs using that auto-number format, then convert the xref tags to point to the appropriate resulting paragraph item.


I disagree with the way you engineered your solution and the reasons why step numbers cannot be supported.

Yes, step numbers are rendered by the browser but they are based on the <li> count and the nesting, which is something that Flare could figure out at build time to to apply the cross references. You would not have to wait for the browser nor would you have to convert anything back to a paragraph.

I am glad someone opened a feature request for this, and I hope the Flare developers implement this idea in a relatively straightforward manner. By the way, cross-referencing often requires multiple passes anyway to adjust for conditional content and shifting page numbers.
David Muir | Technical Writer | Microdea Inc. | Markham ON | Canada
Dmuir
Propeller Head
 
Posts: 10
Joined: Fri Sep 04, 2015 9:01 am

Re: How do I create a cross-reference to a numbered step?

Postby bianca_writer on Mon Aug 08, 2016 5:49 pm

I also submitted a feature request for the ability to cross-reference steps, as in:

1. Do this. If this isn't applicable to you, go straight to "Step 3".
2. Do this.
3. Do this.

MadCap has found creative ways to implement features, so I trust that they can figure out a way to do this! :)
bianca_writer
Propeller Head
 
Posts: 38
Joined: Tue Mar 15, 2016 9:57 am
Location: Irvine, CA

Re: How do I create a cross-reference to a numbered step?

Postby rillettes on Tue Sep 20, 2016 7:58 am

Hi all, long time listener, first time caller.

I was dealing with this this morning, and instead of doing any style modification or autonumbering, I went to the step I want to reference. Find the pertinent keyword for that step, i.e. Configure Azure. Create a bookmark for that step, eg. conf_azur. Then, for the cross-reference, I wrote something similar to "As noted in the Configuring Azure step, ...."
Works for me.
rillettes
Jr. Propeller Head
 
Posts: 1
Joined: Mon May 30, 2016 12:27 pm

Re: How do I create a cross-reference to a numbered step?

Postby Wendy F on Wed May 17, 2017 9:25 am

Added a feature request....I'm really surprised this is not possible.
Wendy F
Propeller Head
 
Posts: 13
Joined: Thu Sep 10, 2015 5:24 am


Return to Tips and Tricks

Who is online

Users browsing this forum: No registered users and 1 guest