| 1 | :userdoc.
|
|---|
| 2 | :docprof toc=123456.
|
|---|
| 3 | :title.NewView Help
|
|---|
| 4 | .* ************************************************************
|
|---|
| 5 | .* Subject: Help for NewView
|
|---|
| 6 | .* Version:
|
|---|
| 7 | .* Copyright: Copyright 2004 Aaron Lawrence
|
|---|
| 8 | .* Copyright: Copyright 2006-2007 Ronald Brill
|
|---|
| 9 | .* Author: Aaron Lawrence
|
|---|
| 10 | .* ************************************************************
|
|---|
| 11 | .*
|
|---|
| 12 | .*
|
|---|
| 13 | .* ************************************************************
|
|---|
| 14 | .* Introduction
|
|---|
| 15 | .* ************************************************************
|
|---|
| 16 | :h1 res=30000 id='Introduction'.Introduction
|
|---|
| 17 | :i1 id=30001.support
|
|---|
| 18 | :p.:artwork runin name='images\NewView.bmp'.
|
|---|
| 19 | :hp2.Welcome to NewView&xclm.:ehp2.
|
|---|
| 20 | :p.
|
|---|
| 21 | :p.NewView is a program for reading OS&slash.2 &lpar.or eComStation&rpar. Help
|
|---|
| 22 | Files&per.
|
|---|
| 23 | :p.:link reftype=hd refid='Support'.Support and Licensing:elink.
|
|---|
| 24 | :p.:link reftype=hd refid='Using'.Using NewView:elink.
|
|---|
| 25 | :p.:hp1.To stop this file appearing when you start NewView without specifying a
|
|---|
| 26 | help file&comma. see Tools &endash. Options &endash. General tab&per.:ehp1.
|
|---|
| 27 | :p.:hp2.History:ehp2.
|
|---|
| 28 | :p.NewView replaces the original IBM program supplied with OS&slash.2&per.
|
|---|
| 29 | :p.It improves upon many aspects of View&comma. with a modern&comma. easy to use
|
|---|
| 30 | interface&comma. more options&comma. and new features that View simply
|
|---|
| 31 | didn&apos.t have&per.
|
|---|
| 32 | :p.
|
|---|
| 33 | .* ************************************************************
|
|---|
| 34 | .* Support and Licensing
|
|---|
| 35 | .* ************************************************************
|
|---|
| 36 | :h2 res=1 id='Support'.
|
|---|
| 37 | Support and Licensing
|
|---|
| 38 | :i1 id=30002.license
|
|---|
| 39 | :i2 refid=30001.Support and Licensing
|
|---|
| 40 | :i2 refid=30001.Introduction
|
|---|
| 41 | :i1 id=30003.bugs
|
|---|
| 42 | :i1 id=30004.source code
|
|---|
| 43 | :p.:hp2.Support and Licensing:ehp2.
|
|---|
| 44 | :p.
|
|---|
| 45 | :p.NewView is Copyright 1999&endash.2006 Aaron Lawrence&per. It is also licensed
|
|---|
| 46 | under the GNU Public License&comma. which means you have the right to obtain the
|
|---|
| 47 | source code&per.
|
|---|
| 48 | :p.Since 2006 Ronald Brill maintains the product&per.
|
|---|
| 49 | .br
|
|---|
| 50 | NewView is a Netlabs project&per.
|
|---|
| 51 | :p.See the Readme&per.txt for more technical details&per.
|
|---|
| 52 | :p.See the Changes&per.txt file for a history of changes to NewView&per.
|
|---|
| 53 | :p.If you find NewView helpful&comma. please email me and&slash.or make a
|
|---|
| 54 | donation to support further development&per. It&apos.s nice to hear from
|
|---|
| 55 | you&xclm.
|
|---|
| 56 | :ul.
|
|---|
| 57 | :li.Suggestions&comma. compliments or bug reports http&colon.&slash.&slash.svn&per.netlabs&per.org&slash.newview
|
|---|
| 58 | :li.Translate NewView to your language&per.
|
|---|
| 59 | :li.A donation to Netlabs http&colon.&slash.&slash.www&per.mensys&per.nl
|
|---|
| 60 | :eul.
|
|---|
| 61 | :p.:hp2.Reporting Bugs:ehp2.
|
|---|
| 62 | :p.If you need to report a crash or other problem&comma. then be as specific as
|
|---|
| 63 | possible about what files were being used&comma. what you were doing&comma.
|
|---|
| 64 | etc&per. If one is available&comma. PLEASE include the newview&per.log&per. The
|
|---|
| 65 | log file will be EITHER
|
|---|
| 66 | .br
|
|---|
| 67 | &endash. in the same directory as NewView itself
|
|---|
| 68 | .br
|
|---|
| 69 | &endash. in the folder set by LOGFILES environment variable &lpar.typically eCS
|
|---|
| 70 | 1&per.1&plus.&rpar.
|
|---|
| 71 | .br
|
|---|
| 72 | If it is specific to a particular help file&comma. then send them to me&comma.
|
|---|
| 73 | unless they&apos.re large &lpar.bigger than 1MB&rpar.&per.
|
|---|
| 74 | :p.Most of the following information is in the newview&per.log file&comma. but
|
|---|
| 75 | it would be helpful if you could include it for verification&colon.
|
|---|
| 76 | :ul.
|
|---|
| 77 | :li.NewView version &lpar.Help &endash. Product Information&rpar.
|
|---|
| 78 | :li.The filenames of the help files&per.
|
|---|
| 79 | :li.A screenshot may be useful&comma. if the problem is an incorrect or corrupt
|
|---|
| 80 | display&per.
|
|---|
| 81 | :eul.
|
|---|
| 82 | :p.:hp2.Why doesn&apos.t my help file work properly?:ehp2.
|
|---|
| 83 | :p.Some of the less used features of the original View program are not
|
|---|
| 84 | implemented&per. This is either because I have not got around to it&comma. or
|
|---|
| 85 | because they are simply not worth the time&per. Examples include
|
|---|
| 86 | metafiles&comma. index synonyms&comma. the entire application control API&comma.
|
|---|
| 87 | and so on&per.
|
|---|
| 88 | :p.Unfortunately&comma. it seems that at least one developer has used every one
|
|---|
| 89 | of these features&comma. so you may find an occasional file that doesn&apos.t
|
|---|
| 90 | load or doesn&apos.t work properly&per.
|
|---|
| 91 | .*
|
|---|
| 92 | .*
|
|---|
| 93 | .* ************************************************************
|
|---|
| 94 | .* Using NewView
|
|---|
| 95 | .* ************************************************************
|
|---|
| 96 | :h1 res=2 id='Using'.
|
|---|
| 97 | Using NewView
|
|---|
| 98 | :p.:hp2.Using NewView:ehp2.
|
|---|
| 99 | :p.Once you have :link reftype=hd refid='OpeningFiles'.opened a
|
|---|
| 100 | file:elink.&comma. you can read it in various ways&per.
|
|---|
| 101 | :p.You can read the :link reftype=hd refid='contents'.table of
|
|---|
| 102 | contents:elink.&comma. use the :link reftype=hd refid='Index'.alphabetical
|
|---|
| 103 | index:elink.&comma. or :link reftype=hd refid='search'.search:elink.&per.
|
|---|
| 104 | :p.To simply read the help file like a paper book&comma. use the &odq.Previous&cdq.
|
|---|
| 105 | :artwork runin name='images\previous.bmp'.
|
|---|
| 106 | and &odq.Next&Cdq.
|
|---|
| 107 | :artwork runin name='images\next.bmp'.
|
|---|
| 108 | buttons to work your way through all the topics&per.
|
|---|
| 109 | :p.You can also use the help file like web pages&comma. using &odq.Back&cdq.
|
|---|
| 110 | :artwork runin name='images\back.bmp'.
|
|---|
| 111 | and &odq.Forward&cdq.
|
|---|
| 112 | :artwork runin name='images\forward.bmp'.
|
|---|
| 113 | buttons to go back to wherever you were before&comma. or to retread your
|
|---|
| 114 | steps&per.
|
|---|
| 115 | :p.Colours and some of the behaviour of NewView can be adjusted from the Tools
|
|---|
| 116 | &endash. Options menu&per.
|
|---|
| 117 | :p.You can also :link reftype=hd refid='notes'.annotate:elink. or :link
|
|---|
| 118 | reftype=hd refid='bookmarks'.bookmark:elink. topics&per.
|
|---|
| 119 | .*
|
|---|
| 120 | .*
|
|---|
| 121 | .* ************************************************************
|
|---|
| 122 | .* Opening Help File
|
|---|
| 123 | .* ************************************************************
|
|---|
| 124 | :h1 res=3 id='OpeningFiles'.
|
|---|
| 125 | Opening Files
|
|---|
| 126 | :i1 id=30005.open
|
|---|
| 127 | :p.:hp2.Opening Help Files:ehp2.
|
|---|
| 128 | :p.
|
|---|
| 129 | :p.To open a help file&comma. you can use any of the following&colon.
|
|---|
| 130 | :p.&endash. Double&endash.click a :link reftype=hd refid='HelpIcons'.help
|
|---|
| 131 | icon:elink. that is already set up
|
|---|
| 132 | :p.&endash. Type &odq.view :hp1.filename:ehp1.&cdq. from the :link reftype=hd
|
|---|
| 133 | refid='CommandLine'.command line:elink.
|
|---|
| 134 | :p.&endash. Click the Open button
|
|---|
| 135 | :artwork runin name='images\open.bmp'.
|
|---|
| 136 | from within NewView
|
|---|
| 137 | :p.&endash. Reload a recently viewed file from the &odq.File&cdq. menu
|
|---|
| 138 | :p.&endash. Drag and drop a Help file from the desktop
|
|---|
| 139 | :p.Once the file is loaded&comma. you should see the :link reftype=hd
|
|---|
| 140 | refid='contents'.table of contents:elink. and the first topic&per.
|
|---|
| 141 | :note text='Note:'.This assumes you installed NewView as a replacement
|
|---|
| 142 | for original View&per. If you didn&apos.t then existing help icons and the
|
|---|
| 143 | command line may behave differently&per.
|
|---|
| 144 | :p.:hp2.Loading Multiple Files Together:ehp2.
|
|---|
| 145 | :p.NewView can load multiple files at once&comma. presenting them as if they
|
|---|
| 146 | were one book&comma. and read environment variables for filenames&per.
|
|---|
| 147 | :p.For example&comma. with the OS&slash.2 Developer&apos.s Toolkit
|
|---|
| 148 | documentation&colon.
|
|---|
| 149 | .br
|
|---|
| 150 | NewView cpref
|
|---|
| 151 | .br
|
|---|
| 152 | loads the &odq.Control Program Guide and Reference&cdq.&per. CPREF is an environment
|
|---|
| 153 | variable set in config&per.sys&comma. consisting of &odq.CP1&plus.CP2&plus.CP3&cdq.
|
|---|
| 154 | which tells NewView &lpar.or View&rpar. to load the help files CP1&comma. CP2
|
|---|
| 155 | and CP3&per. The files are searched for in the path specified by two :link
|
|---|
| 156 | reftype=hd refid='L_EnvironmentVariables'.environment
|
|---|
| 157 | variables:elink.&per.&asterisk.
|
|---|
| 158 | :p.The files are all loaded and effectively appended to each other&per.
|
|---|
| 159 | :p.Being able to load multiple files like this can be helpful for various
|
|---|
| 160 | reasons&per. For example&comma. 4OS&slash.2 &lpar.a CMD&per.EXE
|
|---|
| 161 | replacement&rpar. uses it to add it&apos.s own help on top of the original CMD
|
|---|
| 162 | help&per. You can do it yourself with any files you like&per.
|
|---|
| 163 | :p.You can load multiple files in the Open File dialog by using Ctrl or Shift to
|
|---|
| 164 | select multiple files&per.
|
|---|
| 165 | :p.When you click a link to a different help file&comma. NewView loads the other
|
|---|
| 166 | file without closing your current files&per.
|
|---|
| 167 | :p.At any time&comma. you can find out what files are open by using File
|
|---|
| 168 | &endash. Information&per.
|
|---|
| 169 | :p.:hp2.Loading Additional Files:ehp2.
|
|---|
| 170 | :p.You can tick the &odq.Keep current files open&cdq. checkbox in the Open File
|
|---|
| 171 | dialog&comma. and NewView will open the files you have selected without closing
|
|---|
| 172 | the currently opened files&per.
|
|---|
| 173 | :p.:hp2.Drag and Drop:ehp2.
|
|---|
| 174 | :p.You can drag and drop &per.INF or &per.HLP files onto NewView and they will
|
|---|
| 175 | be opened&per. If you hold down the Shift key&comma. they will be opened without
|
|---|
| 176 | closing the current files&per.
|
|---|
| 177 | :p.You can drop files onto any of the main content areas&comma. such as the
|
|---|
| 178 | Contents or Index windows&comma. or an existing topic window&per.
|
|---|
| 179 | :note text='Note:'.Some links that go across files&comma. will only work if the correct set of
|
|---|
| 180 | files is loaded&per.
|
|---|
| 181 | .* ************************************************************
|
|---|
| 182 | .* Help Icons
|
|---|
| 183 | .* ************************************************************
|
|---|
| 184 | :h2 res=17 id='HelpIcons'.
|
|---|
| 185 | Help Icons
|
|---|
| 186 | :p.:hp2.Help Icons:ehp2.
|
|---|
| 187 | :p.Help Icons on the desktop are usually &odq.program objects&cdq. with the program name
|
|---|
| 188 | set to &odq.view&per.exe&cdq. and the parameters set to the name of the help files&per.
|
|---|
| 189 | :p.Some programs create these icons automatically at install time&per.
|
|---|
| 190 | :p.You can create these icons yourself by using the desktop program
|
|---|
| 191 | template&per. See desktop help for more information&per.
|
|---|
| 192 | :p.If you create icons by dragging help files to the desktop&comma. then you
|
|---|
| 193 | cannot give them a meaningful title&comma. because that would change the name of
|
|---|
| 194 | the file&comma. which might prevent programs from finding the help file&per.
|
|---|
| 195 | Therefore program objects are currently the recommended means of creating help
|
|---|
| 196 | icons&per.
|
|---|
| 197 | .*
|
|---|
| 198 | .*
|
|---|
| 199 | .* ************************************************************
|
|---|
| 200 | .* Navigation Panel Tabs
|
|---|
| 201 | .* ************************************************************
|
|---|
| 202 | :h1 res=200 id='NavigationPanel'.
|
|---|
| 203 | Navigation Panel Tabs
|
|---|
| 204 | :p.:hp2.Navigation Panel Tabs:ehp2.
|
|---|
| 205 | :p.The left hand panel contains several tabs for moving through the current help
|
|---|
| 206 | file in different ways&per.
|
|---|
| 207 | :p.:link reftype=hd refid='contents'.Contents:elink.
|
|---|
| 208 | :p.:link reftype=hd refid='Index'.Index:elink.
|
|---|
| 209 | :p.:link reftype=hd refid='search'.Search:elink.
|
|---|
| 210 | :p.:link reftype=hd refid='notes'.Notes:elink.
|
|---|
| 211 | :p.You can turn this panel off to get more space&comma. with the button
|
|---|
| 212 | :artwork runin name='images\navigator.bmp'. or by selecting View
|
|---|
| 213 | &endash. Show Left Panel from the menu&comma. or pressing Alt&plus.P&per. Do the
|
|---|
| 214 | same to turn it on again&per.
|
|---|
| 215 | :p.You can stop the navigation panel from appearing when a help file is opened
|
|---|
| 216 | in Tools &endash. Options &endash. General tab&per.
|
|---|
| 217 | :note text='Note:'.Many programs choose to show the table of contents
|
|---|
| 218 | when they open their help file&semi. in this case&comma. the panel is
|
|---|
| 219 | automatically shown&comma. overriding your setting&per.
|
|---|
| 220 | .* ************************************************************
|
|---|
| 221 | .* Contents View
|
|---|
| 222 | .* ************************************************************
|
|---|
| 223 | :h2 res=4 id='contents'.
|
|---|
| 224 | Contents View
|
|---|
| 225 | :i1 id=30006.Table of Contents
|
|---|
| 226 | :p.:hp2.Table of Contents:ehp2.
|
|---|
| 227 | :p.
|
|---|
| 228 | :p.Most help files have a table of contents that shows you the topics in the
|
|---|
| 229 | file&comma. in a hierarchy or &odq.tree&cdq.&per. This is usually the first view you see
|
|---|
| 230 | when you open a file&per.
|
|---|
| 231 | :p.You can expand or collapse branches on the tree by clicking the &plus. or
|
|---|
| 232 | &endash. buttons&comma. or using the space bar&per.
|
|---|
| 233 | :p.To view a topic from the contents&comma. just click on it&per. You can also
|
|---|
| 234 | move through the contents by using the arrow keys&per.
|
|---|
| 235 | :p.To move through :hp2.all:ehp2. topics in the contents tree&comma. in
|
|---|
| 236 | order&comma. you can use Ctrl &plus. Up and Ctrl &plus. Down&comma. or the
|
|---|
| 237 | &odq.Previous&cdq.
|
|---|
| 238 | :artwork runin name='images\previous.bmp'.
|
|---|
| 239 | and &odq.Next&cdq.
|
|---|
| 240 | :artwork runin name='images\next.bmp'.
|
|---|
| 241 | buttons&per. This is one way to treat the file as a normal book&comma. reading
|
|---|
| 242 | through each page&per.
|
|---|
| 243 | :p.You can also review the whole table of contents by using &odq.Expand All&cdq. in the
|
|---|
| 244 | &odq.View&cdq. menu&per. This expands all the branches of the contents table so you can
|
|---|
| 245 | quickly look through it&per. However&comma. it&apos.s usually easier to use
|
|---|
| 246 | :link reftype=hd refid='search'.Search:elink. or :link reftype=hd
|
|---|
| 247 | refid='Index'.Index:elink. for this purpose&per.
|
|---|
| 248 | .* ************************************************************
|
|---|
| 249 | .* Index
|
|---|
| 250 | .* ************************************************************
|
|---|
| 251 | :h2 res=5 id='Index'.
|
|---|
| 252 | Index
|
|---|
| 253 | :p.:hp2.About the Index:ehp2.
|
|---|
| 254 | :p.
|
|---|
| 255 | :p.The Index tab contains an alphabetical listing of topics or keywords in the
|
|---|
| 256 | help file&per. You can quickly search through it just by typing the first few
|
|---|
| 257 | characters of the word you want to look up&per. NewView jumps to the first match
|
|---|
| 258 | in the index automatically&per. To view the highlighted topic&comma. press
|
|---|
| 259 | enter&per.
|
|---|
| 260 | :note text='Note:'.
|
|---|
| 261 | :p.Help files may or may not include an &odq.official&cdq. index&per. The index is
|
|---|
| 262 | manually created by the author&comma. so &lpar.for original View&rpar. it&apos.s
|
|---|
| 263 | usefulness is strictly dependent on how much work the author put into it&per.
|
|---|
| 264 | There may not even be one&per.
|
|---|
| 265 | :p.However&comma. a useful index can be provided simply by listing the titles of
|
|---|
| 266 | each topic alphabetically&comma. and this is what NewView does&per. It then
|
|---|
| 267 | merges the original index &lpar.if any&rpar. with the list of topic titles&per.
|
|---|
| 268 | :p.If for some reason you don&apos.t like this&comma. you can turn it off in
|
|---|
| 269 | Tools &endash. Options &endash. Index tab&per.
|
|---|
| 270 | .* ************************************************************
|
|---|
| 271 | .* Search
|
|---|
| 272 | .* ************************************************************
|
|---|
| 273 | :h2 res=6 id='search'.
|
|---|
| 274 | Search
|
|---|
| 275 | :p.:hp2.Searching:ehp2.
|
|---|
| 276 | :p.
|
|---|
| 277 | :p.Searching is a quick way to find information&comma. when you don&apos.t know
|
|---|
| 278 | where to start&per. Simply go to the Search tab&comma. type some related words
|
|---|
| 279 | and click the Search button&per.
|
|---|
| 280 | You&apos.ll see a listing of all topics containing that word&comma. or words
|
|---|
| 281 | like it&comma. with the best matches at the top&per. The best match will be
|
|---|
| 282 | displayed automatically&per.
|
|---|
| 283 | :p.Words that matches your search are highlighted in the topic&per.
|
|---|
| 284 | :p.:hp2.Global search:ehp2.
|
|---|
| 285 | :p.You can also search all help files on your system using the :link reftype=hd
|
|---|
| 286 | refid='GlobalSearch'.global search:elink. in Tools &endash. Search all Help
|
|---|
| 287 | Files&per.
|
|---|
| 288 | :p.:hp2.Phrase search:ehp2.
|
|---|
| 289 | :p.If you want to search for a phrase made up of more than one word&comma. put
|
|---|
| 290 | double quotes around it&comma. for example &odq.os&slash.2 warp&cdq.&per.
|
|---|
| 291 | :p.:hp2.Matching features:ehp2.
|
|---|
| 292 | :p.NewView allows you finer control of searching&per.
|
|---|
| 293 | :p.&plus. indicates a word that :hp2.must:ehp2. be matched
|
|---|
| 294 | :p.&endash. indicates a word that must :hp2.not:ehp2. be matched
|
|---|
| 295 | :p.NewView always does partial word matches&per. That is&comma. if you search
|
|---|
| 296 | for &odq.win&cdq. NewView will also find &odq.window&cdq. and &odq.showing&cdq.&per. However&comma. the
|
|---|
| 297 | better the match is the higher the rank will be&per.
|
|---|
| 298 | :p.:hp2.How NewView ranks results:ehp2.
|
|---|
| 299 | :p.NewView ranks matching topics by various means&colon.
|
|---|
| 300 | :p.&endash. a closer match to a full word
|
|---|
| 301 | :p.&endash. number of matching words in a topic
|
|---|
| 302 | :p.&endash. matches within the title
|
|---|
| 303 | :p.&endash. matches within an index entry
|
|---|
| 304 | .* ************************************************************
|
|---|
| 305 | .* Notes
|
|---|
| 306 | .* ************************************************************
|
|---|
| 307 | :h2 res=7 id='notes'.
|
|---|
| 308 | Notes
|
|---|
| 309 | :p.:hp2.Adding and Using Notes:ehp2.
|
|---|
| 310 | :p.
|
|---|
| 311 | :p.NewView allows you to add notes &lpar.annotations&rpar. to your help
|
|---|
| 312 | files&per.
|
|---|
| 313 | :p.To add a note&comma. simply click where you want to make a note and click the
|
|---|
| 314 | &odq.Note&cdq. button
|
|---|
| 315 | :artwork runin name='images\note.bmp'.
|
|---|
| 316 | &comma. then type your text and click OK&per. The text will be inserted into the
|
|---|
| 317 | help topic with a different color &lpar.default is green&semi. you can change
|
|---|
| 318 | this in Tools &endash. Options &endash. Colors&rpar.&per.
|
|---|
| 319 | :p.To edit or delete a note&comma. click on the colored note text&semi. you can
|
|---|
| 320 | then edit the note text&comma. or click on delete to get rid of it&per.
|
|---|
| 321 | :p.You can also review all the notes that you&apos.ve made in the current help
|
|---|
| 322 | file&lpar.s&rpar. by going to the Notes tab&semi. this allows you to add&comma.
|
|---|
| 323 | edit and delete&comma. and also jump to the topics containing your notes&per.
|
|---|
| 324 | :p.
|
|---|
| 325 | :p.Notes are saved in a file with the extension &per.nte&comma. in the same
|
|---|
| 326 | directory as the help file they are for&per.
|
|---|
| 327 | :note text='Note:'.If a help file is changed &lpar.for example a program is
|
|---|
| 328 | upgraded&rpar. then notes will no longer appear in the correct place&semi.
|
|---|
| 329 | however&comma. you can still read them from the Notes tab&per.
|
|---|
| 330 | .*
|
|---|
| 331 | .*
|
|---|
| 332 | .* ************************************************************
|
|---|
| 333 | .* Global Search
|
|---|
| 334 | .* ************************************************************
|
|---|
| 335 | :h1 res=18 id='GlobalSearch'.
|
|---|
| 336 | Global Search
|
|---|
| 337 | :p.:hp2.Global search:ehp2.
|
|---|
| 338 | :p.You can search all help files on your system&comma. by clicking the Search
|
|---|
| 339 | All button
|
|---|
| 340 | :artwork runin name='images\search.bmp'.
|
|---|
| 341 | &comma. using Tools &endash. Search all Help Files in the menu&comma. or
|
|---|
| 342 | pressing Ctrl&plus.S&per.
|
|---|
| 343 | :p.This search works similarly to :link reftype=hd refid='search'.searching
|
|---|
| 344 | within a file:elink.&comma. but it also tells you what help file the results
|
|---|
| 345 | were found in&per.
|
|---|
| 346 | :p.These searches may take some time&comma. depending on what you search
|
|---|
| 347 | for&per. You can stop the search at any time&per.
|
|---|
| 348 | :p.:hp2.Where NewView searches:ehp2.
|
|---|
| 349 | :p.The default is to search for help files in the help paths&comma. which are
|
|---|
| 350 | specified by the BOOKSHELF and HELP :link reftype=hd
|
|---|
| 351 | refid='L_EnvironmentVariables'.environment variables:elink.&per.
|
|---|
| 352 | :p.You can choose other places to search by choosing from the drop&endash.down
|
|---|
| 353 | list&comma. or customise the list by clicking the Select button&per.
|
|---|
| 354 | :p.:hp2.Search in&colon. Standard Help Paths:ehp2.
|
|---|
| 355 | :p.This is the default and will search BOOKSHELF and HELP as specified
|
|---|
| 356 | above&per.
|
|---|
| 357 | :p.Clicking the select button will allow you to choose which of the directories
|
|---|
| 358 | in the help paths will be used&per. Click each item in the list to select or
|
|---|
| 359 | de&endash.select it&per. After you choose this&comma. the location will show as
|
|---|
| 360 | &odq.Selected Help Paths&cdq.
|
|---|
| 361 | :p.:hp2.Search in&colon. All Hard Drives:ehp2.
|
|---|
| 362 | :p.This option will search all hard &lpar.non&endash.removable&rpar. drives on
|
|---|
| 363 | your system&per. You can click &odq.Select&per.&per.&per.&cdq. to customise the
|
|---|
| 364 | location&per.
|
|---|
| 365 | :p.Searching drives can find more help files&comma. but might be much slower
|
|---|
| 366 | than just the help paths&per.
|
|---|
| 367 | :p.:hp2.Search in&colon. Selected Help Paths:ehp2.
|
|---|
| 368 | :p.If you have already selected particular help paths to search&per.&comma. you can
|
|---|
| 369 | click &odq.Select&per.&per.&per.&cdq. to customise again&per.
|
|---|
| 370 | :p.:hp2.Search in&colon. Directory List:ehp2.
|
|---|
| 371 | :p.In the &odq.Select Directories&cdq. dialog&comma. clicking the &odq.Add&per.&per.&per.&cdq.
|
|---|
| 372 | button will allow you to add one or more directories to the search list&per.
|
|---|
| 373 | :p.Select the drive and directory using the controls that appear&comma. then
|
|---|
| 374 | click &odq.<. Add Directory&cdq. to add the chosen directory&per. You can do this as
|
|---|
| 375 | many times as you like&per. Choose &odq.With sub&endash.directories&cdq. if you want
|
|---|
| 376 | sub&endash.directories of the selected directory to be searched as well&per. In
|
|---|
| 377 | this case&comma. &per.&per.&per. will show on the end of the directory&per.
|
|---|
| 378 | :p.After you add a custom directory like this&comma. the location for searching
|
|---|
| 379 | will show as &odq.Directory List&cdq.&per.
|
|---|
| 380 | :note text='Note:'.If you add a custom directory to standard or selected help
|
|---|
| 381 | paths&comma. then the list will become a custom list&comma. and you can no
|
|---|
| 382 | longer re&endash.select help paths&per. To get back to the original help
|
|---|
| 383 | paths&comma. choose &odq.Standard Help Paths&cdq. then click &odq.Select&per.&per.&per.&cdq.
|
|---|
| 384 | again&per.
|
|---|
| 385 | :p.:hp2.Search in&colon. Typing a location:ehp2.
|
|---|
| 386 | :p.You can type a drive or directory into the &odq.Search in&colon.&cdq. entry
|
|---|
| 387 | field&per. Add &odq.&per.&per.&per.&cdq. on the end of the directory if you want to
|
|---|
| 388 | search subdirectories as well&per.
|
|---|
| 389 | :p.Example&colon.
|
|---|
| 390 | :p. Search in&colon. &lbracket. E&colon.&bsl.mydocs&bsl.&per.&per.&per.
|
|---|
| 391 | &rbracket.
|
|---|
| 392 | :p.This will search help files in E&colon.&bsl.mydocs&bsl. and any
|
|---|
| 393 | subdirectories&per.
|
|---|
| 394 | .*
|
|---|
| 395 | .*
|
|---|
| 396 | .* ************************************************************
|
|---|
| 397 | .* Bookmarks
|
|---|
| 398 | .* ************************************************************
|
|---|
| 399 | :h1 res=8 id='bookmarks'.
|
|---|
| 400 | Bookmarks
|
|---|
| 401 | :p.:hp2.Bookmarks:ehp2.
|
|---|
| 402 | :p.
|
|---|
| 403 | :p.NewView allows you to bookmark particular topics within the current help
|
|---|
| 404 | file&per. Simply click the bookmark button
|
|---|
| 405 | :artwork runin name='images\bookmark.bmp'.
|
|---|
| 406 | to add the current topic as a bookmark&per.
|
|---|
| 407 | :p.To jump to a bookmark&comma. go to the &odq.Bookmarks&cdq. menu&comma. and click on
|
|---|
| 408 | the bookmark you want to open&per.
|
|---|
| 409 | :p.You can view or delete all your bookmarks by clicking on &odq.Edit&per.&per.&cdq. in
|
|---|
| 410 | the &odq.Bookmarks&cdq. menu&per. This window can remain open while you read&comma. so
|
|---|
| 411 | that you can quickly look through your bookmarks&per.
|
|---|
| 412 | :p.
|
|---|
| 413 | :note text='Note:'.
|
|---|
| 414 | :p.NewView bookmarks remember all the topic windows that are open&comma. if
|
|---|
| 415 | there is more than one&per.
|
|---|
| 416 | :p.Bookmarks are saved in a file with the extension &per.bmk&comma. in the same
|
|---|
| 417 | directory as the help file they are for&per.
|
|---|
| 418 | .*
|
|---|
| 419 | .*
|
|---|
| 420 | .* ************************************************************
|
|---|
| 421 | .* Internet Links
|
|---|
| 422 | .* ************************************************************
|
|---|
| 423 | :h1 res=100 id='InternetLinks'.
|
|---|
| 424 | Internet Links
|
|---|
| 425 | :p.:hp2.Internet Links:ehp2.
|
|---|
| 426 | :p.When you click a web URL like
|
|---|
| 427 | http&colon.&slash.&slash.www&per.google&per.com&comma. NewView launches your
|
|---|
| 428 | default web browser&per.
|
|---|
| 429 | :p.This web browser is specified by operating system settings&comma. not NewView
|
|---|
| 430 | itself&per. To configure it&comma. you can open a URL object on the
|
|---|
| 431 | desktop&comma. edit the browser path in the :hp2.Browser:ehp2. tab&comma. then
|
|---|
| 432 | click Set Default&per. Alternatively&comma. download the utility ConfigApps from
|
|---|
| 433 | Hobbes
|
|---|
| 434 | :p.
|
|---|
| 435 | http&colon.&slash.&slash.hobbes&per.nmsu&per.edu&slash.cgi&endash.bin&slash.h&endash.search?key&eq.configapps
|
|---|
| 436 | .br
|
|---|
| 437 | :p.Browsers may also have the ability to make themselves the default&comma.
|
|---|
| 438 | either at install time or in preferences&per.
|
|---|
| 439 | :p.Email&comma. Newsgroups and FTP links are also passed to the web browser&per.
|
|---|
| 440 | At this time&comma. it isn&apos.t possible to choose a different program for
|
|---|
| 441 | these links&per.
|
|---|
| 442 | :p.:hp2.Note to help file authors:ehp2.
|
|---|
| 443 | :p.The original View had no understanding of URL or email links&comma. so the
|
|---|
| 444 | only way to implement them was a link to&comma. for example&comma.
|
|---|
| 445 | &odq.netscape&per.exe&cdq. with the correct parameters&per.
|
|---|
| 446 | :p.NewView translates program links to &odq.netscape&cdq.&comma. &odq.explore&cdq. or &odq.mozilla&cdq.
|
|---|
| 447 | into links to the default browser&per.
|
|---|
| 448 | :p.It also auto&endash.detects URLs in the forms&colon.
|
|---|
| 449 | :p. http&colon.&slash.&slash.x https&colon.&slash.&slash.x
|
|---|
| 450 | ftp&colon.&slash.&slash.x
|
|---|
| 451 | :p. mailto&colon.x news&colon.x
|
|---|
| 452 | :p.Things that look like URLs are also detected&comma. even without the protocol
|
|---|
| 453 | prefix&colon.
|
|---|
| 454 | :p. www&per.a&per.b &endash. browser
|
|---|
| 455 | :p. ftp&per.a&per.b &endash. ftp
|
|---|
| 456 | :p. a&atsign.b&per.c &endash. email
|
|---|
| 457 | :p.where a&comma. b and c are any alphanumeric string&per.
|
|---|
| 458 | :p.You don&apos.t need to do anything for NewView to recognise these&per.
|
|---|
| 459 | .*
|
|---|
| 460 | .*
|
|---|
| 461 | .* ************************************************************
|
|---|
| 462 | .* Command Line
|
|---|
| 463 | .* ************************************************************
|
|---|
| 464 | :h1 res=9 id='CommandLine'.
|
|---|
| 465 | Command Line Parameters
|
|---|
| 466 | :p.:hp2.Command Line Parameters:ehp2.
|
|---|
| 467 | :p.When you run NewView from the command line you can supply various
|
|---|
| 468 | parameters&per. None of them are required&per.
|
|---|
| 469 | :p.
|
|---|
| 470 | :p.:hp2.NewView &lbracket.options&rbracket. &lbracket.<.filename>.
|
|---|
| 471 | &lbracket.<.search text>.&rbracket.&rbracket.:ehp2.
|
|---|
| 472 | :p.If NewView is installed as a replacement for view&comma. then the command
|
|---|
| 473 | starts with view instead of newview&per.
|
|---|
| 474 | :p.:link reftype=hd refid='CommandLineExamples'.Examples:elink.
|
|---|
| 475 | .*
|
|---|
| 476 | :p.:hp2.<.filename>.:ehp2.
|
|---|
| 477 | :p.The file for NewView to load&per. You can load multiple files at once by
|
|---|
| 478 | using filename1&plus.filename2 etc&per.
|
|---|
| 479 | .br
|
|---|
| 480 | If a path isn&apos.t specified&comma. then the files are searched for in the
|
|---|
| 481 | :link reftype=hd refid='L_EnvironmentVariables'.BOOKSHELF and HELP
|
|---|
| 482 | paths:elink.&per.
|
|---|
| 483 | .br
|
|---|
| 484 | If you path and&slash.or filename contains special characters (like blank) then
|
|---|
| 485 | you have to enclose the filename in double qoutes&per.
|
|---|
| 486 | .*
|
|---|
| 487 | :p.:hp2.<.search text>.:ehp2.
|
|---|
| 488 | :p.Search topic titles and index entries for this text&per. This is
|
|---|
| 489 | :hp2.not:ehp2. the same as a normal search&comma. for compatibility with
|
|---|
| 490 | original View&per. To do a proper search use the &slash.s option &lpar.see
|
|---|
| 491 | below&rpar.&per. For more details&comma. see :link reftype=hd
|
|---|
| 492 | refid='CommandLineTopicSearch'.Command Line Topic Search:elink.&per.
|
|---|
| 493 | :p.:hp2.Options:ehp2.
|
|---|
| 494 | :p.:hp2.&slash.s:ehp2.
|
|---|
| 495 | :p.After opening the file&comma. performs a :link reftype=hd
|
|---|
| 496 | refid='search'.search:elink. for the given text (do a real full text search intead of
|
|---|
| 497 | the default topic titles search)&per. The result is the same as performing the search from
|
|---|
| 498 | the :link reftype=hd
|
|---|
| 499 | refid='search'.serach navigation panel:elink.&per.
|
|---|
| 500 | :p.Example&colon.
|
|---|
| 501 | .br
|
|---|
| 502 | :lm margin=4.
|
|---|
| 503 | To search for copy in the whole cmdref document you can call
|
|---|
| 504 | :xmp.
|
|---|
| 505 | newview &slash.s cmdref copy
|
|---|
| 506 | :exmp.
|
|---|
| 507 | NewView is clever enought to handle multiple words (like the :link reftype=hd
|
|---|
| 508 | refid='search'.serach navigation panel:elink.)&per. This is a OR search&per.
|
|---|
| 509 | :xmp.
|
|---|
| 510 | newview &slash.s cmdref net access
|
|---|
| 511 | :exmp.
|
|---|
| 512 | To perform a AND search enclose the search phrase in double quotes&per.
|
|---|
| 513 | :xmp.
|
|---|
| 514 | newview &slash.s cmdref &odq.net access&cdq.
|
|---|
| 515 | :exmp.
|
|---|
| 516 | :lm margin=1.
|
|---|
| 517 | .*
|
|---|
| 518 | :p.:hp2.&slash.g:ehp2.
|
|---|
| 519 | :p.Performs a :link reftype=hd refid='GlobalSearch'.global search:elink. for the
|
|---|
| 520 | given text&comma. on all the help files in your system&per.
|
|---|
| 521 | :p.Example&colon.
|
|---|
| 522 | .br
|
|---|
| 523 | :lm margin=4.
|
|---|
| 524 | To search for copy in all help files use
|
|---|
| 525 | :xmp.
|
|---|
| 526 | newview &slash.g copy
|
|---|
| 527 | :exmp.
|
|---|
| 528 | Provide the file name as first parameter if you like to open a help file
|
|---|
| 529 | before the search starts.
|
|---|
| 530 | :xmp.
|
|---|
| 531 | newview &slash.g cmdref copy
|
|---|
| 532 | :exmp.
|
|---|
| 533 | :lm margin=1.
|
|---|
| 534 | .*
|
|---|
| 535 | :p.:hp2.&slash.?:ehp2. or :hp2.&slash.h:ehp2. or :hp2.&slash.help:ehp2.
|
|---|
| 536 | :p.Show command line help
|
|---|
| 537 | :p.See also&colon. :link reftype=hd refid='AdvancedParameters'.Advanced
|
|---|
| 538 | Parameters:elink.
|
|---|
| 539 | .* ************************************************************
|
|---|
| 540 | .* Command Line Topic Search
|
|---|
| 541 | .* ************************************************************
|
|---|
| 542 | :h2 res=13 id='CommandLineTopicSearch'.
|
|---|
| 543 | Command Line Topic Search
|
|---|
| 544 | :p.:hp2.Command line topic search:ehp2.
|
|---|
| 545 | :p. view <.filename>. <.topic>.
|
|---|
| 546 | :p.The topic search parameter specified on the command line&comma. copies the
|
|---|
| 547 | behaviour of old view&per.
|
|---|
| 548 | :p.Text within topics is not searched&comma. only titles and index entries&per.
|
|---|
| 549 | This makes it less useful to humans&comma. but is used by some programs to
|
|---|
| 550 | reference help topics in a predictable way&per.
|
|---|
| 551 | :p.You can use multiple words here&per.
|
|---|
| 552 | :p.The search performed is&colon.
|
|---|
| 553 | :p.&endash. topic title starts with search text
|
|---|
| 554 | :p.&endash. index entry starts with search text
|
|---|
| 555 | :p.&endash. topic title contains search text
|
|---|
| 556 | :p.&endash. index entry contains search text&per.
|
|---|
| 557 | :p.Developers should make sure that the expected document will be found if using
|
|---|
| 558 | this technique to identify topics when starting New or Old view&per.
|
|---|
| 559 | .* ************************************************************
|
|---|
| 560 | .* Advanded Parameters
|
|---|
| 561 | .* ************************************************************
|
|---|
| 562 | :h2 res=14 id='AdvancedParameters'.
|
|---|
| 563 | Advanced Parameters
|
|---|
| 564 | :p.:hp2.Advanced Parameters:ehp2.
|
|---|
| 565 | :p.The following command line parameters are intended mainly for software
|
|---|
| 566 | developers&comma. but can be used for any purpose&per.
|
|---|
| 567 | :p.:hp2.&slash.lang&colon.<.language spec>.:ehp2.
|
|---|
| 568 | :p.Loads the specified language&per. Overrides the default chosen based on the
|
|---|
| 569 | LANG environment variable&per. For example&comma.
|
|---|
| 570 | :xmp.
|
|---|
| 571 | newview cmdref &slash.lang&colon.en
|
|---|
| 572 | :exmp.
|
|---|
| 573 | loads English&per. See readme&per.txt for more information&per.
|
|---|
| 574 | :p.:hp2.&slash.pos&colon.<.left>.&comma.<.bottom>.&comma.<.width>.&comma.<.height>.:ehp2.
|
|---|
| 575 | :p.Set the main program window to the given position and size&per. All values
|
|---|
| 576 | must be given&per. Put a :hp2.P:ehp2. after a number to specify a
|
|---|
| 577 | percentage&per. For example&colon.
|
|---|
| 578 | :xmp.
|
|---|
| 579 | newview &slash.pos&colon.10P&comma.10P&comma.80P&comma.80P
|
|---|
| 580 | :exmp.
|
|---|
| 581 | :p.makes the window centered and 80&percent. of the screen size&per.
|
|---|
| 582 | :p.:hp2.&slash.title&colon.<.window title>.:ehp2.
|
|---|
| 583 | :p.Sets the title of the NewView window to the specified text&comma. overriding
|
|---|
| 584 | whatever appears in the help file&per. The text &odq.Help &endash. &cdq. will always be
|
|---|
| 585 | inserted in front of the specified text&comma. unless the specified text is
|
|---|
| 586 | &odq.help&cdq.&comma. in which case the title will simply become &odq.Help&cdq.&per. This is to
|
|---|
| 587 | make sure that help windows are always obvious as such in the window list&per.
|
|---|
| 588 | :p.If you need to specify multiple words&comma. surround the entire option with
|
|---|
| 589 | quotes&comma. for example&colon.
|
|---|
| 590 | :xmp.
|
|---|
| 591 | newview cmdref &odq.&slash.title&colon.Command Line Help&cdq.
|
|---|
| 592 | :exmp.
|
|---|
| 593 | .* ************************************************************
|
|---|
| 594 | .* Command Line Examples
|
|---|
| 595 | .* ************************************************************
|
|---|
| 596 | :h2 res=15 id='CommandLineExamples'.
|
|---|
| 597 | Command Line Examples
|
|---|
| 598 | :p.:hp2.Command Line Examples:ehp2.
|
|---|
| 599 | .*
|
|---|
| 600 | :p.The following examples assume that newview is installed as a complete
|
|---|
| 601 | replacement and therefore view is actually newview&per.
|
|---|
| 602 | :p.:hp2.view cmdref:ehp2.
|
|---|
| 603 | :lm margin=4.
|
|---|
| 604 | :p.Open the file cmdref&per.inf &lpar.OS&slash.2 Command Reference&rpar. from
|
|---|
| 605 | the help path&per.
|
|---|
| 606 | :lm margin=1.
|
|---|
| 607 | .*
|
|---|
| 608 | :p.:hp2.view cmdref&plus.os2ug:ehp2.
|
|---|
| 609 | :lm margin=4.
|
|---|
| 610 | :p.Open two files&comma. cmdref&per.inf and os2ug&per.inf &lpar.OS&slash.2 User
|
|---|
| 611 | Guide&rpar.&comma. in the same window&per.
|
|---|
| 612 | .br
|
|---|
| 613 | The table of contents from os2ug&per.inf is added to the end of the contents
|
|---|
| 614 | from cmdref&per.inf&per. The indexes are combined alphabetically&per.
|
|---|
| 615 | :lm margin=1.
|
|---|
| 616 | .*
|
|---|
| 617 | :p.:hp2.view c&colon.&bsl.os2&bsl.book&bsl.os2ug&per.inf:ehp2.
|
|---|
| 618 | :lm margin=4.
|
|---|
| 619 | :p.Open the file os2ug&per.inf in the c&colon.&bsl.os2&bsl.book directory&per.
|
|---|
| 620 | :lm margin=1.
|
|---|
| 621 | .*
|
|---|
| 622 | :p.:hp2.view &odq.c&colon.&bsl.os2 book&bsl.os2ug&per.inf&cdq.:ehp2.
|
|---|
| 623 | :lm margin=4.
|
|---|
| 624 | :p.Surround path&sl.file with double quotes if they contain special characters (like blank)&per.
|
|---|
| 625 | :lm margin=1.
|
|---|
| 626 | .*
|
|---|
| 627 | :p.:hp2.view cmdref dir:ehp2.
|
|---|
| 628 | :lm margin=4.
|
|---|
| 629 | :p.Open the file cmdref &lpar.OS&slash.2 command reference&rpar. and look in
|
|---|
| 630 | titles and index for the word &odq.dir&cdq.&per. Will show the help page for the DIR
|
|---|
| 631 | command&per.
|
|---|
| 632 | :lm margin=1.
|
|---|
| 633 | .*
|
|---|
| 634 | :p.:hp2.view &slash.s os2ug desktop:ehp2.
|
|---|
| 635 | :lm margin=4.
|
|---|
| 636 | :p.Open the file os2ug&per.inf and search for the word &odq.desktop&cdq.&per. The best
|
|---|
| 637 | match is shown&per.
|
|---|
| 638 | :lm margin=1.
|
|---|
| 639 | .*
|
|---|
| 640 | :p.:hp2.view &slash.g permissions:ehp2.
|
|---|
| 641 | :lm margin=4.
|
|---|
| 642 | :p.Performs a search of all help files for the word &odq.permissions&cdq.&per.
|
|---|
| 643 | :lm margin=1.
|
|---|
| 644 | .*
|
|---|
| 645 | :p.:hp2.set myhelp&eq.cmdref&plus.os2ug&plus.rexx:ehp2.
|
|---|
| 646 | .br
|
|---|
| 647 | :hp2.view myhelp:ehp2.
|
|---|
| 648 | :lm margin=4.
|
|---|
| 649 | :p.The first line sets an environment variable MYHELP to contain the names of
|
|---|
| 650 | three help files&per. The second line opens the three files&per.
|
|---|
| 651 | :lm margin=1.
|
|---|
| 652 | .*
|
|---|
| 653 | .*
|
|---|
| 654 | .* ************************************************************
|
|---|
| 655 | .* Keyboard Shortcuts
|
|---|
| 656 | .* ************************************************************
|
|---|
| 657 | :h1 res=10 id='KeyboardShortcuts'.
|
|---|
| 658 | Keyboard Shortcuts
|
|---|
| 659 | :p.:hp2.Keyboard Shortcuts:ehp2.
|
|---|
| 660 | :p.Most keyboard shortcuts are visible in the menu&comma. but a few are not&per.
|
|---|
| 661 | The additional shortcuts are&colon.
|
|---|
| 662 | :p.:hp2.Alt&plus.F4:ehp2. Exit
|
|---|
| 663 | :p.:hp2.Ctrl&plus.C:ehp2. Copy selected text to clipboard
|
|---|
| 664 | :p.:hp2.F7:ehp2. Back
|
|---|
| 665 | :p.:hp2.F8:ehp2. Forward
|
|---|
| 666 | :p.:hp2.Ctrl&plus.Left:ehp2. Back
|
|---|
| 667 | :p.:hp2.F11:ehp2. Previous in contents
|
|---|
| 668 | :p.:hp2.F12:ehp2. Next in contents
|
|---|
| 669 | :p.
|
|---|
| 670 | :p.:hp2.Shortcuts visible in the menu:ehp2.
|
|---|
| 671 | :p.:hp2.Ctrl&plus.O:ehp2. Open files
|
|---|
| 672 | :p.:hp2.Ctrl&plus.E:ehp2. Open files from help paths
|
|---|
| 673 | :p.:hp2.Ctrl&plus.N:ehp2. Open a new window
|
|---|
| 674 | :p.:hp2.Ctrl&plus.P:ehp2. Print topic
|
|---|
| 675 | :p.:hp2.F3:ehp2. Exit
|
|---|
| 676 | :p.
|
|---|
| 677 | :p.
|
|---|
| 678 | :p.:hp2.Ctrl&plus.A:ehp2. Select all text in topic
|
|---|
| 679 | :p.:hp2.Ctrl&plus.Ins:ehp2. Copy selected text to clipboard
|
|---|
| 680 | :p.
|
|---|
| 681 | :p.:hp2.Ctrl&plus.F:ehp2. Find within current topic
|
|---|
| 682 | :p.:hp2.Ctrl&plus.G:ehp2. Repeat last find
|
|---|
| 683 | :p.
|
|---|
| 684 | :p.:hp2.Ctrl&plus.S:ehp2. Open global search tool
|
|---|
| 685 | :p.
|
|---|
| 686 | :p.:hp2.Alt&plus.C:ehp2. Change to the contents tab
|
|---|
| 687 | :p.:hp2.Alt&plus.I:ehp2. Change to the index tab
|
|---|
| 688 | :p.:hp2.Alt&plus.S:ehp2. Change to the search tab
|
|---|
| 689 | :p.:hp2.Alt&plus.N:ehp2. Change to the notes tab
|
|---|
| 690 | :p.:hp2.Alt&plus.P:ehp2. Toggle the left panel &lpar.tabs&rpar. on and off
|
|---|
| 691 | :p.:hp2.F5:ehp2. Expand all contents
|
|---|
| 692 | :p.:hp2.F6:ehp2. Collapse all contents
|
|---|
| 693 | :p.
|
|---|
| 694 | :p.:hp2.Esc:ehp2. Back
|
|---|
| 695 | :p.:hp2.Ctrl&plus.Right:ehp2. Forward
|
|---|
| 696 | :p.:hp2.Ctrl&plus.Up:ehp2. Previous topic in contents
|
|---|
| 697 | :p.:hp2.Ctrl&plus.Down:ehp2. Next topic in contents
|
|---|
| 698 | :p.
|
|---|
| 699 | :p.:hp2.Ctrl&plus.D:ehp2. Edit bookmarks
|
|---|
| 700 | :p.:hp2.Ctrl&plus.B:ehp2. Bookmark current topic
|
|---|
| 701 | :p.
|
|---|
| 702 | :p.:hp2.Ctrl&plus.M:ehp2. Add note at cursor position
|
|---|
| 703 | :p.
|
|---|
| 704 | :p.:hp2.F1:ehp2. Help for NewView
|
|---|
| 705 | .*
|
|---|
| 706 | .*
|
|---|
| 707 | .* ************************************************************
|
|---|
| 708 | .* Environment Variables
|
|---|
| 709 | .* ************************************************************
|
|---|
| 710 | :h1 res=11 id='L_EnvironmentVariables'.
|
|---|
| 711 | Environment Variables
|
|---|
| 712 | :p.:hp2.Environment Variables:ehp2.
|
|---|
| 713 | :p.
|
|---|
| 714 | :p.Both the :hp2.BOOKSHELF:ehp2. and :hp2.HELP:ehp2. environment variables
|
|---|
| 715 | define paths &lpar.lists of directories&rpar. for searching for help files&per.
|
|---|
| 716 | NewView uses both paths without distinction&per.
|
|---|
| 717 | :p.These paths are searched when you&colon.
|
|---|
| 718 | :p.o specify a help file without a path on the command line
|
|---|
| 719 | :p.o use the File &endash. Open Special&per.&per.&per. menu item
|
|---|
| 720 | :p.o do a :link reftype=hd refid='GlobalSearch'.global search:elink.
|
|---|
| 721 | :p.You can permanently add directories of help files to the :hp2.HELP:ehp2. or
|
|---|
| 722 | :hp2.BOOKSHELF:ehp2. paths by modifying the CONFIG&per.SYS file&per. Add to both
|
|---|
| 723 | paths&comma. if you also want old view to be able to find the files&per.
|
|---|
| 724 | :p.:hp2.Other environment variables:ehp2.
|
|---|
| 725 | :p.The :hp2.LANG:ehp2. environment variable is examined to decide the default
|
|---|
| 726 | language that NewView will be displayed in&per. &lpar.Overridden by the
|
|---|
| 727 | &slash.lang :link reftype=hd refid='AdvancedParameters'.command line
|
|---|
| 728 | parameter:elink.&per.&rpar. See the newview readme&per.txt for more information
|
|---|
| 729 | about languages&per.
|
|---|
| 730 | :p.The directory defined in :hp2.LOGFILES:ehp2. is used for logging crashes or
|
|---|
| 731 | other information&per.
|
|---|
| 732 | :p.The subdirectory &odq.lang&cdq. under the directory defined by :hp2.OSDIR:ehp2. is
|
|---|
| 733 | searched for language files at startup&per.
|
|---|
| 734 | :p.The path :hp2.ULSPATH:ehp2. is also searched for language files&per.
|
|---|
| 735 | .*
|
|---|
| 736 | .*
|
|---|
| 737 | .* ************************************************************
|
|---|
| 738 | .* For Authors and Developers
|
|---|
| 739 | .* ************************************************************
|
|---|
| 740 | :h1 res=20 id='ForAuthors'.
|
|---|
| 741 | For Authors and Developers
|
|---|
| 742 | :p.:hp2.For Authors and Developers:ehp2.
|
|---|
| 743 | :p.
|
|---|
| 744 | :p.This section contains some notes for document authors and software
|
|---|
| 745 | developers&per.
|
|---|
| 746 | :p.Also see the section about URL recognition in the :link reftype=hd
|
|---|
| 747 | refid='InternetLinks'.Internet Links :elink.topic&per.
|
|---|
| 748 | .* ************************************************************
|
|---|
| 749 | .* Writing Help Files
|
|---|
| 750 | .* ************************************************************
|
|---|
| 751 | :h2 res=12 id='WritingHelpFiles'.
|
|---|
| 752 | Writing Help Files
|
|---|
| 753 | :p.:hp2.Writing OS&slash.2 Help Files :ehp2.
|
|---|
| 754 | :p.
|
|---|
| 755 | :p.OS&slash.2 Help Files are produced using the IPF Compiler&per. IPF stands for
|
|---|
| 756 | Information Presentation Facility&per.
|
|---|
| 757 | :p.The IPF Compiler takes a text file written in a language that tells it about
|
|---|
| 758 | things like headings&comma. links&comma. text and images&comma. and produces
|
|---|
| 759 | either a &per.INF or &per.HLP file&per.
|
|---|
| 760 | :p.The official way to obtain the IPF compiler &lpar.ipfc&per.exe&rpar. is from
|
|---|
| 761 | the OS&slash.2 Developers Toolkit&per. This is included free with eComStation
|
|---|
| 762 | &lpar.http&colon.&slash.&slash.www&per.ecomstation&per.com&rpar.&per.
|
|---|
| 763 | :p.Since the language for IPFC is tedious &lpar.for example all punctuation must
|
|---|
| 764 | be typed as special keywords&comma. like &.comma&per.&rpar. many people use
|
|---|
| 765 | other tools besides the IPF compiler itself&per.
|
|---|
| 766 | :p.I use Vyperhelp
|
|---|
| 767 | &lpar.http&colon.&slash.&slash.www&per.vyperhelp&per.com&rpar. since it is
|
|---|
| 768 | simple and graphical&per. It can also export to Windows Help&comma. HTML and
|
|---|
| 769 | others&comma. though it only runs on OS&slash.2&per. Not free&per.
|
|---|
| 770 | :p.Some other popular options are&colon.
|
|---|
| 771 | :p.o HyperText&slash.2 IPF Preprocessor
|
|---|
| 772 | &lpar.http&colon.&slash.&slash.www&per.clanganke&per.de&slash.os2&slash.sw&slash.htext&slash.
|
|---|
| 773 | .br
|
|---|
| 774 | &rpar. &endash. preprocesses a simpler starting language into the very difficult
|
|---|
| 775 | IPF format&per. Free&per.
|
|---|
| 776 | :p.o HyperMake
|
|---|
| 777 | &lpar.http&colon.&slash.&slash.www&per.hypermake&per.com&rpar.&per.
|
|---|
| 778 | Similar&comma. but can also produce Windows Help and HTML&per.
|
|---|
| 779 | :p.o Sibyl &lpar.which NewView was created with&rpar. comes with an IPF
|
|---|
| 780 | preprocessor&per.
|
|---|
| 781 | :p.o IPFEditor from PCS
|
|---|
| 782 | &lpar.http&colon.&slash.&slash.www&per.pcs&endash.soft&per.com&slash.productipfe212&per.htm
|
|---|
| 783 | .br
|
|---|
| 784 | &rpar.&per. Probably the most complete&comma. but significant cost&per.
|
|---|
| 785 | Note&colon. NewView doesn&apos.t support everything IPFE can do&xclm.
|
|---|
| 786 | .br
|
|---|
| 787 | In the past there were many other options&per. Those listed should still be
|
|---|
| 788 | available and have some support&per.
|
|---|
| 789 | .* ************************************************************
|
|---|
| 790 | .* Topic Resource IDs
|
|---|
| 791 | .* ************************************************************
|
|---|
| 792 | :h2 res=16 id='TopicResourceIDs'.
|
|---|
| 793 | Topic Resource IDs
|
|---|
| 794 | :p.:hp2.Topic Resource IDs:ehp2.
|
|---|
| 795 | :p.Resource IDs are used by authors of online help for applications&comma. to
|
|---|
| 796 | identify help topics&per. Applications call the Help Manager specifying a
|
|---|
| 797 | resource ID&comma. either directly using the HM&us.DISPLAY&us.HELP
|
|---|
| 798 | message&comma. or indirectly via help tables added to their resources&comma.
|
|---|
| 799 | which PM automatically handles&per. The resource ID is stored in a table inside
|
|---|
| 800 | the help file&per.
|
|---|
| 801 | :p.For document authors&comma. NewView offers the ability to see and find
|
|---|
| 802 | resource IDs&per.
|
|---|
| 803 | :p.:hp2.Finding by Resource ID:ehp2.
|
|---|
| 804 | :p.Use Tools &endash. Find Resource ID to search for a specified resource ID in
|
|---|
| 805 | all opened files&per.
|
|---|
| 806 | :p.:hp2.Displaying Resource IDs:ehp2.
|
|---|
| 807 | :p.Use topic properties &lpar.right mouse click &endash. Properties&rpar. to see
|
|---|
| 808 | which resource IDs are associated with a topic&per.
|
|---|
| 809 | .* ************************************************************
|
|---|
| 810 | .* TopicNames
|
|---|
| 811 | .* ************************************************************
|
|---|
| 812 | :h2 res=19 id='TopicNames'.
|
|---|
| 813 | Topic Names
|
|---|
| 814 | :p.:hp2.Topic Names:ehp2.
|
|---|
| 815 | :p.
|
|---|
| 816 | :p.Like resource IDs&comma. topic names can be used by developers to link to
|
|---|
| 817 | help topics from within their application&comma. using the HM&us.DISPLAY&us.HELP
|
|---|
| 818 | message with parameter 2 being HM&us.PANELNAME&per.
|
|---|
| 819 | :p.These are not so often used&per.
|
|---|
| 820 | :p.NewView can find a particular topic name&comma. using Tools &endash. Find
|
|---|
| 821 | Topic Name&per.
|
|---|
| 822 | :euserdoc.
|
|---|
