Archive for the ‘Best Practices’ 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.

Understanding Customization in ePublisher

Posted on: July 5th, 2018 No Comments
With the release of ePublisher 2018.1 a lot of our customers want to upgrade to take advantage of the new features. Upgrading to a new format in ePublisher always starts with your existing ePublisher Designer project. Before you start making changes to any Designer project, you should understand customizations and where they are located. Customizations are created and edited in ePublisher Designer projects only and can take place in three different areas:
  • The Style Designer Tab
  • The Target Settings Window
  • The Advanced Tab

The Style Designer

The Style Designer is where you determine how your content will appear in the Content Display area. ePublisher will scan your source documents and bring in the Style names and information. In the Style Designer, you can lock down the information (e.g. font, size, position, background, etc..) and change behavior such as page breaks and search relevance. You can gain access to the Style Designer by navigating to the View tab and then selecting Style Designer

In the Style Designer there are 4 tabs:

  • Properties
  • Options
  • Target Properties
  • Target Options

Any area with customizations will appear in bold. To view the customizations select the bolded areas. The customizations will then appear in the Style Designer Window.

Customizations in the Properties or Options tab will automatically be carried over to Reverb 2.0. Customizations in the Target Properties or Target Options tab only apply to the selected target and will need to be carried over manually to any new target.

Target Settings Window

Target settings customizations are different from the Style Designer and Advanced tab because these customizations are in the Target Settings window instead of the ePublisher Working Area.

In the Target Settings you will customize items such as company name and logo, enter your Google ID, customize reports and activate/deactivate items in the table of contents, index, and footers.

To access the Target Settings window, click on the Target Tab in the menu bar and then select Target Settings.

Once selected, the Target Settings window will open. As in the Working Area of ePublisher, the Target Settings window shows you in bold all the areas with customizations.

You will need to manually transfer these customizations over to Reverb 2.0. It is also important to note that some Target Settings’ categories will be different. Any category that is different will be a result of picking a different format for your target. Because of this, the difference will be a logical one, so easy to identify and understand. For example, the Target Settings category Skins in Reverb 1.0 will be different than the Skins category in Reverb 2.0. You will not have a Google category in Target Settings for a PDF format, but you will have one for Reverb 2.0 an HTML format.

Advance Tab

The customizations on this tab are edits in one of the default program files of ePublisher. The file formats include HTML templates,  CSS, Java Scripting, XSL and other coding languages. Since anyone editing these files should have basic knowledge of the coding they are editing, these customizations are put under an Advanced in tab.

The AdvancedTab is located on the menu bar next to the View Tab.

Under the Advanced Tab there are two sections:

  • Manage Format Customizations
  • Manage Target Customizations

Format customizations are applied to any target with that format. For example, if your target’s format is Reverb 1.0, any customization applied under the Manage Format Customizations tab will apply to all targets with the Reverb 1.0 format. Target customizations apply only to the format of the target selected.

Summary

ePublisher is a powerful tool that allows you to increase the importance of the message you deliver to your customer. Understanding customizations is important to your success and utilizing all the features of ePublisher. There are 3 areas in your Designer Project where you could have customizations. Some of these customizations will automatically carry over, others you will have to manually include, and others you will not need at all. Identifying all the areas where you have customizations and knowing how they work will help to meet the ever changing needs of your audience.

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:

(more…)

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:

(more…)

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.

(more…)