cde/programs/dthelp/dthelpgen/nlsMsgChk.txt

   1 # $XConsortium: nlsMsgChk.txt /main/2 1996/11/11 11:28:27 drk $
   2 helpgen is a non-Motif (terminal based) application. It creates three files,
   3 <filename>.hv, <filename>00.ht and <filename>01.ht in the target directory.
   4 The default target directory is '/usr/dt/help/<language>/Browser'. The
   5 default <filename> is 'browser'.
   6
   7 1)  To get the usage message, type
   8         helpgen -help
   9
  10     tests message:
  11         Set 1  _DtMessage: 1
  12
  13 2)  Specify a name using the -dir option that is not a directory. To do
  14     this, create a file in the /tmp directory, then use it as if it were
  15     a directory. For example, type:
  16
  17         touch /tmp/testdir
  18         helpgen -dir /tmp/testdir/testfile
  19
  20     Remove /tmp/testdir when finished.
  21
  22     tests message:
  23         Set 1  _DtMessage: 2
  24
  25 3)  Attempt to write to a directory that only the super-user (system
  26     administrator)  has permission to write to. To do this, check that
  27     the directory /usr/vhelp/help exists and that write permission is
  28     denied for the average user. For example, type:
  29
  30         ll -d /usr/vhelp/help.
  31
  32     If the permission shown do not allow the average user access, continue.
  33     Otherwise, change them to disallow access or create and/or use another
  34     directory that does not allow the average user access.
  35
  36     Upon finding a suitable directory for testing, type the following (this
  37     example assumes /usr/vhelp/help is being used):
  38
  39         helpgen -dir /usr/vhelp/help/testdir.
  40
  41     tests message:
  42         Set 1  _DtMessage: 3
  43
  44 4)  Specify a name using the -dir option that is not a directory. To do
  45     this, create a file in the /tmp directory, then use it as if it were
  46     a directory. For example, type:
  47
  48         touch /tmp/testdir
  49         helpgen -dir /tmp/testdir
  50
  51     Remove /tmp/testdir when finished.
  52
  53     tests message:
  54         Set 1  _DtMessage: 6
  55
  56 5)  Attempt to overwrite an existing read-only browser volume. To do this,
  57     check the permissions on the files in the directory
  58     /usr/dt/help/C/Browser. If the permissions allow the average user
  59     to access these files, change the permissions to allow only the
  60     super-user access. Type:
  61
  62         helpgen
  63
  64     tests message:
  65         Set 1  _DtMessage: 8
  66
  67 6)  Create a browser volume in a read-only directory. To do this, create
  68     a directory without write permission. For example, type:
  69
  70         mkdir /tmp/testdir
  71         chmod -w /tmp/testdir
  72
  73     Now use the read-only directory as the parameter to the -dir option:
  74
  75         helpgen -dir /tmp/testdir
  76
  77     Remove /tmp/testdir when finished.
  78
  79     tests message:
  80         Set 1  _DtMessage: 9
  81
  82 7)  Copy a family file to a work directory. Edit the file and remove
  83     the 'title' resource from the file. Symbolically link this file
  84     to the directory /usr/vhelp/families/<language>. Type:
  85
  86         helpgen -dir /tmp
  87
  88     Remove the symbolic link in /usr/vhelp/families/<language> and
  89     the browser volumes in /tmp when done.
  90
  91     tests message:
  92         Set 1  _DtMessage: 11
  93
  94 8)  Copy a family file to a work directory. Edit the file and remove
  95     the 'abstract' resource from the file. Symbolically link this file
  96     to the directory /usr/vhelp/families/<language>. Type:
  97
  98         helpgen -dir /tmp
  99
 100     Remove the symbolic link in /usr/vhelp/families/<language> and
 101     the browser volumes in /tmp when done.
 102
 103     tests message:
 104         Set 1  _DtMessage: 12
 105
 106 9)  Copy a family file to a work directory. Edit the file and remove
 107     the 'volumes' resource from the file. Symbolically link this file
 108     to the directory /usr/vhelp/families/<language>. Type:
 109
 110         helpgen -dir /tmp
 111
 112     Remove the symbolic link in /usr/vhelp/families/<language> and
 113     the browser volumes in /tmp when done.
 114
 115     tests message:
 116         Set 1  _DtMessage: 13
 117
 118 10) Copy a family file to a work directory. Edit the file and remove
 119     the 'charSet' resource from the file. Symbolically link this file
 120     to the directory /usr/vhelp/families/<language>. Type:
 121
 122         helpgen -dir /tmp
 123
 124     Remove the symbolic link in /usr/vhelp/families/<language> and
 125     the browser volumes in /tmp when done.
 126
 127     tests message:
 128         Set 1  _DtMessage: 14
 129
 130 11) Move the directory /usr/vhelp/familes to /usr/vhelp/familes.save.
 131     NOTE: This requires the user to be super-user.
 132     Type:
 133
 134         helpgen -dir /tmp
 135
 136     Restore the families directory by moving /usr/vhelp/families.save
 137     to /usr/vhelp/families.
 138
 139     tests message:
 140         Set 1  _DtMessage: 16
 141
 142 12) Move the directory /usr/vhelp/volumes to /usr/vhelp/volumes.save.
 143     NOTE: This requires the user to be super-user.
 144     Type:
 145
 146         helpgen -dir /tmp
 147
 148     Restore the families directory by moving /usr/vhelp/volumes.save
 149     to /usr/vhelp/volumes.
 150
 151     tests message:
 152         Set 1  _DtMessage: 17
 153
 154 13) Run helpgen as super-user. Run helpview. The application helpview,
 155     can either be run from a terminal window or by selecting the icon on
 156     the front panel showing books with a question mark over them. The
 157     window that displays should show the browser volume created by helpgen.
 158
 159     The text localized in set 2 messages 2 through 4 should be displayed
 160     at the top of the window. The text between the <ABBREV> tags in
 161     set 2 message 3 will be displayed in the topic hierarchy. The last
 162     hypertext link (underlined titles) should be from set 2 message 5.
 163
 164     The text will use the fonts associated with the character set
 165     specified in set 2 message 1. Check that the app-defaults file
 166     for helpview contains a font set associated with the character
 167     set specified.
 168
 169     tests messages:
 170         Set 2  Messages: 1-5
 171         Set 3  Messages: 1-7
 172