Archive for the ‘tips-n-tricks’ Category

How to Upgrade to Reverb 2.0

Posted on: July 17th, 2018 No Comments
Have you ever tried to upgrade from PDF, WWH5 or Reverb 1.0 to a more advanced user-friendly output? We know it might seem difficult for a multitude of reasons. Perhaps you have inherited a project and you are not sure where to start or maybe you have several customizations in your output that make upgrading seem impossible.
With the release of ePublisher 2018.1, many ePubilsher customers have quickly and easily upgraded to Reverb 2.0. By utilizing the information in this article, this post will help get you started on the path to a Reverb 2.0 HTML5 advanced document set.

Here are a few reasons  why it is a good idea to upgrade to Reverb 2.0

  • Improved Customer Satisfaction
  • Increased Product Value
  • Measured Customer Engagement

Reverb 2.0 was designed to help you, the Content Creator, get the most relevant information to the customer in the least amount of time while maintaining an intuitive feel to your document sets. If you are looking to increase the value documentation brings to your organization Reverb 2.0 is a big step in that direction.

Process for upgrading

Find the Right Reverb 2.0 Skin

To view the Reverb 2.0 skins, we recommend adding a target to your existing ePublisher Designer project. This is so you can see what your source documents look like in the new skin and identify which customizations are going to automatically transfer over and which ones will need to be manually transferred. You always have the option of creating a new Designer project to see what the default output will look like.

How to add a target

  1. Click on the Project Tab in the menu bar and select Manage Targets
  2. In the Manage Targets window, you will select Add to create a new target
  3. Pick a target name and enter it in the Target Name box
  4. In Format Type, click on the drop-down arrow and select WebWorks Reverb 2.0
  5. Click OK
  6. Verify that the new target name appears in the Manage Targets window.
  7. Click Close

Once the new target has been added, it will now appear in your active target window. To view the new format simply select the target and generate all. Feel free to experiment with each new target, once you find the right Reverb 2.0 skin you can delete the other targets.

Choosing the Right Customizations

Once you have selected a skin the next step is to choose the right customizations. It is a simple process:

  1. Compare customizations from the old target
  2. Pick which new features to customize in Reverb 2.0
  3. Regenerate your output.

When comparing customizations (for more about ePublisher customizations click here) we recommend starting with the Style Designer. Any customizations in the Properties or Options tab will be automatically carried over to Reverb 2.0. Only review bolded items on the Target Properties or Target Options tab because they are not automatically carried over because they are Target specific.

After you have reviewed the old customizations you can add new ones. All new features available in this area will be listed in the Properties and Options tab. If you see a feature you would like to customize only for the selected target, look for the feature listed in the Target Properties or Target Options and make the changes.

Once you’re finished working in the Style Designer compare customization in the Target Settings window.

Hint: create an excel sheet with the categories in Target Settings that have been customized.

If a category carries over to Reverb 2.0, the name will be the same in the Target Settings window. For example, Company Information is the same category name in the Target Settings of WebWorks Help, Reverb 1.0 and Reverb 2.0. 

With the excel spreadsheet created you can compare target settings in Reverb 2.0 and determine which settings should be transferred.  After transferring the target settings you can scroll through the categories and determine which new features to customize. After all the customizations have been made, generate the new target. If the output meets all the requirements, we would recommend moving to the section “Putting on the Final Touches” If not, you will need to compare the Advanced tab customizations.

We recommended you have the person who created the Advanced tab customizations compare them. If that person is not available, you can create a support ticket to get help with the transfer. If you would like to learn more about the Advanced tab customizations there are several options available to you. We have ePublisher 201 training that covers Advance tab customization in detail. We also have Study Hall in which you could bring in a project and have someone help you determine the best way to customize a project. The optimal path is to take ePublisher 201 training for a solid overall understanding of the Advanced tab features and then Study Hall or a support ticket for one-offs.

Putting on the final touches

The final step of the process is to put on the final touches to your Reverb 2.0 output. Reverb 2.0 was developed with Sass technology to make it easier to customize colors, logo placement, and icons.

To change the color, logo placement or icon of your Reverb 2.0 output, navigate to the proper file under the Advanced tab (to learn more about Advance tab customizations click here.) Once you have selected either target or format customizations navigate to the Sass folder and make the necessary customizations in the correct file.

_colors.scss is the file to change the color scheme of your Reverb 2.0 output. This file is written so you can design a nice output with as few as three colors. You just enter the hex color code in the proper location as indicated in the picture below.

_sizes.scss is the file where you can control the dimensions of sections within the Reverb 2.0 layout. Sections include areas like menu, toolbar, and toolbar logo. The file is well noted and easy to navigate. Just find the right section and make the necessary changes.

