Related Topics and File Names

This forum is for all Flare issues not related to any of the other categories.
Post Reply
jdfinn61
Jr. Propeller Head
Posts: 9
Joined: Tue Mar 03, 2015 3:38 pm

Related Topics and File Names

Post by jdfinn61 »

Hi. New to Flare, so I apologize in advance for my ineptness. :o

I've inserted a Related Topics control and selected the items I want users to see. But when I view it, it pulls the File Name and not the TOC name. I use underscores in my file names, so the Related Topics popup shows the underscores, which I don't want. So, this raises another question.....what is best practice for file names. I've always understood (from other Content Management programs) that spaces in a file name are NOT a good idea, so I've gotten into a long-standing habit of always creating file names with underscores.

So, SHOULD I use underscores, and if so, how do I get the Related Topics control to pull from the TOC names (where I've removed the underscores).

TIA

Joanne
MattyQ
Sr. Propeller Head
Posts: 136
Joined: Tue Sep 30, 2014 7:10 am
Location: Roanoke, VA

Re: Related Topics and File Names

Post by MattyQ »

Hi, Joanne,

When you say "view" it, do you mean when you open the Related Topics Control inside of Flare? Or do you mean when you've built the output or previewed the topic?
jdfinn61
Jr. Propeller Head
Posts: 9
Joined: Tue Mar 03, 2015 3:38 pm

Re: Related Topics and File Names

Post by jdfinn61 »

In the built output.
Capture2.png
You do not have the required permissions to view the files attached to this post.
Nita Beck
Senior Propellus Maximus
Posts: 3672
Joined: Thu Feb 02, 2006 9:57 am
Location: Pittsford, NY

Re: Related Topics and File Names

Post by Nita Beck »

You aren't being inept. There is a LOT for the Flare newbie to learn.

When Flare builds a link like this, I'm pretty sure that it's looking first at the destination topic's Title field and then, if the Title is empty, it looks at the first heading in the topic. I don't believe that Flare looks at the TOC entry associated with the topic. It might look like it is but that's because the first heading in the topic and the TOC entry are probably worded identically.

Anyway, in one of your destination topics, open its properties, switch to the Topic Properties tab, and look at the Title field. Anything there? My hunch is that you'll see something, with those underscores. Alternatively, you can view the topic's code. If the Title is set, you'll see it in the <title> tag within the <head> tag, something like this:

Code: Select all

    <head><title>Receiving_Direct_Messages</title>
    </head>
You have two options at this point for getting your links to read without the underscores.
* Edit the title so it doesn't have the underscores, OR
* Clear the title entirely, which means that Flare will use the first heading it encounters in the topic.

My practice is to not use the Title field at all. And if I import legacy content, I'm pretty sure there's an option somewhere with which one can tell Flare NOT to add the titles upon import, which I think is the default.

I hope this helps.

p.s. And I agree with the best practice to not use spaces in filenames.
Nita
Image
RETIRED, but still fond of all the Flare friends I've made. See you around now and then!
jdfinn61
Jr. Propeller Head
Posts: 9
Joined: Tue Mar 03, 2015 3:38 pm

Re: Related Topics and File Names

Post by jdfinn61 »

Thank you Nita.

I looked at the Topic Properties, and it is blank (when you click out of the title field, it shows "(Always use first topic heading)" in gray) - so that looks to be correct. As for looking at code, I'm not very good at deciphering it all, but here's what I have where it lists my first topic heading - not sure what the <a name="_Toc411264028"></a> is, but the topic Heading has no underscores.

</head>
<body>
<h1 class="Heading1"><a name="_Toc411264028"></a>Receiving Direct Messages</h1>


Still a little baffled.....
jdfinn61
Jr. Propeller Head
Posts: 9
Joined: Tue Mar 03, 2015 3:38 pm

Re: Related Topics and File Names

Post by jdfinn61 »

Well, must have been a glitch....I closed Flare, reopened it. Viewed the Generated Output and looked at two places where I have the "See Also" Related topics control. One looked just right, the other had underscores. I deleted the control that didn't look right, recreated the control, did a preview and voila....it is fine.

Thanks.
Nita Beck
Senior Propellus Maximus
Posts: 3672
Joined: Thu Feb 02, 2006 9:57 am
Location: Pittsford, NY

Re: Related Topics and File Names

Post by Nita Beck »

Re the glitch: weird. Can't explain that. But I'm glad it sorted itself out for you. Keep asking questions!
Nita
Image
RETIRED, but still fond of all the Flare friends I've made. See you around now and then!
ChoccieMuffin
Senior Propellus Maximus
Posts: 2650
Joined: Wed Apr 14, 2010 8:01 am
Location: Surrey, UK

Re: Related Topics and File Names

Post by ChoccieMuffin »

Was your stuff originally imported from Word? Those a links with numbers look suspiciously like Word TOC markers.
Started as a newbie with Flare 6.1, now using Flare 2024r2.
Report bugs at http://www.madcapsoftware.com/bugs/submit.aspx.
Request features at https://www.madcapsoftware.com/feedback ... quest.aspx
jdfinn61
Jr. Propeller Head
Posts: 9
Joined: Tue Mar 03, 2015 3:38 pm

Re: Related Topics and File Names

Post by jdfinn61 »

Yes, they were imported from Word. I'm guessing I can remove that then, or does it even matter? Does that affect anything in my output, or anywhere else?

Thanks,
Joanne
ChoccieMuffin
Senior Propellus Maximus
Posts: 2650
Joined: Wed Apr 14, 2010 8:01 am
Location: Surrey, UK

Re: Related Topics and File Names

Post by ChoccieMuffin »

I've found a few in some projects I'm working on and haven't had a problem when I deleted them, but I'd be nervous saying that you're completely ok. I suppose you could do a search in the code for some of the numbers to see if they're actually called from any other topics? (But it should be ok to just delete them.)
Started as a newbie with Flare 6.1, now using Flare 2024r2.
Report bugs at http://www.madcapsoftware.com/bugs/submit.aspx.
Request features at https://www.madcapsoftware.com/feedback ... quest.aspx
wclass
Propellus Maximus
Posts: 1238
Joined: Mon Feb 27, 2006 5:56 am
Location: Melbourne, Australia

Re: Related Topics and File Names

Post by wclass »

Those anchor names/numbers are inserted during import if the original Word document already contained a table of contents - Flare re-uses the Word TOC entries. The anchor points are inserted into the topics, and they are referenced (only) in the TOC that Flare generated during the import.
If you don't use that generated TOC (I usually discard it), then you can happily remove the markers from the topic.
You can also leave them in the topic and they won't affect the output. I usually remove them because I find them annoying when editing in the source topic.

As for file names or titles used in Rel tables, I thought that you saw the file name if you just did a preview, but the title would show up once you have generated a proper build.
Margaret Hassall - Melbourne
Post Reply