Using WebWorks

7/31/2019 Using WebWorks

1/27

Using WebWorks

These Instructions apply to WebWorks Professional and Standard Version 7. These versions are used withFrameMaker 7.

I. Starting a newWebWorks project

NOTE: If you are logging on to the WebWorks system for the first time, see the "Set Default Folder Locations forWebWorks" instructions.

1. Start WebWorks (Start Programs Quadralay Webworks Publisher Standard Edition 7.0Webworks Publisher Standard Edition 7.0). The WebWorks Project Launcher window should open.

2. Under Create a New Project, use Browse button to select the appropriate Dell Master Template for your

project. The templates are located in webworks.zip file available from Dell.[1] Use the Flat html template

for flat html. Use the compiled html template for compiled html.[5] You can tell which template is which bythe folder names.

3. Click OK to continue.

4. The New Project Wizard will appear. Use the Next and Back buttons to move between steps.

Choose a name for this project and enter it in the Please choose name for this project textbox.Use this naming convention: codename-doctype-A0x. For example, Hydra-UG-A01.

Choose a location for this project. Use the C:\\webworks-projects folder designated for this

purpose. [2]

Choose Default Font Character Mapping[IS0-8859-1]

Click Next

WebWorks will now create a folder for your project at the location you specified in the previous step,and the wizard will now ask you for the name of the FrameMaker book or documents to beconverted.

Pause here (do not exit WebWorks) and:

Copy the FrameMaker book to the project folder you configured in the previous step. Youcan perform this file copy operation using Explore. For example:

Right-click on the Windows Start button and select Explore.

Navigate to the network folder where your Frame book resides. Select all the files and

click on File Copy.

Navigate to your, specific, webworks-projects folder.

Create a Source folder and paste the files in.

Open the FrameMaker book file in Frame. Then open all the files in the book.

Now continue in WebWorks by using the Browse buttonto tell WebWorks the location of the Bookyou just copied to your project folder:

Page 1 of 8WebWorks

10/29/2007file://C:\Documents and Settings\bernardo_salinas\Desktop\using_webworks\using_web...


2/27

Select only the FrameMaker .book file. Do notselect all the individual files in the book.

Click on Open.

Click on Next.

At his point WebWorks will read the book. This could take a few minutes. When WebWorks is done

reading the book it will display a screen showing you paragraph mappings. Use the Next button toskip this screen.

Select NoI'll convert the content later and click Finish.

WebWorks may take a few minutes to scan you project. When it is done, click on the WebWorksSave icon. Saving creates a WebWorks project file (.wdt) specific to your project.

If you have followed the preceding steps correctly, you should be able to browse to your WebWorks project folderon your local drive and find your project folder.

To continue setting up your project, proceed to the next section.

II. Configuring Project Options

The majority of Project Options are preset in our templates and do not require any change. This section of theQuick Start Guide documents only those options that mayneed to be changed.

If your final deliverable is flat html, see the "Flat HTML Project Options" table.

If your final deliverable is a compiled help file (.chm) , see the "Compiled HTML Project Options"table.

NOTE:See also the mappings.xxxx.txt files under the Support Files in the WebWorks Interface as shown inthe image below. The mapping.txt files may contain important updates that have not yet been incorporated intothis process.

Page 2 of 8WebWorks



3/27

Flat HTML Project Options

1. Right-click on Framemaker and Generated Files and select Properties. The File Propertieswindow will appear.

2. Click on the Output tab.

Map all pages to Normal. Then map the Frame TOC file to TOC.

Change the html File Name for the TOC to index.htm.

Page 3 of 8WebWorks



4/27

Click on the Graphics subtab located at the bottom of the File Properties window.

Map all Graphics to JPEG.

3. Click the Files tab.

4. Right-click on title page file and select Properties. The File Properties window will appear.

Map the title page file paragraphs [3] as follows:

6. Close the Project Properties window.

7. In the Main WebWorks window Click on the Options tab.Make sure these options are checked:

Use DOS 8.3 Filenames

Generate Pages

Generate Graphics

Default Font Character Mappings

8. Proceed to section III. Converting the Book.

Source Style WebWorks Style

Caution CautionTitlePage

Copyright Line NoOutput

Head 2 Non TOC Head2TitlePage

Note NoteTitlePage

Notice NoticeTitlePage

