Archive for the ‘Technical Tips’ Category

Screen Capture Programs

Posted on: August 15th, 2008 No Comments

At a recent WebWorks.com Open House, a discussion about good tools for capturing computer screens came up and I recalled that I had actually done quite a bit of research and experimentation with these types of tools. I also had put together a short write-up on my company’s internal wiki about the topic. Now I realize that others might find this information useful, so I have made it available on our main wiki site. wiki.webworks.com.

In a nutshell, here were my findings.

Best in Class for:

Static Screen Capture

    TechSmith’s: Snag It

Dynamic Screen Capture (category 1)

    Blue Berry’s: FlashBack

    Category 1: focuses on routine training and recording tasks where there are minimum requirements for modifying the resulting output

Dynamic Screen Capture (category 2)

    TechSmith’s: Camtasia

    Category 2: focuses on special applications requiring post editing, scaling, and the remixing of audio and video

Light-weight Static and Dynamic Screen Capture

    From the TechSmith folks: Jing

Adding Intuitive Icons to Your HTML Hyperlinks

Posted on: January 2nd, 2008 No Comments

The following image is a recent screen capture of our website front page. Notice that there are icons placed after all the text hyperlinks.

Today’s blog entry will discuss a fairly straight forward CSS method for adding this behavior to any web content, including legacy files.

Background

For our website, we wanted our text hyperlinks to be more obvious to our readers. In addition, we didn’t want to require any significant re-work of the exsisting content. So after studying how other popular websites were using this technique, we were able to modify a single CSS file and get the changes across our entire website, including our blog, online manuals, and technotes.

Additional requirements were:

  • () Identify to the reader external links that are not on www.webworks.com or wiki.webworks.com.
  • () Identify to the reader links that jump to a different topic somewhere on webworks.com.
  • () Identify to the reader links that nest within a given topic, but are on a different page.
  • (plain) Identify to the reader links that stay on the same HTML page.
  • Make sure existing navigation links such as menus are not affected.
  • Provide a simple mechanism for overriding the icon behavior using the “class” attribute.
  • Be able to deploy it immediately without modifying any of the website.
  • Make sure it works as designed for both Mozilla 1.x and IE 7 class browsers.
  • Make sure that fallback behavior for non-supported browsers is functional.

Keys to Making it Work

  • Use a CSS attribute selector such as: “a[href]” to handle the default case.
  • Use a CSS attribute selector such as: “a[href^="http://"]” to determine type of link destination, by matching a beginning set of characters.
  • Set a background image with a right position and a padding-right value to create the trailing icon.
  • Use the correct order for each CSS rule so that the proper properties get set. For example: place the most general selectors first and then append other rules for additional exceptions based on pattern matching.
  • If necessary, prefix the selectors with ancestor element types to restrict their use to just the content areas of the website.

Coding It

Sample CSS code
  /* links to nested areas (drill down) */
a[href]
{
  background: transparent url("/common/img/page.gif") no-repeat scroll right center;
  padding-right: 13px;
}

  /* links with in the same file */
a[href^="#"]
{
  background: transparent none no-repeat 0 0;
  padding-right: 0px;
}

  /* links to external websites */
a[href^="http"]
{
  background: transparent url("/common/img/www.gif") no-repeat scroll right center;
  padding-right: 13px;
}

  /* links to same website */
a[href^="/"], /* implicit */
a[href^="../"], /* out of current area, but still implicit */
a[href^="http://www.your_website.com"] /* explicit www.your_website.com */
{
  background: transparent url("/common/img/jump.gif") no-repeat scroll right center;
  padding-right: 13px;
}

  /* links that should not have a button (must remove it) */
a[class]
{
  background: transparent none no-repeat 0 0;
  padding-right: 0px;
}
Limiting Behavior to Content Areas Only

Very likely you will want to limit this behavior to only the actual content parts of each HTML page, which will require a more complex CSS rule. Usually this can be easily accomplished using one or more ancestor prefixes for each CSS rule. Here is an example of the first CSS rule with an ancestor prefix in the selector.

  /* links to nested areas (drill down) */
div.content p a[href]
{
  background: transparent url("/common/img/page.gif") no-repeat scroll right center;
  padding-right: 13px;
}

See our wiki at: http://wiki.webworks.com/DevCenter/Projects/HTML/AddingIconsToLinks for more details.

Evaluating ePublisher Express instead of Pro

Posted on: December 18th, 2007 No Comments

Today, I would like to briefly explain a change in the process for evaluating ePublisher that began with the 9.3 release.
The change was to have users download and install the component called: ePublisher Express instead of ePublisher Pro. The motivation being to more gradually introduce new users to the powerful design capabilities built into ePublisher by starting with easiest to configure component first, and then progressing to the Pro component once it is determined that users are ready to create their own Stationery for doing production work.

So how do I use Express without my own Stationery?

Try out one of the example stationeries located at:

~\My Documents\ePublisher Stationery

To do this, follow these steps:

  1. Download and install ePublisher Express
  2. Navigate to the folder:
    My Documents\ePublisher Stationery

    and unzip the example files. This will create 3 example stationeries, each in a subfolder.

  3. Launch Express and create a new project, using any one of the example stationery files.
  4. Add your own documentation files to the project and generate all. For more information, see the tutorial here.

So then what?

First of all, note that this is a “one size shoe fits all” stationery, which has been configured to loosely work with many different types of documents and source files. However, it is not intended for production work and at a minimum will require some styling work before it will match your own requirements.
Next, experiment with creating projects using Express and your own documentation files. Take a look at the results for different output formats. Then determine the following:

  1. What format(s) are right for your needs?
    • WebWorks Help 5.0
    • Dynamic HTML
    • JavaHelp
    • PDF
  2. What behavior does your output require:
    • Topic splitting
    • Drop down text
    • Pop up windows
    • Context sensitive linking
    • Client-side search
    • Integrated PDF
  3. What style changes are required?
    • Page styling
    • Graphic styling
    • Paragraph styling
    • Table styling

Using this information, you are now ready to create your own Stationery using the ePublisher Pro component. This component works similar to Express accept that it allows you to perform a Save As Stationery operation, which creates your own Stationery for use with Express and AutoMap.

Note: Now you only have one more decision. Does your team require a completely hands-off process that integrates with your select VC/CM system?