Monday, September 9, 2019

Single Sourcing with MadCap Flare – Part 3 - Placeholders


Another Flare feature that supports single-sourcing is placeholders, which Flare offers in two forms – variables and snippets. Placeholders let you insert the same content in multiple places in a project, such as multiple topics, and automatically change that content everywhere with just a few mouse clicks.

For example (from the introductory post), let’s say that you’re documenting a new product whose pre-release code name is Longhorn. You write the word “Longhorn” in hundreds of places throughout the documentation.

Then, just before release, Marketing changes the product’s name to Vista. You now have to search the documentation for all instances of “Longhorn” and change them to “Vista”. It’s easy – just do a search and replace.

But what if you misspelled “Longhorn” several times? A search and replace won’t fix that. You could do a fragmentary search and replace – search for “Long” – but that would give many false hits. 

Or, let’s say that you have to repeat the same set of steps in multiple topics. Easy – type the steps once, then copy them and insert them in the appropriate topics. But what happens when one of the steps changes? You have to find each insertion and change it. But how do you know where you inserted the material. You might keep track of the insertions but that calls for an unusual level of management. You could again search for the insertions but that might again bring up false hits. Placeholders are a solution in both cases.

Variables

The simplest placeholder is the text-only variable. In the first example, rather than typing the product’s name over and over again, you’d create a variable called, perhaps, productname, and set its definition (its value) as “Longhorn”. You’d then tell Flare to insert the value of the productname variable wherever you wanted the word “Longhorn” to appear in a topic or other file.

Then, when Marketing changes the product name, you’d simply change the value of productname from “Longhorn” to “Vista”. Flare then automatically changes the “wording” everywhere you inserted the variable. You don’t have to keep track of the insertions – Flare does that.

Variables are easy to create and use. What can be tricky is defining them. For example, what do you do if you need to use a variable as a possessive – if you want to say “Longorn’s features include…” Do you create two variables called productname and productname_possessive with values of Longhorn and Longhorn’s, or do you use the single productname variable and type “’s features include…” and insert the productname variable in front of the “’s”? Either approach works; you just have to define which approach to use and get all authors to agree.

Flare stores variables in a file called a VariableSet, with an extension of flvar, accessible from the Project Organizer pane. You can create multiple VariableSet files if you want to categorize multiple variables or simply break multiple variables into smaller groups.

Several points regarding variables:

  • Variables usually have one value but you may need more sometimes for different outputs. For example, you might be generating US and Canadian outputs and have a variable called country. You specify that the value of that variable is US. But if you’re generating Canadian output, you’d want to change the value to Canada. You can override the US value on the Variables tab of the Target Editor but it’s a good idea to minimize the typing needed to specify output settings. The solution is to create the country variable, specify its value as US, but then click the third icon, Add Variable Definition, on the VariableSet Editor toolbar. You’ll see a second instance of the country variable, greyed out, and can now type the additional value, here Canada.
  • How then do you tell Flare what value to use for a particular output target? On the Variables tab of the Target Editor, there’s a dropdown link to the right of any variable that has multiple values. Click that dropdown link and select the desired value.
  • In addition to the standard variables, you can also specify date and time variables. One common use is to add a variable that specifies when the output was generated and that’s automatically updated. Click the second icon, Add DateTime Variable, type the name, such as Generated On, then click in the Definition field. When the Edit Format dialog box opens, type the format – click the I icon for help – then specify when to update the variable.

Snippets

Snippets are similar to variables but more powerful because they can contain anything you’d enter in a topic – text, lists, images, tables, links, formatting, and so on – including variables. In example two above, rather than typing the steps, copying them, and pasting them into the appropriate topics, you’d create a snippet called, for example, task1_steps. You’d then insert the task1_steps into the appropriate topics. When the time came to change one of the steps, you’d change it in the snippet itself. Flare would then automatically change the “wording” everywhere that you inserted the snippet. Again, you don’t have to keep track of the insertions – Flare does.

Each snippet exists in a separate flsnp file that’s accessible from the Resources folder on the Content Explorer. (You can put the snippet files anywhere you want within the project’s structure. I just find it simplest to store them in the Resources folder.)

Several points regarding snippets:

  • You can create text snippets and block snippets. A text snippet consists of one paragraph of text or less. If you insert a text snippet on a new line or in an existing paragraph, it keeps its structure as a line of text. A block snippet consists of two or more paragraphs of text or other element followed by a return, such as a graphic. If you insert a block snippet on a new line, the snippet retains its paragraph structure. However, if you insert a block snippet in an existing paragraph, the block snippet paragraphs become run together.
  • As noted above, a snippet can contain a variable. However, because you can assign conditions to snippets and variables, it’s possible to have a snippet to which you’ve assigned a condition to be excluded for a particular output but that contains a variable to which you’ve assigned a condition to be included for that same output. In such a conflict, Flare will default to an include so it will display the snippet because it contains the variable. The problem here is a management one; you’ll be wondering why that snippet displayed in the output when you thought you’d excluded it. Keep careful track of how your snippets, variables, and conditions interact.
  • If you have numerous snippets and need to modify one, it can be hard to pick out the right one. The shortcut is to find one instance of the snippet, right-click on it, and select Open Link. This immediately opens the correct snippet file, saving you the trouble of hunting for it.
  • Snippets can solve one limitation of variables. What if you want to end a step in a procedure by telling the users to “Press Enter.” You might create a variable called actionstep, for example, whose value is “Press Enter”. But what if you want the action step’s value to be “Press the Enter icon” followed by the actual Enter key icon. A variable is text, so that won’t work. However, you could create a snippet called actionstep that contains both the text and the icon.