Paper Date P/N Copyright or NoOuput

Paragraph ParagraphTitlePage

Compiled HTML Project Options

1. In Main WebWorks Window, make sure your Frame TOC file is the first file in the list underSource + Generated files. If the Frame TOC is not the first file in the list, click on Project

Rearrange files, and move it to the top of the list.

2. Right-click on Source + Generated files Properties. The Project Properties window

Page 4 of 8WebWorks



5/27

will appear.

3. Click on the Table subtab. Map Tables as follows.

4. Right-click on your Frame TOC Page file and select Properties. The Project Propertieswindow will appear. Map the TOC page file paragraphs as follows

Note that if you do not want head2s and head3s included in the TOC of your finalhelp file, map them to NoOutput

5. Click on the Output tab.

Map all pages to Normal. Then map the Frame TOC file to TOC.

Click on the Graphics subtab.

Map all Graphics to JPEG.

6. If your document has a specifications section, right-click on the specifications file and mapthe Specification file paragraphs as follows:

7. Close the Project Properties window.

8. In the Main WebWorks window Click on the Options tab. Make sure these options arechecked:

Generate Pages

Generate Graphics

Default Font Character Mappings


Callout (1 Column) Callout_1_column

Callout (2 Column) Callout_2_column

Solving Solving

Specs Specifications


ContentsTitle NoOutput

Head1 (Section Title) TOC TOC1

Head 2 Top of Page TOC TOC2

Head2TOC TOC2

Head3TOC TOC3


Head 2 NoOutput

Table Head Left Table_Head_Left_Specifications

Page 5 of 8WebWorks



6/27

III. Converting the Book

1. Click on Project Generate All to convert the entire book including text and graphics.

WebWorks puts all html and graphic files in the output subfolder of your project directory. The outputfolder is fully self-contained. It is not cross-linked to the support folder, or the temp folder, which WebWorksalso creates.

2. Inspect your conversion by browsing the html files to see if they look right to you. You may also wish to run

a HomeSite link check on the html files. [4]

If you have issues, review the your project options and make sure you didn't miss anything. Seealso the WebWorks Reference and Troubleshooting Guide.

3. If your final deliverable is flat html, your conversion is done (for this round anyway), and ready for review.

Close WebWorks. If you are prompted to save your project template say Yes.

Copy your WebWorks Project folder to your Frame source project folder on s: so that othermembers of your team (like your editor) can view it.

4. If your final deliverable is a compiled help file, you have a few more steps to go. So far you have generatedthe html files. Now you need to compile those into a .chm help file. See section IV.

Re-Generating a Book a Second Time

When you go to reconvert a book a second time (for example if you have revised the Frame files) follow thesesteps:

1. Copy and paste the revised Frame files to your webworks project folder. Paste them into the Sourcefolder, so that the new Frame file overwrites the old ones.

2. Open all your Frame source files.

3. Double-click the the WebWorks project file (.wdt) in your project folder to open your project.

4. Follow the steps in the previous section to reconvert the book.

9. Proceed to section III. Converting the Book.

Page 6 of 8WebWorks



7/27

Manual Changes at Final Conversion

At final conversion, make the following manual changes to your html files.

1. Make long mini-tocs 2 column

At the top of each converted html chapter, there is a vertical list of links. We call this a mini-toc. Ifthis list is over 8 links, you should manually make the list 2 column as the last step in the finalconversion.

This procedure should be done directly in the html code. This is the format for the empty table:

The procedure is to go into the html code, create the empty table, and copy and paste half of thelinks (which have already been created by WebWorks) into each of the 2 columns. For example, forthe first column, cut the first half of the links and paste them into the code so that they replace the line of code.

2. Delete surplus files from your output folder before creating a final zip or cab file

.txt files are surplus. Delete title.txt, copyright.txt, miniTOC.txt, miniTOCtitle.txt, modelnumber.txt, tp.txt, etc.

Any html pages (for example, title.htm) that you know of that are not part of your final deliverable. Forexample in flat html we typically do not use the converted Frame title page, LOT file, LOF file, or IX file. Soif those are not being used, they can be deleted.

IV. Compiling HTML Files into a .chm File

If your final deliverable is compiled help (.chm) file, see the separate process, Creating Compiled Help Files, forinstructions on how to compile the html files you have created so far into a .chm file.