These are just a few examples of the Sass system we are using to help you customize Reverb 2.0. For a full list of the Sass files and their descriptions, you can go here.

We at WebWorks have designed our newest output with your customers in mind. Reverb 2.0 has new and improved features to help you guide your customers to the information they need. We’ve made upgrading easy for you by decreasing the amount of time needed to do so and by helping make sure you hold on to the customizations you’ve added. When making the move to Reverb 2.0 feel free to reach out if you have any questions.

Tips & Tricks: Customizing Reverb Output

Posted on: October 31st, 2012 No Comments

Customizing Reverb Output

To fully understand how Revervb can be customized, first you have to envision your final output. Once you have this vision in place, it is time to start translating that design to your WebWorks Reverb layout. Reverb is sectioned into different parts. This means you will have to access different sections within ePublisher Designer to fully achieve your desired design layout.

Let’s get started from the top:
When you first generate your Reverb output, a toolbar will appear at the top of your page. Reverb already has Responsive UX coded into it, so it will maximize the screen real estate of the end user’s display.

Reverb Header


There is actually space for a header just above the toolbar; however, if no information is applied here, it will not render in the final output.

So let’s begin with the header:
To insert a header, you will first need to locate Target Settings.

Target Settings


Once you have located your target settings, you will see options that allow you to set up the header (this is done in the Company Information section).


Within your target settings you will also find options to toggle email on and off, adjust your printing capabilities, and the up Google selections.

Now that we have our header, let’s move on to the toolbar and table of contents.
These alterations will be done by modifying files found in the advanced tab, either under Manage Format Customizations or Manage Target Customizations.

Manage Format Customizations


To customize files in this view, simply select a file with your pointer, right click, and select Create Customization.

Create Customization


The file will appear in bold to let you know that it is being modified. Access the file by either double clicking on it or by right clicking and selecting “Explore To” to open Windows Explorer on the folder that contains this file. This is where you will make the changes to the skin of your output. You can change the color scheme, location of buttons, appearance of buttons, and behaviors. Modifying these files in ePublisher Designer is quite simple. You can either open the file and edit it yourself or, in the case of the images, replace them all together.

Tip: If you go to the view tab, you can look in the Format Override Directory and see where the new custom files are located.

Finally, Let’s change your source documentation content.
To change source document content, select a file in the Document Manager window and press the Display Preview hot key.

Display Preview


This will open a sample of your content in the preview window. As you select text areas, the style will have a highlighted background. Here, you can make your desired changes, press the green refresh arrow, and view the results.

Preview Content


In summation, to maximize your Reverb output customizations, you must access three separate areas in ePublisher to fully give you control over your customizations. If you would like further insight into customizing your Reverb output, be sure to check out our resource page. Also, join an ePublisher Study Hall session.

Moving Existing Content Over to Reverb

Posted on: July 19th, 2012 No Comments

The release of WebWorks ePublisher 2012.2 will be bringing some exciting innovations to the Reverb format. The convenience and functionality of Reverb is something we don’t want any ePublisher user to have to do without. We are often asked, “What is the level of complexity to moving content to Reverb from another format?” Well, the answer is quite simple, so we’ve decided to dedicate this Tips & Tricks to helping you get your content moved over to the WebWorks Reverb format.

Step 1:

After opening the Designer project that maintains your Stationery, select the menu item:
Project > Manage Targets

Select Manage Targets From the Project Menu


Step 2:

Select “Add,” and then specify your unique name for your new Reverb target (in this example, we’ve simply named ours Reverb). Now choose “WebWorks Reverb” from the Format Type dropdown menu.

Add New Target


Step 3:

In the target’s dropdown box, select the name of your newly created Reverb target (in the previous example, we named ours Reverb). Now you’re working on your new Reverb target within your existing Designer project.

Select Target


Step 4:

Select the “Generate All” button to generate the new output. All of your style settings that were previously configured will be retained, leaving little if any additional work to perform. Once you are content with your conversion results, you can then re-create your stationery. Now your new Reverb target will be available to all pre-existing ePublisher Express projects.

Generate All

ePublisher 2012.1: Style Designer gets turbo-charged!

Posted on: May 10th, 2012 No Comments

Now you can more quickly configure all your styles within the Style Designer without having to generate the actual output.

ePublisher Style Designer

When you select the “Display Preview” menu item in ePublisher Designer, it now opens the Style Designer alongside the Preview tab. The Preview tab will show an approximation of how your content will look after it has been generated with ePublisher. While examining the content in the Preview tab, you can select paragraphs or tables. When selected, the Style Designer will highlight the corresponding style, saving you the hassle of locating the associated style. From there, you can quickly make modifications to style properties.

