From fc.hp.com!stroyan Fri Jan 20 16:23:05 1995
Path: fc.hp.com!stroyan
From: stroyan@fc.hp.com (Mike Stroyan)
Newsgroups: hp.windows.vue
Subject: Re: HowDoIMakeAVueHelpFile
Date: 8 Nov 1994 02:13:29 GMT
Organization: Hewlett-Packard Fort Collins Site
Lines: 161
Message-ID: <39mms9$a1q@tadpole.fc.hp.com>
References: <39mgma$bin@hpscit.sc.hp.com>
NNTP-Posting-Host: hpstryn.fc.hp.com
X-Newsreader: TIN [version 1.2 PL1.4]

David Epperly (epp@hpapcfla.nsr.hp.com) wrote:
|I want to make a simple vue helpfile.
|I want to put an index entry at a fairly high level and have it
|bring up some straight ascii text, no formatting -- and that is all.

|Is this simple?  Can someone tell me how to do it in 50 words or less?

  It isn't too difficult.  I can't tell you how to do it in 50 words or
less unless I am allowed to say "Read the HP Help System, Version 3.0
help volume."  Here is a trivial example that might be enough to get
you started.  Note that this has three different kinds of "index"-
a table of contents, a list of links, and a keyword index.  It also
shows three types of quoting that you might want to use.  Which you
will want depends on how your "straight ascii text" is formatted.

  You can view this example by running make.

--
Mike Stroyan, mike_stroyan@fc.hp.com


# This is a shell archive.  Remove anything before this line,
# then unpack it by saving it in a file and typing "sh file".
#
# Wrapped by Mike Stroyan <stroyan@hpstryn> on Mon Nov  7 19:13:57 1994
#
# This archive contains:
#	Makefile	simple.htg	
#

LANG=""; export LANG
PATH=/bin:/usr/bin:$PATH; export PATH

echo x - Makefile
cat >Makefile <<'@EOF'
all: view

simple.hv: clean simple.htg
	PATH=$(PATH):/usr/vhelp/bin helptag simple.htg

clean:
	PATH=$(PATH):/usr/vhelp/bin helptag -clean simple.htg

view: simple.hv
	PATH=$(PATH):/usr/vhelp/bin helpview -helpVolume simple.hv
@EOF

chmod 644 Makefile

echo x - simple.htg
cat >simple.htg <<'@EOF'
<metainfo>

 <title> A simple help volume
 <copyright>

       copyright me, 1994

 <abstract> This is a simple example.

<\metainfo>       

<hometopic> The Table Of Contents
 Welcome to the table of contents.
 <list>
 * <xref chapter1>
  <list>
  * <xref section1.1>
   <list>
   * <xref section1.1.1>
   <\list>
  <\list>
 * <xref chapter2>
  <list>
  * <xref section2.1>
   <list>
   * <xref section2.1.1>
   <\list>
  <\list>
 <\list>

 This is a same-page link to <link example>example<\link> formatting.
 This is a same-page link to <link verbatim>verbatim example <\link> formatting.
 This is a same-page link to <link image>image<\link> formatting.

 <location id=example>
 <\location>
 <ex>
 This is 'example' formatting.


 #####     ##    #    #  #    #  ######  #####
 #    #   #  #   ##   #  ##   #  #       #    #
 #####   #    #  # #  #  # #  #  #####   #    #
 #    #  ######  #  # #  #  # #  #       #####
 #    #  #    #  #   ##  #   ##  #       #   #
 #####   #    #  #    #  #    #  ######  #    #

 It preserves line breaks ...    and spacing.
 <\ex>

 <location id=verbatim>
 <\location>
 <vex>
 This is 'verbatim example' formatting.

 #####     ##    #    #  #    #  ######  #####
 #    #   #  #   ##   #  ##   #  #       #    #
 #####   #    #  # #  #  # #  #  #####   #    #
 #    #  ######  #  # #  #  # #  #       #####
 #    #  #    #  #   ##  #   ##  #       #   #
 #####   #    #  #    #  #    #  ######  #    #

 It preserves line breaks ...    and spacing.
 It also avoids interpreting almost anything as helptag directives.
 <\vex>

 <location id=image>
 <\location>
 <image>
 This is 'image' formatting.

 #####     ##    #    #  #    #  ######  #####
 #    #   #  #   ##   #  ##   #  #       #    #
 #####   #    #  # #  #  # #  #  #####   #    #
 #    #  ######  #  # #  #  # #  #       #####
 #    #  #    #  #   ##  #   ##  #       #   #
 #####   #    #  #    #  #    #  ######  #    #

 It preserves line breaks ...    and spacing.
 But it uses a proportional font that can mess up alignments.
 <\image>

<chapter id=chapter1> Chapter one
 <idx|chapters|
 This is a chapter style entry.

<s1 id=section1.1> Section 1.1
 <idx|sections|
 This is a level one section entry.
 It can refer to subsections like <xref section1.1.1>.
 <s2 id=section1.1.1> Section 1.1.1
 <idx|sections|
 This is a level two section entry.

<chapter id=chapter2> Chapter two
 <idx|chapters|
 This is a chapter style entry.

<s1 id=section2.1> Section 2.1
 <idx|sections|
 This is a level one section entry.
 It can refer to subsections like <xref section2.1.1>.
 <s2 id=section2.1.1> Section 2.1.1
 <idx|sections|
 This is a level two section entry.
@EOF

chmod 644 simple.htg

exit 0