Tips & Tricks

Problem: Regulatory model number appears twice on index page when converting to HTML. The only fixseems to be to manually delete the duplicate number from the HTML.

Solution:

In Frame: Apply the P/N style to the regulatory number where it is located on the back of the titlepage. Apply the "reg#" style to the regulatory number where it is located on the front of the titlepage.

Page 7 of 8WebWorks



8/27

In WebWorks: Set the "reg#" style to "no output."

Footnotes

1. This should be your default directory for templates. If it isn't, see "Set Default Folder Locations for WebWorks".

2. If you don't know where the webworks-project directory is, see "Set Default Folder Locations for WebWorks".

3. By default, you should be on the Mappings tab (Paragraph subtab). Compare what you are seeing to Figure 1if in doubt.

4. "Compiled HTML" refers to .chm help files, also known as Microsoft HTML help. In compiled html, all theseparate html pages and image files are compiled into a single .chm file, hence the name "compiled" html.

Page 8 of 8WebWorks



9/27

Set Default Folder Locations for WebWorks

Before you can use the WebWorks systems for the first time you need to follow these steps. (You do not need todo this every time.)

In WebWorks, click on File Preferences. The Preferences Dialog box will appear.

1. Set the Default Folder for New Projects to the webworks-project folder on your local drive.If you have you have your own copy of WebWorks on your own system, create a create a webworks-project folder on your local drive.

2. Set the Default Folder or Share for Templates to C:\WebWorks\Dell-Master-Templates.

Page 1 of 1Instructions for Logging on to the WebWorks Systems

10/29/2007file://C:\Documents and Settings\bernardo_salinas\Desktop\logging_on\FirstTimeLogin.h...


10/27

WebWorks Reference and Troubleshooting Guide

This document briefly addresses common issues that people have encountered during WebWorks conversions.

Contents

Unwanted line breaks after a Run in head

Missing Pages

Errors Opening Frame Files

Unwanted Text Formatting

Unwanted Paragraph Formatting

Character formats are not converting with proper formatting

The title page book title or GuideTitle2 is in all caps

GuideTitle2 is missing

Cross-references

Graphics Issues

When small graphics are converted from Frame to html they appear centered or indented in the html

Issues with Tables

There is not enough white space between a Table and the text that precedes the table (or in the case of ESG, the Tabletitle)

Some table cells appear to be missing

When the Specifications Table is converted from Frame to HTML, their are empty links in the Mini-toc

Unwanted line breaks after a Run-in head

In Frame, when you want a paragraph to come up alongside The Run in Head paragraph Tag, the tag to use is TableParagraph Run-in. See the following example:

That combinationof Frame tags converts as shown in this example:

Page 1 of 9Common Problems and Solutions

10/29/2007file://C:\Documents and Settings\bernardo_salinas\Desktop\reference\index.htm


11/27

If you use a different combination, for example, Run in Head + Paragraph:

You will get unwanted line breaks, as shown in this example:




12/27

To understand why this is so, go into the WebWorks Style Designer and look at the html code for Run in Head, Paragraph,and Table Paragraph Run-in.

Missing Pages

When you start a new project WebWorks reads the Frame book file to determine what files are in the book. WebWorks adds

those Frame files to the WebWorks project. If the writer later adds or subtracts files, you need to manually add or subtractthem to the WebWorks project.

In the WebWorks Interface, right click on FrameMaker and Generated Files. Select Add or Delete files and follow thedirections on your screen.

Errors Opening Frame Files

If you gets errors when WebWorks tries to open the Frame Files, open all the Frame Files in FrameMaker first and respond toany errors you get. Then, with the entire book already open in FrameMaker, go back into WebWorks and open the project.

Unwanted Text Formatting

Examples:

Notes are converting to italics even though they are not italicized in Frame.

Notices are converting to bold even though they are not bold in Frame.

In Frame, highlight the note or notice and open Character Designer. Check to make sure Emphasis or bold is not applied as a




13/27

character tag. If it is, point the problem out to the writer and ask them to fix.

Unwanted Paragraph Formatting

Paragraphs are not converting with proper formatting

Go into Frame and identify the paragraph tag being used. Make sure its the right tag. Then go into WebWorks and see whatthat tag is mapped to. Make sure it is the right mapping. If that doesnt solve the problem, inspect the WebWorks style for thatmapping and see if the style needs to be adjusted.

