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.
Subject:Re: Legacy help projects and job openings From:Alexia Prendergast <alexiap -at- SEAGATESOFTWARE -dot- COM> Date:Wed, 20 Aug 1997 14:50:40 -0400
Since several have asked me about the directory structure,
I'll just say that the one Mike and Kim have described for
BMPs is the same one I use for reusable text files.
In SourceSafe, it looks something like this (view using courier or
similarly-spaced font):
\Application
|_DecAlphaNT
|_Help
|_Help
|_WinNT
|_Help
Where:
1. \Application\Help contains the common RTF files and BMPs
2. \Application\DecAlphaNT\Help contains the RTF files and BMPs specific
to that platform,
the HPJ file that references the common and DEC-specific files, and the
MakeHelp.BAT file
that builds the DEC Alpha NT version of the HLP file.
3. \Application\WinNT\Help contains the RTF files and BMPs specific to
that platform,
the HPJ file that references the common and WinNT-specific files, and
the MakeHelp.BAT file
that builds the Win NT version of the HLP file.
HTH,
A.
--
Alexia Prendergast
Senior Technical Writer
Seagate Software mailto:alexiap -at- sems -dot- com
>-----Original Message-----
>From: Wing, Michael J [SMTP:mjwing -at- INGR -dot- COM]
>Sent: Wednesday, August 20, 1997 2:42 PM
>To: TECHWR-L -at- LISTSERV -dot- OKSTATE -dot- EDU
>Subject: Re: Legacy help projects and job openings
>
>> Here's my idea if the text content of the Help will truly be the same
>> in
>> all three versions: Create three bitmap folders, each containing the
>> graphics specific to one version of the interface. Use the same names
>> for the graphics that will display in the same place in the Help; in
>> other words, each folder will have graphics named bitmap01.bmp,
>> bitmap02.bmp, and so on. Then use project setup to point to the
>> correct
>> bitmap folder for the version you want to compile. If you keep all
>> the
>> names the same, you shouldn't have to edit the Help source files at
>> all.
>> I haven't actually tried this myself, but in theory it should work!
>>
>> Kim Cramer
>> mailto:kcramer -at- ncslink -dot- com
>> Sr. Information Developer
>> NCS Education, Mesa AZ
>> *************
>>
>I've done it. It works fine. I was reusing the help for one product in
>another product (that built on top of the first one). The text was fine
>(it described stand-alone modules); however, the hierarchy diagrams
>differed. Therefore, I made a second directory for the hierarchy
>diagrams of the second product. I assigned the same names for each
>substitute diagram and specified the applicable bitmap directory in the
>HPJ files.
>
>Mike Wing
>
>
>Michael Wing (mailto:mjwing -at- ingr -dot- com)
>Principal Technical Writer
>Intergraph Corporation; Huntsville, Alabama
>http://www.ingr.com/iss/products/mapping/
>(205) 730-7250
>
>"But examine everything carefully; hold fast to that which is good"
>-- Paul (1 TH 5:21)
>
> TECHWR-L (Technical Communication) List Information: To send a message
>to 2500+ readers, e-mail to TECHWR-L -at- LISTSERV -dot- OKSTATE -dot- EDU -dot- Send commands
> to LISTSERV -at- LISTSERV -dot- OKSTATE -dot- EDU (e.g. HELP or SIGNOFF TECHWR-L).
> Search the archives at http://www.documentation.com/ or search and
>browse the archives at http://listserv.okstate.edu/archives/techwr-l.html
TECHWR-L (Technical Communication) List Information: To send a message
to 2500+ readers, e-mail to TECHWR-L -at- LISTSERV -dot- OKSTATE -dot- EDU -dot- Send commands
to LISTSERV -at- LISTSERV -dot- OKSTATE -dot- EDU (e.g. HELP or SIGNOFF TECHWR-L).
Search the archives at http://www.documentation.com/ or search and
browse the archives at http://listserv.okstate.edu/archives/techwr-l.html