As with conditions, common problems with placeholders are in design and management. We often give placeholders names that are not clear. The result? Other authors using the same set of variables or snippets won’t find what they’re looking for and wind up creating duplicates, which complicates project management. A related problem lies in not documenting the rules and logic to use if an author really does need to create a new variable or snippet. As with conditions, when you leave and a new author comes on the project, they may send the project off the rails because the lack of documentation makes it easy to make mistakes.

That’s it for placeholders. Next up – Flare Project Import, one of Flare’s coolest and least-known features.



24 comments:

Yeppar said...

Yeppar leads the global market in the augmented reality print media. We are one stop solution for all the augmented reality visiting and business cards. Visit us today to know more about AR...

Katie Baker said...

Ecogreen IT Recycling offers free IT asset management. We have years of experience in the field of IT equipment disposal.
we are working in different locations in UK.
Secure IT disposals
Laptop recycling UK
IT recycling
we are certified for IT disposal company.

kally martin said...

Are you facing issue with Binance account? The solution to this problem is very simple. You just have to pick your phone and call on our Binance support number and get the best results. Through the recommended helpline number, in numerous tech issues will soon get sorted out, so call up anytime and it will be easier in seeking the services. Just a phone call will Binance Support Number let you overcome all sorts of technical issues, so call up soon and feel ease in using an account. They will provide all the variety of solutions and remedies and even tell you the root0-cause behind it.

jhon karter said...

Are you facing error in your Blockchain account? Is the error big one and you can’t solve it on your own? If that’s the case, you can always talk to the team and avail solutions that are accessible. Just wait for a moment and take out your phone to dial Blockchain support number which is functional all Blockchain Support NUmber the time. The team is always there to support you and helps you in every possible way. Speak to the team to get solutions that are easy to implement and get free from errors.

jhon parkar said...

In order to sort out severe most technical cases, calling at the Gemini Support Number would be the best of all platforms. Be ensured for seeking useful solutions, so chat with us anytime and we will let you overcome severe most technical troubles at its best. There is assurance for reaching the successful consequences when an account is blocked, a password is misplaced, and error messages crop up or when Gemini account password is compromised. You Gemini Support Number have to pay a small amount of cost for the services and that too after seeking the services and then carry out important operations ahead.

Unknown said...

Libra Coin app is available on both the platforms and both iOS and android users can avail this platform for trading. It happens that sometimes Libra Coin wallet app doesn’t work and users get into various issues which are difficult to deal with. You can talk to the experts anytime and get solutions that are easy to execute and the best source where you can easily get Libra Support Number verified and tested solution from the professional in no time. You can talk to the team anytime via Libra Coin support number to get out-of-the-box solutions in a simplified manner.

Dark Web Reviews said...

I have always been very happy to read your article it's very usefull to me and i am completly content with your blog.
Best tutorials for carding. I found on youtube.
How to buy credit card from dark Web? Youtube Video
How to buy credit card from dark Web? Youtube Video
How to buy credit card from dark Web? Youtube Video
How to buy credit card from dark Web? Youtube Video
How to buy credit card from dark Web? Youtube Video
How to buy credit card from dark Web? Youtube Video
How to buy credit card from dark Web? Youtube Video
How to buy credit card from dark Web? Youtube Video
Deep Web Carding- Legit & Scam Vendors Reviews
Deep Web Carding- Legit & Scam Vendors Reviews
Deep Web Carding- Legit & Scam Vendors Reviews
https://youtu.be/QifMULlp6ms
https://youtu.be/d_UodB-lGPw

Unknown said...

It is a fantastic pressuring abridge. My business is somewhat commodious content small the widely used. You place of study course totally fresh utes. Rivalry that will constantly in place. Belittle running a blog. Seeking to assessing the actual wasteful subjected. onsite it support perth

Anonymous said...

Nice overview, but still struggling making variables do more.
You can add a numbered Level1 heading variable into a header / footer, but i am still breaking my head over getting a variable attached to a non-numbered Level1, so the heading will show up without inline numbering in, lets say the header or footer.

jimmyjohns said...

Me and my team was in search of a rarely found platform which can help us for our new assignment. We are writers and its been a long time we are in this writing field. So we would appreciate help of this blog. zona plus

Fixit said...

Hello all
am hacker and service provider
am showing my work to start good business for long term

Available Services

..Bitcoin Trading hacks / profit

..Wire Bank Transfer all over the world

..Western Union Transfer all over the world