Character formats are not converting with proper formatting

Go into Frame and identify the character formatting being used. Does it have a Character Tag assigned? In some cases theremay need to be a Character Tag assigned in order for WebWorks to recognize the formatting. Next, go into WebWorks andcheck to make sure the Frame Character Tag is mapped to a WebWorks character definition. If that doesnt solve the problem,inspect the WebWorks style for that character mapping and see if it needs to be adjusted.

The title page book title or GuideTitle2 is in all caps

The title page book title paragraph tag in Frame is set to upper case in the paragraph designer. This upper case setting isignored by WebWorks. WebWorks sets the case based on how the letters were typed in. So if the title is converting as allcaps, it means the title was typed into Frame in all caps. Retype the title in mixed case to solve this problem.

GuideTitle2 is missing

In order for WebWorks to covert the GuideTitle2 Paragraph, there must be no extra paragraph tag after it.

This works:

Dell XYZ System

User's Guide

This does not work:

Dell XYZ System

User's Guide

Cross-references

When cross-references are converted the space next to the text is also converted.

Check the Cross Reference format in FrameMaker and make sure there are no unwanted spaces.

Check the File Properties -> XREFs tab in WebWorks and make sure there are no unwanted spaces.




14/27

Graphics Issues

Some graphics convert poorly

Make sure the graphic is set to convert JPEG and that the JPEG settings are correct.

Some graphics dont convert

Make sure Generate Graphics is checked on the Options tab.

Reconvert the one FrameMaker file that has a problem. Sometimes in large conversions WebWorks will miss a graphicor two, but it will generate that graphic the second time you convert.

Some graphics appear along side their Figure Title rather than below the Figure Title.

Make sure the graphic is anchored to an anchor paragraph tag, not the figure title.

If you anchor to the figure title, WW thinks the graphic is part the Figure Title paragraph and converts the Figure Title plusgraphic like this:

Figure Title Text text text

Where as when you have the graphic anchored to an anchor tag, it converts like this:

Figure Title Text text text

When small graphics are converted from Frame to html they appear centered orindented in the html

When WebWorks converts graphics, it converts the entire frame. If the Frame is considerably larger than the actual graphic,the converted output will also be a large graphic with a lot of white space in it. This excess white space makes the graphicappear centered or indented.




15/27

There is not enough white space between a Table and the text that precedes thetable (or in the case of ESG, the Table title)

Just like figures, tables need to be anchored to an anchor tag. If you anchor a table to the end of a sentence, in the html codethe table will literally be attached to the end of that sentence. In Frame, anchor tables to an anchor tag.

Illustration of how to anchor a table:

Illustration of how Not to anchor a table:




16/27

Some table cells appear to be missing

In Frame, put a non-breaking space in all empty table cells. WebWorks will do the same in the html. You can create a non-breaking space by using the key combo .




17/27

When the Specifications Table is converted from Frame to HTML, their are emptylinks in the Mini-toc

On the Specifications page, WebWorks builds the Mini-toc from the Table Head Left paragraph tags. It will add all Table HeadLeft tags to the mini-toc, even if they are empty or concealed in a straddled row.

Example of Table Head Left that was concealed in a straddled row.




18/27

Solution

Ensure that their are no empty Table Head Left tags in the Specs table. If need be, unstraddle rows and change unwantedTable Head Left tags to Table Paragraph. Then reapply the straddle.




19/27

Using W in dow s Help Wor kshop

1. Complete the WebWorks conversion using the compiled-HTML WebWorks template.

WebWorks creates the Microsoft HTML Help Workshop project file (. hhp ) and the TOC file (. hhc). Thesefiles are included with the . h t m and . j pg files in the Out pu t folder.

