|
|
In the tutorials and readings, you learn a series of essential help-authoring `tasks. A good way to practice those tasks and get them into your memory banks is to create a quick-reference document that summarizing the specifics briefly. And, these quick-refs will come in handy in the future!
See general requirements for these quick-refs at the bottom of this page.
Help-Project Startup
Explain how to do the following:
- Start the help-authoring tool—both from an icon, the Start list, and from a folder and choose HTML help.
- Start a project, giving it a formal display name, and a file and folder name.
- Determine where the project files are stored.
- Enter some text, and save it.
- Compile the simple project as a .chm file, and view it (through the help-authoring tool).
- Make some changes, get a quick look at the changes without recompiling, and then recompile.
- Find the .chm file on the computer, and double-click it to ensure that it runs.
Help Topics & Links
Explain how to do the following:
- Create two topics in the same project, and enter enough text in each so that you must scroll down to see all of it.
- Link the first topic to the second topic.
- Use the eye-glasses icon to quick-test your work.
- Link the second topic back to the first topic.
- Create a bookmark there. Create a link that goes directly to the bookmarked spot.
Help Popups
Explain how to do the following:
- Create a simple text popup.
- Find out how much text a simple text popup can handle, whether you can do anything with fonts or color, whether you can include an image.
- Create an expanding hotspot with text (one that expands within the existing text).
- Create an dropdown hotspot with text (one that expands below the existing text).
- Create an expanding hotspot with a graphic.
- Create an dropdown hotspot with a graphic.
- Create a related-information button that provides links to two other topics.
Help TOCs
Explain how to do the following:
- In exactly this order, create the following topics named as follows:
- Deleting files
- Creating files
- Directories
- Deleting directories
- Changing directory permissions
- Renaming directories
- Moving files
- Changing file permissions
- Files
- Copying files
- Changing directories
- Creating directories
- Using wildcards for multiple files or directories
- Changing permissions
- In the TOC pane, create two books: Working with files and directories; Understanding files and directories.
- In the Working with files and directories book, create a subbook: Changing permissions.
- Add, subordinate (move right), and sequence the topics under these books accordingly.
Help Browse Sequences
Explain how to do the following:
- Create a help project that includes these topics (currently unordered):
- Creating layers
- Adding layers
- Switching layers
- Flattening layers
- Layers: introduction
- Cropping images
- Sizing images
- Erasing image areas
- Selecting image areas
- Rectangular Marque tool
- Move tool
- Crop tool
- Size tool
- Channels: an introduction
- Curves: an introduction
- Filters: an introduction
- Group and sequence these topics into books based on information type (reference, guide, or concept).
- Create the following: browse sequence, using the following topics in this project:
- Using layers: Layers: an introduction > Creating layers > Switching layers > Flattening layers
- Cropping images: Rectangular Marque tool > Crop tool > Selecting image areas > Cropping images
Help Indexes
Explain how to do the following:
- Create index "keywords" in the Index Designer.
- Create simple index entries that link to the top of topics.
- Alphabetize index entries.
- Create index subentries (subkeywords) and link them to topics.
- Create bookmarks within longer topics and link index enttries to them.
- Create an index entry that cross-references another index entry (a "See" entry, one that points to a preferred term in the index).
- Create an index entry that cross-references another index entry (a "See also" entry, one that points to additional informaton).
Miscellaneous Help Tasks
Explain how to do the following:
- Specify the default startup topic, meaning the topic that displays when you run the compiled help file.
- Specify the another topic as the default startup.
- Specify a different size and position for the Help window
- Specify a different title for the blue bar at the top edge of the Help window.
Help Formatting
Explain how to do the following:
- Make selected text bold.
- Make selected text italics.
- Center selected text.
- Make selected text a different color.
- Increase or decrease font size of selected text.
- Change font on selected text.
- Use supplied styles on text (for example, Heading 3).
- Create a bulleted list.
- Create a numbered list.
- Force a numbered list to restart at 1.
- Indent selected text.
- Create a three-column, three-row table.
Help Graphics
Explain how to do the following:
- Insert a graphic from the gallery in the middle of a topic.
- Insert another graphic, this time from the RoboHELP La Jolla tutorial: C:\Program Files\RoboHELP Office 9\RoboHTML\Tutorial\LaJolla\cliffs.gif.
- Select the graphic and center it.
- Add a screen tip to a graphic.
- Resize a graphic.
- Cause text to wrap around a graphic that is positioned on the right margin.
- Research and explain what "triggers" and "targets" are all about and how to use them.
- Position a graphic an exact distance from the left margin.
- Place a border around a selected graphic.
- Capture something from the display, crop it, copy and paste it in a a help topic.
Help CSS Styles
Explain how to do the following:
- Apply the existing paragraph styles to text within a Help topic.
- Apply the existing character styles to text within a Help topic.
- Create and name your own style sheet, using the default style sheet.
- Confirm that this style sheet has been created by checking in the project folder.
- Create several customized styles: two for headings, an indented paragraph, some character styles.
- Apply these new styles to text in a help topic.
- Associate your customized style sheet with each new topic.
- Start a new project and import the style sheet you created previously. (There may not be a formal way to do this.)
Context-Sensitive Help
Explain how to do the following:
- Import a map file into help project project.
- Assign a map ID to a help topic.
- Test this context-sensitive help.
- Create a what's-this help for a button or field in a help topic.
- Test a what's-this help.
Copying, Renaming, Importing Help
Explain how to do the following:
- Copy an entire project folder to some other location on your computer.
- Explain any differences in editing, saving, and compiling the project.
- Change the file name and title of an existing topic.
- Rename an entire project.
- Import HTML files from some other project.
- Add a newly imported file to the TOC.
- Import a Word file into a help project.
Converting to and from RoboHelp
Explain how to do the following:
- Create a website from a help project (in RoboHELP, it's called WebHelp).
- Find this help-generated website and view through a web browser
- Use WebWorks ePublisher Pro to convert a Help project to PDF, CHM, or HTML.
Other Help-Authoring Tools
Explain how to do the following for each help-authoring tool we look at:
- Start the application.
- Create several topics.
- Create links between topics.
- Create a TOC.
- Create an index.
- Save and compile.
- Import other files (Word, HTML, other help projects) into a project.
- Generate XML output (when available).
XML to CHM
Explain how to do the following in a help-authoring tool that has XML capability:
- Import an XML file.
- Modify the impported file as necessary.
- Generate a CHM.
Writing about the Procedures
Here are the guidelines for writing about the procedures for this lesson:
- Write these quick-ref notes as briefly as you can but without sacrificing good writing or clarity. Provide enough detail that you could use these notes effectively a year later.
- Write these quick-reference notes "for real": include warnings about potential problems that can trip you up.
- Otherwise, you are not obliged to add a lot of explanatory detail. In "guide" information, you see lots of explanation, definitions, screen shots, and alternative methods. That's not needed or expected here.
- Just use simple lead-ins, numbered and bulleted lists. For notes, use paragraphs introduced by a bolded label such as "Caution:."
- Practice good clear economical writing style. Use imperatives (commands) and second-person ("you"); avoid passive-voice and telegraphic writing styles.
- Use subheadings for the subsections of these quick-reference notes.
Revising
Your instructor will review these quick-reference notes rapidly, requesting revisions if necessary and recording an "ok" in the gradebook when no revisions are needed.
Provided by hcexres@io.com.
|