See for yourself how ePublisher Designer quickly configures your paragraph styles with the Display Preview capability.

ePublisher Style Designer Demo

This brief video displays the power and simplicity of ePublisher Designer’s style designer with new preview mode capability. Simply load your project, generate a preview, and begin configuring all your styles. Editable paragraph properties, such as margin settings, borders, backgrounds, fonts, and so much more, are now easily accessible and directly in front of you, allowing you to edit their values in real time, alongside your preview display.

Save Time with TOC Auto-Detect Feature

Posted on: January 26th, 2012 No Comments

Save time when creating your ePublisher stationery by using the new table of contents auto-detect feature.

ePublisher Pro

In all versions of ePublisher prior to 2011.3, stationery designers were required to specify the level for each paragraph style that was going to be displayed in the generated table of contents (TOC). While this may seem like a routine configuration, it is somewhat redundant, as it is very likely that the original source document author has already specified these levels. Now, ePublisher can simply detect those levels automatically.

Users with existing projects and stationeries that have already been set up don’t have to do anything. Their TOC levels are already manually set. If you start/create new stationeries or Pro projects, this feature will immediately begin working for you. However, if you decide that the levels specified in your source documents are not what you want, you can still use ePublisher Pro to set the level to a specific value, thus bypassing the auto-detect capability.

Another benefit of this new feature is that it makes ePublisher Pro easier to learn for new users because most of your conversions will now generate a complete and fully functional online help deliverable without users having to learn much about ePublisher Pro’s style designer.


ePublisher Pro

For Example:

“Page Break Priority” allows you to split your document into separate pages by setting auto-detect for your table of contents level
(See Below).

Here you set your table of contents level to “Auto-Detect.” Once properly configured, ePublisher will now automatically detect the appropriate level from the source document.


ePublisher Pro

Output Type:

Once all settings are properly configured, ePublisher will automatically detect your native table of contents level inherent to your source document and render your output into the chosen output format type (Seen here in WebWorks Reverb).

WebWorks Tips and Tricks: Transform Static Content into Engaging Web Pages

Posted on: July 1st, 2011

Click the links below to view WebWorks’ Latest Tips and Tricks.  Learn how to fully utilize WebWorks Reverb and its Disqus integration to turn your online help or published content into an engaging and interactive web page that will make your end users swoon.

STEP 1: Add WebWorks Reverb to your ePublisher Pro Project >>

STEP 2: Enable Disqus in your Format Settings >>

TIPS & TRICKS ARCHIVE #4 – ePublisher & 508 Compliance

Posted on: October 7th, 2010

In 1998 The US Government approved a new law that stated that all government agencies must give disabled employees and members of the public access to information that is comparable to the access available to others. This directive is known as the Section 508 Law, and in the intervening years has been adopted not only by government, but by many industries as well.

Delivering Section 508 compliant information is becoming an essential part of doing business online.

You can use ePublisher to help you make sure that you produce online content that conforms to Section 508, as well as the W3C Web Content Accessibility Guidelines 1.0 (WCAG), and the Americans with Disabilities Act (ADA).

To generate accessible content, typically you provide the following items in your online deliverables:


TIPS & TRICKS ARCHIVE #3 – ePublisher Language Support

Posted on: October 6th, 2010

Did you know that ePublisher had some of the most flexible and customizable language handling capabilities of any publishing platform?

As well as ePublishers own extensible language support, the fact that the product is based on Microsoft’s .NET runtime means that we can also support localized sorting for any of the languages it supports.

Out of the box ePublisher supports the following languages:


TIPS & TRICKS ARCHIVE #2 – ePublisher Reports

Posted on: September 27th, 2010

ePublisher is not just about converting your content from one format to another. While automating the publishing process by separating it from the authoring process is one of our key objectives, another is helping you develop the most efficient high quality output possible. To do this we generate reports on what ePublisher is doing and the status of your documentation at every stage of the production pipeline.

Using these reports you can easily find, and correct errors, as well as continue to fine tune your process to ensure that you deliver the best content in the most efficient manner possible.


2-Celled Note Table

Posted on: January 22nd, 2009

Someone asked me about this at RoundUp a few months ago, and I’m just now getting around to publishing it.  I’ve just posted a tip for creating a two-celled note style table for a given paragraph style on the WebWorks wiki.

The implementation uses the wwtransform:super resolver. We are working to make this the blessed way to do overrides in ePublisher. We are working on formalizing the implementation for the 2009.1 release.

Enjoy and please report any problems.