2. In the Out pu t folder, create a copy of the . hhp file and rename it as appropriate (for example,Del lHe lp .hhp for Dell Dimension Help files or use rsgd . hhp for compiled User's Guides).

Creating a copy of the . hhp file ensures that your project settings will not be overwritten if you convertyour files again.

3. In the Out pu t folder, create a copy of the . hhc file and rename it as appropriate (for example,Del lHe lp .hhc or usersgd.hhc ).

Creating a copy of the . hhc file ensures that the manual TOC updates that you make in step 9 will notbe overwritten if you convert your files again.

4. Open Microsoft HTML Help Workshop.

5. Click File Open and open the . hhp file that you renamed in step 2 (for example, Del lHe lp .hhp for

Dell Dimension Help files or use rsgd . hhp for compiled User's Guides).

6. Click and make the following changes:

a. General tab:

Update the T i t le (for example, Dell Latitude User's Guide or Dell Dimension Help).

Set the default file to t p . h t m or abou t . h t m (your title page file).

NOTE: Windows Help Workshop is the current Info Dev tool for compiling HTML files.

NOTE: If you open the project by double-clicking the . hhp file, you might receive errors when youattempt to compile the file.

Page 1 of 9Creating Compiled HTML Files

10/29/2007file://C:\Documents and Settings\bernardo_salinas\Desktop\chm\compiled.htm


20/27

b. Files tab:

In the Com pi led f i l e location path, change the name of the .chm file as appropriate (forexample, Del lHelp.chm or usersgd.chm ).

Ensure that the Cont en ts f i l e is the . hhc file that you renamed in step 3 (for example,Del lHe lp .hhc or usersgd.hhc ).

Leave the remaining fields blank.




21/27

c. Compi le r tab: Ensure that Com p i l e f u l l - t ex t sea rch i n f o rm a t i on is checked and thateverything else is not checked.




22/27

d. Merge F i les tab: Leave the tab blank.

7. Click OK .

8. Click and make the following changes:

a. General tab: Update the T it l e ba r t ex t (for example, Dell Latitude User's Guide or DellDimension Help).




23/27

b. B u t t o n s tab:

Check H id e/ Sh o w , Back , F orwa rd , O pt i ons, and Pr in t . Ensure that the other boxes are notchecked.




24/27

c. Pos i t i on tab: W i d t h = 800 Heigh t = 600




25/27

d. Files tab:

W i n d o w : TriPane

TOC: . hhc file that you renamed in step 3 (for example, Del lHe lp .hhc or use rsgd . hhc)

Defau l t : t p . h t m or abou t . h t m (your title page file)

Leave the remaining fields blank.

e. Naviga t ion Pane tab:

W i n d o w t y p e : TriPane

Wi ndow w i t h nav i ga t i on pane , t op i c pane , and bu t t on : Ensure that the option is checked.

Nav i ga t i on pane w i d t h : Leave blank.

Proper t ies : Do not check any of the properties.

Tabs: Select Conten ts under Def au l t t ab , and check Search t ab . Ensure that the other tabsare not checked.




26/27

f. Sty les and Ext ended Sty les tabs: Leave blank.

8. Click the Conten ts tab.

If you receive the message "If you change a file that has been automatically generated, you will loseyour changes when you recompile...," click Ye s.

9. Manually add the title page and Glossary to the table of contents:

a. Click the first entry in the TOC and click .

If you receive the message Do you wan t t o i nser t t h i s en t r y a t t he beg i nn i ng o f t he t ab l eo f con t en t s?, click Ye s.

b. Type the title of the document under En t r y t i t l e ,for example, Dell Dimension Help or DellLatitude User's Guide.

c. Click Add , click the title page file in the HTML titles list (usually t p . h t m or abou t . h t m ), and clickOK .

If the title page is not listed, click B r o w s e and select the title page file.

d. Click the last entry in the TOC and click .

e. Type Glossary under En t r y t i t l e .

f. Click Add , click the Glossary file (usually g lossary .h tm ), and click OK .

If the Glossary is not listed, click B r o w s e and select the Glossary file.




27/27

10. Click to save your project settings.

11. Click to compile the file.

NOTE: If you make any changes to the Frame files that affect the TOC, delete the copy ofthe . hhc file that you renamed in step 3. Reconvert the TOC, make a copy of the new . hhc file,and rename it again, using the same name that you used in step 3 (for example, Del lHe lp .hhcor use rsgd . hhc). Repeat step 8 and step 9.

NOTE: Ensure that the following files are included in the zip file that you send to translation:

All . h t m , . j pg , and .g i f files. The .css file. The .h h p and . hhc files that you renamed in step 2 and step 3, respectively; do not include any

extra . hhp and . hhc files, such as the ones that WebWorks generates each time you reconvertthe files.
