TechWhirl (TECHWR-L) is a resource for technical writing and technical communications professionals of all experience levels and in all industries to share their experiences and acquire information.
For two decades, technical communicators have turned to TechWhirl to ask and answer questions about the always-changing world of technical communications, such as tools, skills, career paths, methodologies, and emerging industries. The TechWhirl Archives and magazine, created for, by and about technical writers, offer a wealth of knowledge to everyone with an interest in any aspect of technical communications.
Separate HTML files with link to each other vs One big HTML file with drop-down and expanding hotspots
Subject:Separate HTML files with link to each other vs One big HTML file with drop-down and expanding hotspots From:"Justin Cascio" <justin-paul -dot- geo -at- yahoo -dot- com> To:"TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com> Date:Tue, 4 Apr 2000 18:01:16 -0400
Esther Asham asked:
I need advice on structuring the files.
* Whether to create separate HTML files for each
sub-topic and link them together
or
* Create a huge HTML file with expanding and drop-down
hotspots for every sub-topic
or
* Another approach altogether.
Also I will be switching from RoboHelp HTML edition to
RoboHelp 2000, should I expect any problems or be
watchful for anything during the transition?
My answers:
Definitely use many small files vs. a few large ones. The studies I've heard
about suggest people don't like scrolling, and it also reduces load time. If
you don't control what browser and environment your users have, I don't
recommend popups, because they function differently in different browsers,
and sometimes they just don't work. If you make reference jumps, such as for
definitions of words, I'd suggest putting a link on them that says something
like, "Back to topic" and jumps them right back where they were, or suggest
they use the Back button in the browser.
In addition, for legacy purposes, I'd recommend grouping your small files
into subfolders in some logical way. RoboHELP 200 HTML is very good for
keeping your links from breaking, so you can freely move and rename files
within the program.
My other general suggestions are to not use the dynamic HTML functions, as
they add flashy stuff that sometimes doesn't work as you'd like and is
nearly impossible to fix, and that if you use the glossary feature, you get
your glossary definitions finalized before making the links in topics,
because the popups they generate are not dynamic. That is, if you create a
popup in a topic to a glossary definition, and then change the glossary
definition, you have to redo the popup so your change is reflected.
I've never made the switch you're talking about, so I can't offer any useful
suggestions there. However, I've worked extensively with RoboHELP's HTML
program and with HTML, so I can offer you more advice if you write to me
offlist.
Justin Cascio
Pro-Logic & Adjustable Choke
Outsource Documentation and Online Help
justin -at- plandac -dot- com http://www.plandac.com
sarchasm The gulf between the author of sarcastic wit and the person who
doesn't get it.