Writer Comments

This forum is for all Flare issues not related to any of the other categories.
Post Reply
ibmgeek
Propeller Head
Posts: 22
Joined: Tue Aug 28, 2012 8:21 am

Writer Comments

Post by ibmgeek »

What's the best way to insert and manage writer comments within Flare content files? I'm referring to the helpful text about the changes we as writers are making to the files (when and why I made the change, for example). Visible in the XML Editor as well (but not in the published versions).

Thanks!
sarrants
Propeller Head
Posts: 86
Joined: Tue Sep 18, 2007 6:04 am
Location: South Burlington, VT

Re: Writer Comments

Post by sarrants »

Adding these comments as Annotations would work. Annotations would give you the edit date and creator as well.
You might instead consider using a Style for Comments as well as a Condition. Both suggestions would be visible in the XML editor.
The things that we plan and measure are the things that get done.
ChoccieMuffin
Senior Propellus Maximus
Posts: 2650
Joined: Wed Apr 14, 2010 8:01 am
Location: Surrey, UK

Re: Writer Comments

Post by ChoccieMuffin »

I have two conditions that I use - Question and Comment. I also have two styles in the stylesheet (so I can easily identify them in my document).

I only need the comments to show up in the Flare interface, I never need to see them in my output. So ALL my targets exclude the Comment condition.
On the other hand, I sometimes want my questions to appear in the output, as these are typically notes to reviewers or SMEs (or myself, like "THIS TOPIC NEEDS TO BE RE-WRITTEN"), so I don't exclude the Question condition from my targets.

Hope that helps.
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
Post Reply