When should you not use the ‘print’ medium for printed manuals and other printed deliverables (edited)

Posted on June 4, 2009

5


This post has been edited. Much of the original text of this post is no longer valid.

From the comments and a post on the forums, it looks like this is no longer applicable. I ran a test this morning after seeing a comment by Eddie, a well skilled Certified MadCap Flare trainer, and the text of this original post is in fact, inaccurate. Eddie is right, my post is wrong. This is where the post is fundamentally inaccurate – to avoid using print mediums simply because it will create blank topics where all H1s occur. Attempt it, and nothing of that sort mentioned in the post about page breaks occur.

A little explanation is in order

When I made a decision to use a new print medium, much more than a year ago, with Flare v3, it was apparent then, from our testing, that a separate medium was always required to avoid page-breaks being inserted into topics when printed from the browser. I can still recall it very clearly. Getting feedback from users and running it myself as I attempted to print topics from Webhelp or CHM targets, always seeing print pages starting with one blank page first, usually with the breadcrumb proxy on its own page. Unfortunately, this is no longer reproducible. Not in Flare v4, I suspect, not in Flare v5 as well.

It was a heavily modified stylesheet that was reused from migrated legacy RoboHelp projects, into Flare v3, although in all honesty, I doubt that may have been the real reason. Months later, we rebuilt and cleaned the old stylesheet, replaced everything in ‘print’ in a medium called printOnly… mystery page breaks solved – then Flare 4 arrived…and Capture v4..which led to the seeds of this post, written more than a week ago (its a scheduled blog post). I think a few posts in the forums on an almost similar issue in the last few weeks started the germ of an article idea as well.

I guess a little redaction is in order, no?

I’ll keep the content of the original post, so you can see for yourself the inaccuracies laid bare. However, a discussion about considering multiple stylesheets and not use the print mediums for printed outputs might still be in order.

IMHO, I like to keep the stylesheet as clean as possible, that’s from experience, the less mediums I have to use the better, which is I think is the most popular, conventional thinking on the matter.

All the same, as time passes, and the more a stylesheet you create gets reused in your different projects,  temptation to constantly overwrite your original master stylesheet will always be there, be it with Flare/Blaze’s Global Project Linking (or the more nifty, GPL acronym) enabled or not. Its not a tool issue. Its a user issue.

So why should you use the print medium?

You actually have more advantages to using the print medium than not in most cases. Here are some.
When you want:

  • The convenience of switching to Print Layout view, and the medium switches immediately from (default) to print every time. You get to see it as it would be printed…always.
  • When you want to take advantage of MadCap Capture’s image single-sourcing capabilities. You can create separate image rendering properties for all screenshots in print targets. No…You can’t do this with SnagIt. It lets you specify completely separate DPI and colour settings just for print outputs. Nice!

As the good Dr. House would probably do, for now, I’ve got a mystery to solve and no body to prove it.

How did those print page-breaks occur only in CHM and Webhelp?

If you do this, there is a high likelihood that when your readers decide to print a topic from an online target that you created in WebHelp or CHM, they will end up printing an empty page followed by the actual topic content.  The empty page break is caused due to the use of page-break-before for the heading1(h1) when styling within the ‘print’ medium for print outputs.

So when an online topic, when printed from a browser, consistently starts with an empty page, it really is an avoidable  waste of paper and a minor usability annoyance.

Solution – the page-break free version

Specify all your book/print styling information in an alternative user defined medium such as ‘printOnly’ or ‘bookOnly’, as long as it is not ‘print’. Reserve the print medium to fine tune topics printed from a browser.

How empty pages are created

The CSS ‘print’ medium is used by all web browsers to style an online page for print when you click Print.

To try this, in ‘print’ medium, set a new body font. In your online targets(CHM/WebHelp) click Print from the web browser’s toolbar. When the page is printed (or with Print Preview) your new fonts are applied. Similarly for the case of page breaks.

If you are single-sourcing your online projects to print as well, it is most likely that you, with most Flare authors, use a heading 1 (h1) with a page-break-before attribute enabled so that page breaks occur in all the right places.

Since most topics in online help will start with a heading 1(h1), the page break from h1, will be applied by the browser.

So what looks perfectly alright for printed books, but when a topic is printed from a browser, this results in an empty page followed by the topic on the next page.

Alternatives

Flare supports different approaches to accommodate different single-sourcing challenges. So if you choose to adjust to this workflow approach, you may need to accommodate changes in how you approach DPI management for image single-sourcing. For example, Capture with its dedicated Flare Print Format image property, relies on the assumption that the ‘print’ medium is used for all printed deliverables.

However, Flare/Blaze’s documentation does not recommend any single approach over any other approach.

References

This is still a good read. I am using this reference to build new stylesheet guidelines.

Flare Print Publishing, Stage 2: Defining Styles

Forum: Another recent forum topic on this article about print mediums.

Forum: Mediums vs Separate Stylesheets

Ellison Consulting – Generating Quality Print Output from Flare or Blaze

Tagged:
Posted in: Print Output