Tuesday, August 27, 2019

Single Sourcing with MadCap Flare – Part 2 - Conditions


In post 1, I said that you can create one source of content and use it for multiple outputs, or select a sub-set of the content for each output. This is one of the foundation concepts of single-sourcing.

Let’s say that you create a sales procedure manual for use in the US and Canada. Some of the material applies only to the US, some applies only to Canada, and some applies to both. You could generate one manual that contains all the material and tell US users to ignore material that applies only to Canada and vice versa. A better solution is to extract the common material and the US material to create the US manual, and the common material and the Canadian material to create the separate Canadian manual.

This capability is driven by conditionality, one of the core features of single-sourcing.

Conditionality

To repeat my initial description from the first post, conditions are essentially categories. To repeat the US/Canada example above – let’s say you have to create a sales procedure manual for use in the US and Canada. Some of the material applies only to the US, some applies only to Canada, and some applies to both.

Conditionality lets you define categories of “US only” and “Canada only”. (Material common to both, or all, categories is always used so it’s not conditionalized.) When you generate the US output, you’d tell Flare to exclude any content categorized as “Canada only”. The output would contain the common material plus the US material but not the Canadian material.

You can apply multiple conditions to material. For example, say that the sales procedure manuals will not only include material specific to the US and the Canada but also slightly different material in the online and print versions. So, to create the online sales manual for the US, after applying appropriate conditions to the appropriate material, you’d tell Flare to exclude any material categorized as “Canada only” and any material categorized as “print only”. The resulting output would contain the common material plus the US material and online material but not the Canadian or print material.

In addition to controlling the behavior of topics, conditions can have wider effects. For example, say that you create a general table of contents that lists topics A, B, and C. The actual topic C is conditionalized as “Canada only”. When you tell Flare to exclude “Canada only” material when generating the US output, it excludes the topic and automatically removes it from the table of contents as well. And if topic A has a hyperlink that points to topic C, Flare automatically turns that hyperlink into regular text in order to avoid a broken link.

Conditions are very flexible. You can apply one or more of them to a topic or multiple topics and to any content within a topic, as finely as a single character. You can also apply them to any other project element – images, master pages, stylesheets, and even to other conditions. (Although I’d have serious reservations about doing that in real project.) This flexibility makes them very powerful but also requires that they be used and managed carefully.

The two problems that I most often see with conditions aren’t technical but rather ones of management and design.

  • The first problem lies in not documenting the logic behind the conditions clearly or at all. When the initial author leaves 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 when applying or invoking conditions.
  • The second problem is the rapid growth of permutations as you add conditions to a project. With one condition, for example, there are only two permutations – include or exclude. With two conditions, however, there are four permutations – include/include, include/exclude, exclude/include, and exclude/exclude. With three conditions, eight permutations. And so on. It’s easy to get confused when to include or exclude multiple conditions in combination. And it’s easy to get confused as to when to apply them at all. The solution ties back to that for the first problem – document the logic behind when to apply conditions in a project and when to include or exclude different conditions in what combinations.

When might you use conditions in a project?

  • Some uses are obvious – If you have to categorize material in a project as applying to the US or Canada, for example. A similar example would be to categorize material as applying to system administrators, professional users, or clerical users. When generating output for clerical users, you’d then exclude material conditionalized as “system administrator only” and “professional users only”.
  • Another use is to document a project for new authors to reference or current authors to get up to speed after being off the project for a while. You can document a project in a separate Word document, for example, but that might get lost. A better approach is to document the project in topics that are part of the project and with authors notes inserted in specific topics. But you don’t want users to see this material, so you create an “author’s notes” condition, apply it to the topics and the in-topic notes, and then exclude that material when generating the output.
  • Another use is to control which topics are made available to the reviewers. You could include all the material in the output and add instructions telling the reviewers to ignore topic 10 because it’s not finished. The problem is that some reviewers may not read the instructions, review topic 10, and give you scathing feedback about how topic 10 isn’t finished. You can avoid this by creating a condition called “not ready for review”, applying it to topic 10, and excluding the “not ready for review” condition on output.

That’s it for conditions. Next up – placeholders (aka variables and snippets).



10 comments:

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

herymeelon said...

It is very fascinating, You are a very professional blogger. Love joined your feed and look ahead to in search of more of your excellent post. computers wangara

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

kally jhon said...

Want to end 2fa error in Gemini account? How to end issues related to 2fa error so that you can secure your account from unwanted activities? Dial Gemini support number and get best-fitted and resilient resolutions from the team of Gemini Support Number customer executives in no time. You can approach the skilled and talented customer executive experts anytime and get solutions and remedies in abundance which is not only accessible but fruitful to utilize.

jhon parkar said...

Sometimes users get into troubles and the most daunting error is unable to receive the money. In order to end up such queries and errors in the least possible time, you can always speak to the team of customer team which is always Gemini Support Number approachable and users can contact them anytime and gets best of the results in no time. Dial Gemini customer support number which is always approachable and is the medium to confront your queries in front of the professionals.

Rafi said...

Thanks for sharing the information.

Angelium Blockchain Based Cross Reality Platform

Anu Verma said...

Such a nice article, this article is so useful. Thanks for sharing with us. Word Find and Replace Batch

Anonymous said...

Thinking of earning something to supplement your income during the COVID-19 Pandemic? Then don’t look any further, just as always. We are proud to do the job here, bringing help to those who needs it.
They sell the following Fresh good Dumps+ pin, Different Countries CVV, Fullz,, SSN DOB, PUA, SBA Loans Fullz, Social Media Profiles Boost, Banks logins, Paypal with G-talk verified, Ebay, Amazon accounts logins, bestbuy, all kinds of shops account available, RDP, Mailers PHP,Best Leads. EMV Software Reader Writer all are available, etc CC Format we selling are:|Card #|Exp. Date|CVV/CVV2|First Name|Last Name|Street|City|State|Zip Code|Country|Phone|Type Of Card|Bank Name|
They are among the best, legit left in the world they gave me my biggest cash out in cc and dumps till date, i advise you to get your tools ready and have a good setup if you want to get success in your transaction
you can reach them on below contacts

Email: jdenterprises@qualityservice.com
gary.jones00222@gmail.com
hark212@hotmail.com
Telegram: @validvendors
icq: chat- 711343039
Your financial stability.

Ananya said...

covid 19 test in north delhi

factored ia said...

Very good contribution to the blog.