..Credit Cards (USA, UK, AUS, CAN, NZ)

..School Grade upgrade / remove Records

..Spamming Tool

..keyloggers / rats

..Social Media recovery

.. Teaching Hacking / spamming / carding (1/2 hours course)

discount for re-seller

Contact: 24/7

fixitrogers@gmail.com

williamoliver172 said...

no person can prevent you writing an amazing blog or article in case you are passionate on your pastime. Your intention is to meet your readers with a nicely written weblog and your passion is continuously in the back of your each successful task. wonderful writing skills may be determined over here. arizer solo 2

Rafi said...

Thanks for sharing the information.

Angelium Blockchain Based Cross Reality Platform

Best Penis Enlargement cream from doctor OLU World Wide said...

Herbal Penis Enlargement product is 100% guarantee to Enlarge and get a better ERECTION ,
the reason why most people are finding it difficult
to enlarge Penis is because they bedlieve on medical
report, drugs and medical treatment which is not
helpful for Penis Enlargement . Natural roots/herbs are the best remedy which can easily Enlarge your Penis permanently
Contact Dr Olu via Email : Drolusolutionhome@gmail.com or via WhatsApp : +2348140654426 for Natural root and herbal remedies put together to help you get Enlarge and Erect healthy.
Thank you.
























Herbal Penis Enlargement product is 100% guarantee to Enlarge and get a better ERECTION ,
the reason why most people are finding it difficult
to enlarge Penis is because they bedlieve on medical
report, drugs and medical treatment which is not
helpful for Penis Enlargement . Natural roots/herbs are the best remedy which can easily Enlarge your Penis permanently
Contact Dr Olu via Email : Drolusolutionhome@gmail.com or via WhatsApp : +2348140654426 for Natural root and herbal remedies put together to help you get Enlarge and Erect healthy.
Thank you.















PrimeItSolution said...

Nice post.Thanks for sharing.
web-development | Website Design Perth | Managed It Services Perth | IT Helpdesk Support | IT Support Services | IT Support Company

PrimeItSolution said...

Nice post.Thanks for sharing.
web-development | Website Design Perth | Managed It Services Perth | IT Helpdesk Support | IT Support Services | IT Support Company

Unknown said...

really very nice post I am very happy to read this great post
rarbg mirror proxy
extratorrent mirror proxy
limetorrents mirror proxy
torrent vpn free

Stella Carlson said...



this is a nice blog, best information in blog, thanks
apple iTunes support number
iTunes service
iTunes service number

Technical Support and Services By Experts said...

Brother Printer Customer Support Number Using getting issues or your Printer is not working properly then no worries about it just call our Brother printer support for Tech Support. They are 24/7 available to help you.
Brother customer Printer phone number
Brother support phone number

Miot Solutions said...

Thanks for sharing such a piece of useful information or any 5G antenna manufacturer you can contact customize wireless manufacturer

Tidak Boleh Kosong said...

1.Agen Casino Live22 Terpercaya – AGENBETTINGASIA
2.Daftar Dan Menangkan Jackpot LIVE22
3.BANDAR BOLA TERBAIK DAN TERPERCAYA
4.CARA AMPUH HACK SLOT ONLINE BERHASIL 100% MENGUNTUNGKAN BESAR – AGENBETTINGASIA
5.Tips Dan Trick Hacking Mesin Judi Online Slot Live22 Menang Trus Dan ANTI-GAGAL – AGENBETTINGASIA
6.BANDAR BOLA TERBAIK DAN TERPERCAYA
7.Cara Menang Main Slot Online Terjitu – AGENBETTINGASIA
8.Cari Duit Gratis Sangat Mudah Dengan Bermain Slot Game Ace333 Di ASIANBET77
9.RAHASIA MENANG JUDI BOLA ONLINE
10.Cara Hack Slot Online Live22 Indonesia – AGENBETTINGASIA
11.Rahasia Selalu Menang Slot Joker Part 1
12.Tips Memilih Agen Slot Live22 Yang Penting Untuk Di Ingat
13.Cara Menang Tips Dan Trick Menang Judi Slot Online Live22 Setiap Hari – AGENBETTINGASIA
14.Cara Gampang Menang Meraih Jackpot Pada Games Slot Online Live22
15.Rahasia Menang Queen Femida Di Slot Live22
16.Situs Resmi Agen Joker123 Terpercaya
17.CARA MENANG SLOT ONLINE
18.CARA MENANG JACKPOT SLOT ONLINE LIVE22 – AGENBETTINGASIA

kindle said...

Laundry Service Near Me are also being available. It is a matter of great joy that you don’t need to go to the shop yourself. In the online laundry service, you will just inform them and then they will pick up your clothes for wash and fold laundry service near me. After the work is done they will deliver your clothes to your own place. You will just have to pay the bill. If you are looking for a delivery launderettes provider near me online you are in the right place. This is the platform that will make your life hassle-free. This providing will save both your time and energy. We also provide at a cheaper rate. So meanwhile it also saves your money.

Ananya said...

covid 19 test in rohini

factored ia said...

Excellent contribution.