Changeset 445 for trunk/i18n/NewView.ipf


Ignore:
Timestamp:
Jul 10, 2020, 5:07:04 AM (5 years ago)
Author:
Lewis Rosenthal
Message:

Add EN language template (ticket #25).
Add CZ, EO, FI, IT, KO, and RU language files and IT help from
2.20 branch (should be reviewed for accuracy).
Update EN help, including addition of Save as IPF... reference (ticket #2).

File:
1 edited

Legend:

Unmodified
Added
Removed

  • trunk/i18n/NewView.ipf

    r303 r445  
    22:docprof toc=123456.
    33:title.NewView Help
     4.nameit symbol=prod text='NewView'
     5.nameit symbol=os2 text='OS/2'
     6.nameit symbol=ecs text='eComStation'
     7.nameit symbol=aos text='ArcaOS'
    48.* ************************************************************
    59.* Subject: Help for NewView
    6 .* Version:
    7 .* Copyright: Copyright 2004 Aaron Lawrence
    8 .* Copyright: Copyright 2006-2007 Ronald Brill
     10.* Version: 2020070501
     11.* Copyright: Copyright 2004-2005 Aaron Lawrence
     12.* Copyright: Copyright 2006-2019 Ronald Brill
     13.* Copyright: Copyright 2019-2020 Alexander Taylor
     14.* Copyright: Copyright 2020 Lewis Rosenthal
    915.* Author: Aaron Lawrence
     16.* Author: Ronald Brill
     17.* Author: Lewis Rosenthal
    1018.* ************************************************************
    1119.*
    1220.*
    13 .* ************************************************************
    14 .* Introduction
    15 .* ************************************************************
     21.* ----------------------------------------------------------------------------
    1622:h1 res=30000 id='Introduction'.Introduction
    1723:i1 id=30001.support
    1824: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.
     25:hp2.Welcome to NewView!:ehp2.
     26:p.
     27:p.NewView is a program for reading OS/2, &ecs., and &aos. Help
     28Files.
    2329:p.:link reftype=hd refid='Support'.Support and Licensing:elink.
    2430:p.:link reftype=hd refid='Using'.Using NewView:elink.
    2531: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.
     32help file, see Tools - Options - General tab.:ehp1.
    2733: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
     34:p.NewView replaces the original IBM program supplied with OS/2.
     35:p.It improves upon many aspects of View, with a modern, easy to use
     36interface, more options, and new features that View simply
     37didn't have.
     38
     39.* ----------------------------------------------------------------------------
     40:h2 res=1 id='Support'.Support and Licensing
    3841:i1 id=30002.license
    3942:i2 refid=30001.Support and Licensing
    … …  
    4144:i1 id=30003.bugs
    4245: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.
     46:p.NewView is Copyright 1999-2006 Aaron Lawrence. It is also licensed
     47under the GNU Public License, which means you have the right to obtain the
     48source code.
     49:p.Ronald Brill has been the project maintainer since 2006, and additional
     50improvements have been added by Alexander Taylor.
     51.br
     52NewView is a Netlabs project.
     53:p.See the Readme.txt for more technical details.
     54:p.See the Changes.txt file for a history of changes to NewView.
     55:p.If you find NewView helpful, please let us know and/or make a
     56donation to support further development. It's nice to hear from you!
    5657: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
     58:li.Suggestions, compliments or bug reports https&colon.//trac.netlabs.org/newview
     59:li.Translate NewView to your language.
     60:li.A donation to Netlabs https&colon.//www.arcanoae.com/shop/netlabs/
    6061:eul.
    6162: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
     63:p.If you need to report a crash or other problem, then be as specific as
     64possible about what files were being used, what you were doing,
     65etc. If one is available, PLEASE include the newview.log. The
    6566log file will be EITHER
    6667.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
     68 - in the same directory as NewView itself
     69.br
     70 - in the folder set by LOGFILES environment variable (typically eCS
     711.1&plus. and &aos.)
     72.br
     73If it is specific to a particular help file, then please attach that
     74file to your ticket, unless it is too large.
     75:p.Most of the following information is in the newview.log file, but
    7576it would be helpful if you could include it for verification&colon.
    7677: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.
     78:li.NewView version (Help - Product Information)
     79:li.The filenames of the help files.
     80:li.A screenshot may be useful, if the problem is an incorrect or corrupt
     81display.
    8182:eul.
    82 :p.:hp2.Why doesn&apos.t my help file work properly?:ehp2.
     83:p.:hp2.Why doesn't my help file work properly?:ehp2.
    8384: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.
     85implemented. This is either because I have not got around to it, or
     86because they are simply not worth the time. Examples include
     87metafiles, index synonyms, the entire application control API,
     88and so on.
     89:p.Unfortunately, it seems that at least one developer has used every one
     90of these features, so you may find an occasional file that doesn't
     91load or doesn't work properly.
     92
     93.* ----------------------------------------------------------------------------
     94:h1 res=2 id='Using'.Using NewView
    9995:p.Once you have :link reftype=hd refid='OpeningFiles'.opened a
    100 file:elink.&comma. you can read it in various ways&per.
     96file:elink., you can read it in various ways.
    10197: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.
     98contents:elink., use the :link reftype=hd refid='Index'.alphabetical
     99index:elink., or :link reftype=hd refid='search'.search:elink.&per.
     100:p.To simply read the help file like a paper book, use the &odq.Previous&cdq.
    105101:artwork runin name='images\previous.bmp'.
    106102 and &odq.Next&cdq.
    107103: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.
     104 buttons to work your way through all the topics.
     105:p.You can also use the help file like web pages, using &odq.Back&cdq.
    110106:artwork runin name='images\back.bmp'.
    111107 and &odq.Forward&cdq.
    112108: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.
     109 buttons to go back to wherever you were before, or to retread your
     110steps.
     111:p.Colors and some of the behavior of NewView can be adjusted from the Tools
     112- Options menu.
    117113: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
     114reftype=hd refid='bookmarks'.bookmark:elink. topics.
     115
     116.* ----------------------------------------------------------------------------
     117:h1 res=3 id='OpeningFiles'.Opening Files
    126118: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
     119:p.To open a help file, you can use any of the following&colon.
     120:p.- Double-click a :link reftype=hd refid='HelpIcons'.help
    131121icon:elink. that is already set up
    132 :p.&endash. Type &odq.view :hp1.filename:ehp1.&cdq. from the :link reftype=hd
     122:p.- Type &odq.view :hp1.filename:ehp1.&cdq. from the :link reftype=hd
    133123refid='CommandLine'.command line:elink.
    134 :p.&endash. Click the Open button
     124:p.- Click the Open button
    135125:artwork runin name='images\open.bmp'.
    136126 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.
     127:p.- Reload a recently viewed file from the &odq.File&cdq. menu
     128:p.- Drag and drop a Help file from the desktop
     129:p.Once the file is loaded, you should see the :link reftype=hd
     130refid='contents'.table of contents:elink. and the first topic.
     131:note.This assumes you installed NewView as a replacement
     132for original View. If you didn't then existing help icons and the
     133command line may behave differently.
    144134: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
     135:p.NewView can load multiple files at once, presenting them as if they
     136were one book, and read environment variables for filenames.
     137:p.For example, with the OS/2 Developer's Toolkit
    148138documentation&colon.
    149139.br
    … …  
    151141.br
    152142loads 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
     143variable set in config.sys, consisting of &odq.CP1&plus.CP2&plus.CP3&cdq.
     144which tells NewView (or View) to load the help files CP1, CP2
     145and CP3. The files are searched for in the path specified by two :link
    156146reftype=hd refid='L_EnvironmentVariables'.environment
    157147variables:elink.&per.&asterisk.
    158 :p.The files are all loaded and effectively appended to each other&per.
     148:p.The files are all loaded and effectively appended to each other.
    159149: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.
     150reasons. For example, 4OS/2 (a CMD.EXE
     151replacement) uses it to add it's own help on top of the original CMD
     152help. You can do it yourself with any files you like.
    163153: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.
     154select multiple files.
     155:p.When you click a link to a different help file, NewView loads the other
     156file without closing your current files.
     157:p.At any time, you can find out what files are open by using File
     158- Information.
    169159:p.:hp2.Loading Additional Files:ehp2.
    170160: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.
     161dialog, and NewView will open the files you have selected without closing
     162the currently opened files.
    173163: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.
     164:p.You can drag and drop .INF or .HLP files onto NewView and they will
     165be opened. If you hold down the Shift key, they will be opened without
     166closing the current files.
     167:p.You can drop files onto any of the main content areas, such as the
     168Contents or Index windows, or an existing topic window.
     169:note.Some links that go across files, will only work if the correct set of
     170files is loaded.
     171
     172.* ----------------------------------------------------------------------------
     173:h2 res=17 id='HelpIcons'.Help Icons
    187174: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.
     175set to &odq.view.exe&cdq. and the parameters set to the name of the help files.
     176:p.Some programs create these icons automatically at install time.
    190177: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.
     178template. See desktop help for more information.
     179:p.If you create icons by dragging help files to the desktop, then you
     180cannot give them a meaningful title, because that would change the name of
     181the file, which might prevent programs from finding the help file.
    195182Therefore 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.
     183icons.
     184
     185.* ----------------------------------------------------------------------------
     186:h1 res=200 id='NavigationPanel'.Navigation Panel Tabs
    205187: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
     188file in different ways&colon.
     189:p.
     190
     191:artwork runin name='images\tabs.bmp'.
     192
     193:p.:ul compact.
     194:li.:link reftype=hd refid='contents'.Contents:elink.
     195:li.:link reftype=hd refid='index'.Index:elink.
     196:li.:link reftype=hd refid='search'.Search:elink.
     197:li.:link reftype=hd refid='notes'.Notes:elink.
     198:eul.
     199
     200:p.You can turn this panel off to get more space, with the button
    212201: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.
     202- Show Left Panel from the menu, or pressing Alt&plus.P. Do the
     203same to turn it on again.
    215204: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
     205in Tools - Options - General tab.
     206:note.Many programs choose to show the table of contents when they open their
     207help files; in this case, the panel is automatically shown, overriding your
     208setting.
     209
     210.* ----------------------------------------------------------------------------
     211:h2 res=4 id='contents'.Contents
    225212:i1 id=30006.Table of Contents
    226 :p.:hp2.Table of Contents:ehp2.
    227 :p.
    228213: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.
     214file, in a hierarchy or &odq.tree&cdq.&per. This is usually the first view you see
     215when you open a file.
    231216: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
     217- buttons, or using the space bar.
     218:p.To view a topic from the contents, just click on it. You can also
     219move through the contents by using the arrow keys.
     220:p.To move through :hp2.all:ehp2. topics in the contents tree, in
     221order, you can use Ctrl &plus. Up and Ctrl &plus. Down, or the
    237222&odq.Previous&cdq.
    238223:artwork runin name='images\previous.bmp'.
    239224 and &odq.Next&cdq.
    240225: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.
     226 buttons. This is one way to treat the file as a normal book, reading
     227through each page.
    243228: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
     229&odq.View&cdq. menu. This expands all the branches of the contents table so you can
     230quickly look through it. However, it's usually easier to use
    246231: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.
     232refid='Index'.Index:elink. for this purpose.
     233
     234.* ----------------------------------------------------------------------------
     235:h2 res=5 id='index'.Index
    255236: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.
     237help file. You can quickly search through it just by typing the first few
     238characters of the word you want to look up. NewView jumps to the first match
     239in the index automatically. To view the highlighted topic, press
     240enter.
     241:nt.Help files may or may not include an &odq.official&cdq. index. The index is
     242manually created by the author, so (for original View) it's
     243usefulness is strictly dependent on how much work the author put into it.
     244There may not even be one.
     245:p.However, a useful index can be provided simply by listing the titles of
     246each topic alphabetically, and this is what NewView does. It then
     247merges the original index (if any) with the list of topic titles.
     248:p.If for some reason you don't like this, you can turn it off in
     249Tools - Options - Index tab.
     250:ent.
     251
     252.* ----------------------------------------------------------------------------
     253:h2 res=6 id='search'.Search
     254:p.Searching is a quick way to find information, when you don't know
     255where to start. Simply go to the Search tab, type some related words
     256and click the Search button.
     257You'll see a listing of all topics containing that word, or words
     258like it, with the best matches at the top. The best match will be
     259displayed automatically.
     260:p.Words that matches your search are highlighted in the topic.
    284261:p.:hp2.Global search:ehp2.
    285262: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.
     263refid='GlobalSearch'.global search:elink. in Tools - Search all Help
     264Files.
    288265: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.
     266:p.If you want to search for a phrase made up of more than one word, put
     267double quotes around it, for example &odq.os/2 warp&cdq.&per.
    291268:p.:hp2.Matching features:ehp2.
    292 :p.NewView allows you finer control of searching&per.
     269:p.NewView allows you finer control of searching.
    293270: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.
     271:p.- indicates a word that must :hp2.not:ehp2. be matched
     272:p.NewView always does partial word matches. That is, if you search
     273for &odq.win&cdq. NewView will also find &odq.window&cdq. and &odq.showing&cdq.&per. However, the
     274better the match is the higher the rank will be.
    298275:p.:hp2.How NewView ranks results:ehp2.
    299276: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
     277:p.- a closer match to a full word
     278:p.- number of matching words in a topic
     279:p.- matches within the title
     280:p.- matches within an index entry
     281
     282.* ----------------------------------------------------------------------------
     283:h2 res=7 id='notes'.Notes
     284:p.NewView allows you to add notes (annotations) to your help
     285files.
     286:p.To add a note, simply click where you want to make a note and click the
    314287&odq.Note&cdq. button
    315288: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
     289, then type your text and click OK. The text will be inserted into the
     290help topic with a different color (default is green; you can change
     291this in Tools - Options - Colors).
     292:p.To edit or delete a note, click on the colored note text; you can
     293then edit the note text, or click on delete to get rid of it.
     294:p.You can also review all the notes that you've made in the current help
     295file(s) by going to the Notes tab; this allows you to add,
     296edit, and delete, and also jump to the topics containing your notes.
     297:p.Notes are saved in a single file with the extension :hp1.&per.nte:ehp1., in
     298the same directory as the help file to which they refer.
     299:note.If a help file is changed (for example a program is
     300upgraded) then notes will no longer appear in the correct place;
     301however, you can still read them from the Notes tab.
     302
     303.* ----------------------------------------------------------------------------
     304:h1 res=18 id='GlobalSearch'.Global Search
     305:p.You can search all help files on your system, by clicking the Search
    339306All button
    340307: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.
     308, using Tools - Search all Help Files in the menu, or
     309pressing Ctrl&plus.S.
    343310: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.
     311within a file:elink., but it also tells you what help file the results
     312were found in.
     313:p.These searches may take some time, depending on what you search
     314for. You can stop the search at any time.
    348315:p.:hp2.Where NewView searches:ehp2.
    349 :p.The default is to search for help files in the help paths&comma. which are
     316:p.The default is to search for help files in the help paths, which are
    350317specified by the BOOKSHELF and HELP :link reftype=hd
    351318refid='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.
     319:p.You can choose other places to search by choosing from the drop-down
     320list, or customize the list by clicking the Select button.
    354321:p.:hp2.Search in&colon. Standard Help Paths:ehp2.
    355322:p.This is the default and will search BOOKSHELF and HELP as specified
    356 above&per.
     323above.
    357324: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
     325in the help paths will be used. Click each item in the list to select or
     326de-select it. After you choose this, the location will show as
    360327&odq.Selected Help Paths&cdq.
    361328: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.
     329:p.This option will search all hard (non-removable) drives on
     330your system. You can click &odq.Select...&cdq. to customize the
     331location.
     332:p.Searching drives can find more help files, but might be much slower
     333than just the help paths.
    367334: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.
     335:p.If you have already selected particular help paths to search., you can
     336click &odq.Select...&cdq. to customize again.
    370337: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.&lt. 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
     338:p.In the &odq.Select Directories&cdq. dialog, clicking the &odq.Add....&cdq.
     339button will allow you to add one or more directories to the search list.
     340:p.Select the drive and directory using the controls that appear, then
     341click &odq.&lt. Add Directory&cdq. to add the chosen directory. You can do this as
     342many times as you like. Choose &odq.With sub-directories&cdq. if you want
     343sub-directories of the selected directory to be searched as well. In
     344this case, ... will show on the end of the directory.
     345:p.After you add a custom directory like this, the location for searching
    379346will 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.
     347:note.If you add a custom directory to standard or selected help
     348paths, then the list will become a custom list, and you can no
     349longer re-select help paths. To get back to the original help
     350paths, choose &odq.Standard Help Paths&cdq. then click &odq.Select...&cdq.
     351again.
    385352:p.:hp2.Search in&colon. Typing a location:ehp2.
    386353: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.
     354field. Add &odq...&per.&cdq. on the end of the directory if you want to
     355search subdirectories as well.
    389356:p.Example&colon.
    390 :p. Search in&colon. &lbracket. E&colon.&bsl.mydocs&bsl.&per.&per.&per.
     357:p. Search in&colon. &lbracket. E&colon.&bsl.mydocs&bsl...&per.
    391358 &rbracket.
    392359: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.
     360subdirectories.
     361
     362.* ----------------------------------------------------------------------------
     363:h1 res=8 id='bookmarks'.Bookmarks
    403364:p.NewView allows you to bookmark particular topics within the current help
    404 file&per. Simply click the bookmark button
     365file. Simply click the bookmark button
    405366: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.NewView takes care of the setup done by Internet-Application-Integration (IAI). Email&comma. Newsgroups and FTP
    440 links are passed to the program you have configured. If there is no program for a specific url type&comma.
     367 to add the current topic as a bookmark.
     368:p.To jump to a bookmark, go to the &odq.Bookmarks&cdq. menu, and click on
     369the bookmark you want to open.
     370:p.You can view or delete all your bookmarks by clicking on &odq.Edit.&per.&cdq. in
     371the &odq.Bookmarks&cdq. menu. This window can remain open while you read, so
     372that you can quickly look through your bookmarks.
     373
     374:note.NewView bookmarks remember all the topic windows that are open, if there
     375is more than one.
     376:p.Bookmarks are saved in a file with the extension .bmk, in the same
     377directory as the help file they are for.
     378
     379.* ----------------------------------------------------------------------------
     380:h1 res=100 id='InternetLinks'.Internet Links
     381:p.When you click a web URL such as
     382https&colon.//www.google.com, NewView launches your
     383default web browser.
     384:p.This web browser is specified by operating system settings, not NewView
     385itself. To configure it, you can open a URL object on the
     386desktop, edit the browser path in the :hp2.Browser:ehp2. tab, then
     387click Set Default. Both &ecs. and &aos. include utilities for setting the
     388default browser, the latter of which uses the ConfigApps utility, also available
     389from the Hobbes archive&colon.
     390:p.
     391https&colon.//hobbes.nmsu.edu/?dir&eq.&percent.2F&amp.stype&eq.all&amp.sort&eq.type_name&amp.search&eq.configapps
     392.br
     393:p.Browsers may also have the ability to make themselves the default,
     394either at install time or in preferences.
     395:p.NewView takes care of the setup done by Internet-Application-Integration (IAI). Email, Newsgroups and FTP
     396links are passed to the program you have configured. If there is no program for a specific url type,
    441397then the links are passed to the web browser.
    442398: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
     399:p.The original View had no understanding of URL or email links, so the
     400only way to implement them was a link to, for example,
     401&odq.netscape.exe&cdq. with the correct parameters.
     402:p.NewView translates program links to &odq.netscape&cdq., &odq.explore&cdq. or &odq.mozilla&cdq.
     403into links to the default browser.
     404:p.It also auto-detects URLs in the forms&colon.
     405:p. http&colon.//x  https&colon.//x
     406 ftp&colon.//x
    451407:p. mailto&colon.x  news&colon.x
    452 :p.Things that look like URLs are also detected&comma. even without the protocol
     408:p.Things that look like URLs are also detected, even without the protocol
    453409prefix&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.
     410:p. www.a.b - browser
     411:p. ftp.a.b - ftp
     412:p. a&atsign.b.c - email
     413:p.where a, b and c are any alphanumeric string.
     414:p.You don't need to do anything for NewView to recognize these.
     415
     416.* ----------------------------------------------------------------------------
     417:h1 res=300 id='SaveIPF'.Exporting as IPF
     418:p.Another &prod. feature is the ability to save the current document as an IPF
     419(Information Presentation Facility) source file. For more information concerning
     420IPF, see :link reftype=hd refid='WritingHelpFiles'.Writing Help Files:elink.
     421later in this document.
     422
     423:p.The source code generated from the current document is generally accurate,
     424and subsitutes many codes for existing symbols. Usually, the resulting file
     425may be used as-is to recompile to an identical document.
     426
     427:p.To save the current document as IPF, select Tools - Save as IPF from
     428the menu or press Ctrl+I. The default filename is derived from the current
     429document, but may be edited to suit. Simply browse to the directory where the
     430file is to be saved and click OK.
     431
     432:p.It is also important to note that any embedded images will also be saved to
     433the same location, but with generic names (img0.bmp, img1.bmp, etc.). These will
     434need to be reviewed and their names (and possibly locations) adjusted. The IPF
     435source will refer to them by these generic names, however.
     436
     437.* ----------------------------------------------------------------------------
     438:h1 res=9 id='CommandLine'.Command Line Parameters
    467439:p.When you run NewView from the command line you can supply various
    468 parameters&per. None of them are required&per.
    469 :p.
     440parameters. None of them are required.
    470441:p.:hp2.NewView &lbracket.options&rbracket. &lbracket.&lt.filename&gt.
    471442&lbracket.&lt.search text&gt.&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.
     443:p.If NewView is installed as a replacement for view, then the command
     444starts with view instead of newview.
    474445:p.:link reftype=hd refid='CommandLineExamples'.Examples:elink.
    475 .*
     446
    476447:p.:hp2.&lt.filename&gt.: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
     448:p.The file for NewView to load. You can load multiple files at once by
     449using filename1&plus.filename2 etc.
     450
     451:p.If a path isn't specified, then the files are searched for in the
    481452:link reftype=hd refid='L_EnvironmentVariables'.BOOKSHELF and HELP
    482453paths: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 .*
     454
     455:p.If the path and/or filename contains special characters (like blank) then
     456you have to enclose the filename in double qoutes.
     457
    487458:p.:hp2.&lt.search text&gt.: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
     459:p.Search topic titles and index entries for this text. This is
     460:hp2.not:ehp2. the same as a normal search, for compatibility with
     461original View. To do a proper search use the /s option (see
     462below). For more details, see :link reftype=hd
    492463refid='CommandLineTopicSearch'.Command Line Topic Search:elink.&per.
    493464:p.:hp2.Options:ehp2.
    494 :p.:hp2.&slash.s:ehp2.
    495 :p.After opening the file&comma. performs a :link reftype=hd
     465:p.:hp2./s:ehp2.
     466:p.After opening the file, performs a :link reftype=hd
    496467refid='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
     468the default topic titles search). The result is the same as performing the search from
    498469the :link reftype=hd
    499470refid='search'.serach navigation panel:elink.&per.
    500471:p.Example&colon.
    501472.br
    502 :lm margin=4.
    503473To 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.
     474:cgraphic.
     475newview /s cmdref copy
     476:ecgraphic.
     477NewView is clever enough to handle multiple words (like the :link reftype=hd
     478refid='search'.serach navigation panel:elink.). This is a OR search.
     479:cgraphic.
     480newview /s cmdref net access
     481:ecgraphic.
     482To perform a AND search enclose the search phrase in double quotes.
     483:cgraphic.
     484newview /s cmdref &odq.net access&cdq.
     485:ecgraphic.
     486
     487:p.:hp2./g:ehp2.
    519488: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.
     489given text, on all the help files in your system.
    521490:p.Example&colon.
    522491.br
    523 :lm margin=4.
    524492To search for copy in all help files use
    525 :xmp.
    526   newview &slash.g copy
    527 :exmp.
     493:cgraphic.
     494newview /g copy
     495:ecgraphic.
    528496Provide the file name as first parameter if you like to open a help file
    529497before 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.
     498:cgraphic.
     499newview /g cmdref copy
     500:ecgraphic.
     501
     502:p.:hp2./?:ehp2. or :hp2./h:ehp2. or :hp2./help:ehp2.
    536503:p.Show command line help
    537504:p.See also&colon. :link reftype=hd refid='AdvancedParameters'.Advanced
    538505Parameters: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.
     506
     507.* ----------------------------------------------------------------------------
     508:h2 res=13 id='CommandLineTopicSearch'.Command Line Topic Search
    545509:p. view &lt.filename&gt. &lt.topic&gt.
    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.
     510:p.The topic search parameter specified on the command line, copies the
     511behavior of old view.
     512:p.Text within topics is not searched, only titles and index entries.
     513This makes it less useful to humans, but is used by some programs to
     514reference help topics in a predictable way.
     515:p.You can use multiple words here.
    552516: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.
     517:p.- topic title starts with search text
     518:p.- index entry starts with search text
     519:p.- topic title contains search text
     520:p.- index entry contains search text.
    557521: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.
     522this technique to identify topics when starting New or Old view.
     523
     524.* ----------------------------------------------------------------------------
     525:h2 res=14 id='AdvancedParameters'.Advanced Parameters
    565526: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.&lt.language spec&gt.: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.&lt.left&gt.&comma.&lt.bottom&gt.&comma.&lt.width&gt.&comma.&lt.height&gt.: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.&lt.window title&gt.: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.
     527developers, but can be used for any purpose.
     528:p.:hp2./lang&colon.&lt.language spec&gt.:ehp2.
     529:p.Loads the specified language. Overrides the default chosen based on the
     530LANG environment variable. For example,
     531:cgraphic.
     532newview cmdref /lang&colon.en
     533:ecgraphic.
     534loads English. See readme.txt for more information.
     535:p.:hp2./pos&colon.&lt.left&gt.,&lt.bottom&gt.,&lt.width&gt.,&lt.height&gt.:ehp2.
     536:p.Set the main program window to the given position and size. All values
     537must be given. Put a :hp2.P:ehp2. after a number to specify a
     538percentage. For example&colon.
     539:cgraphic.
     540newview /pos&colon.10P,10P,80P,80P
     541:ecgraphic.
     542makes the window centered and 80&percent. of the screen size.
     543:p.:hp2./title&colon.&lt.window title&gt.:ehp2.
     544:p.Sets the title of the NewView window to the specified text, overriding
     545whatever appears in the help file. The text &odq.Help -  &cdq. will always be
     546inserted in front of the specified text, unless the specified text is
     547&odq.help&cdq., in which case the title will simply become &odq.Help&cdq.&per. This is to
     548make sure that help windows are always obvious as such in the window list.
     549:p.If you need to specify multiple words, surround the entire option with
     550quotes, for example&colon.
     551:cgraphic.
     552newview cmdref &odq./title&colon.Command Line Help&cdq.
     553:ecgraphic.
     554
     555.* ----------------------------------------------------------------------------
     556:h2 res=15 id='CommandLineExamples'.Command Line Examples
     557:p.The following examples assume that &prod. is installed as a complete
     558replacement and therefore view is actually &prod.&per.
    602559: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 .*
     560:p.Open the file cmdref.inf (OS/2 Command Reference) from
     561the help path.
     562
    608563: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&bsl.file with double quotes if they contain special characters (like blank)&per.
    625 :lm margin=1.
    626 .*
     564:p.Open two files, cmdref.inf and os2ug.inf (OS/2 User
     565Guide), in the same window.
     566:p.The table of contents from os2ug.inf is added to the end of the contents
     567from cmdref.inf. The indexes are combined alphabetically.
     568
     569:p.:hp2.view c&colon.&bsl.os2&bsl.book&bsl.os2ug.inf:ehp2.
     570:p.Open the file os2ug.inf in the c&colon.&bsl.os2&bsl.book directory.
     571
     572:p.:hp2.view &odq.c&colon.&bsl.os2 book&bsl.os2ug.inf&cdq.:ehp2.
     573:p.Surround a path&bsl.filename with double quotes if it contains any special
     574characters, such as one or more whitespaces.
     575
    627576: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
     577:p.Open the file cmdref (OS/2 command reference) and look in
    630578titles 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.
     579command.
     580
     581:p.:hp2.view /s os2ug desktop:ehp2.
     582:p.Open the file os2ug.inf and search for the word &odq.desktop&cdq.&per. The best
     583match is shown.
     584
     585:p.:hp2.view /g permissions:ehp2.
    642586:p.Performs a search of all help files for the word &odq.permissions&cdq.&per.
    643 :lm margin=1.
    644 .*
     587
    645588:p.:hp2.set myhelp&eq.cmdref&plus.os2ug&plus.rexx:ehp2.
    646589.br
    647590:hp2.view myhelp:ehp2.
    648 :lm margin=4.
    649591: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.
     592three help files. The second line opens the three files.
     593
     594.* ----------------------------------------------------------------------------
     595:h1 res=10 id='KeyboardShortcuts'.Keyboard Shortcuts
     596:p.Most keyboard shortcuts are visible in the menu, but a few are not.
    661597The additional shortcuts are&colon.
    662598:p.:hp2.Alt&plus.F4:ehp2. Exit
    … …  
    688624:p.:hp2.Alt&plus.S:ehp2. Change to the search tab
    689625: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
     626:p.:hp2.Alt&plus.P:ehp2. Toggle the left panel (tabs) on and off
    691627:p.:hp2.F5:ehp2. Expand all contents
    692628:p.:hp2.F6:ehp2. Collapse all contents
    … …  
    701637:p.
    702638:p.:hp2.Ctrl&plus.M:ehp2. Add note at cursor position
     639:p.:hp2.Ctrl&plus.I:ehp2. Save current document as IPF source file
    703640:p.
    704641: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.
     642
     643.* ----------------------------------------------------------------------------
     644:h1 res=11 id='L_EnvironmentVariables'.Environment Variables
    714645: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.
     646define paths (lists of directories) for searching for help files.
     647NewView uses both paths without distinction.
    717648: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.
     649:ul.
     650:li.specify a help file without a path on the command line
     651:li.use the File - Open Special... menu item
     652:li.do a :link reftype=hd refid='GlobalSearch'.global search:elink.
     653:eul.
    721654: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.
     655:hp2.BOOKSHELF:ehp2. paths by modifying the CONFIG.SYS file. Add to both
     656paths, if you also want old view to be able to find the files.
    724657:p.:hp2.Other environment variables:ehp2.
    725658: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.
     659language that NewView will be displayed in. (Overridden by the
     660/lang :link reftype=hd refid='AdvancedParameters'.command line
     661parameter:elink.&per.) See the newview readme.txt for more information
     662about languages.
    730663:p.The directory defined in :hp2.LOGFILES:ehp2. is used for logging crashes or
    731 other information&per.
     664other information.
    732665: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.
     666searched for language files at startup.
     667:p.The path :hp2.ULSPATH:ehp2. is also searched for language files.
     668
     669.* ----------------------------------------------------------------------------
     670:h1 res=20 id='ForAuthors'.For Authors and Developers
    744671:p.This section contains some notes for document authors and software
    745 developers&per.
     672developers.
    746673: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.
     674refid='InternetLinks'.Internet Links :elink.topic.
     675
     676.* ----------------------------------------------------------------------------
     677:h2 res=12 id='WritingHelpFiles'.Writing Help Files
     678:p.OS/2 Help Files are produced using the IPF Compiler. IPF stands for
     679Information Presentation Facility.
    757680: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 &amp.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.
     681things like headings, links, text and images, and produces
     682either a .INF or .HLP file.
     683:p.The official way to obtain the IPF compiler (ipfc.exe) is from
     684the OS/2 Developers Toolkit, which may be installed as a series of
     685RPM packages from the Netlabs YUM repositories, either from the command
     686line or using Arca Noae Package Manager
     687(https&colon.//www.arcanoae.com/resources/downloadables/arca-noae-package-manager/).
     688:p.Since the language for IPFC is tedious (for example all punctuation must
     689be typed as special keywords, like &amp.comma.) many people use
     690other tools besides the IPF compiler itself.
     691:p.Some use VyperHelp (http&colon.//vyperhelp.netlabs.org/)
     692as it is simple and graphical. VyperHelp can also export to Windows
     693Help, HTML, and others, though it only runs on &os2.&per.
    770694: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.
     695:ul.
     696:li.HyperText/2 IPF Preprocessor
     697(https&colon.//hobbes.nmsu.edu/?dir=&percent.2F&amp.stype=all&amp.sort=type_name&amp.search=htext)
     698- preprocesses a simpler starting language into the very difficult IPF format.
     699Free, with full source code.
     700:li.HyperMake (http&colon.//www.hypermake.com).
     701Similar, but can also produce Windows Help and HTML.
     702:li.Sibyl (used to create NewView) comes with an IPF preprocessor.
     703:eul.
     704
     705:note.NewView may not support everything these editors can produce.
     706:p.In the past there were many other options. Those listed should still be
     707available and have some support.
     708
     709.* ----------------------------------------------------------------------------
     710:h2 res=16 id='TopicResourceIDs'.Topic Resource IDs
     711:p.Resource IDs are used by authors of online help for applications, to
     712identify help topics. Applications call the Help Manager specifying a
     713resource ID, either directly using the HM&us.DISPLAY&us.HELP
     714message, or indirectly via help tables added to their resources,
     715which PM automatically handles. The resource ID is stored in a table inside
     716the help file.
     717:p.For document authors, NewView offers the ability to see and find
     718resource IDs.
    803719: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.
     720:p.Use Tools - Find Resource ID to search for a specified resource ID in
     721all opened files.
    806722: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.
     723:p.Use topic properties (right mouse click - Properties) to see
     724which resource IDs are associated with a topic.
     725
     726.* ----------------------------------------------------------------------------
     727:h2 res=19 id='TopicNames'.Topic Names
     728:p.Like resource IDs, topic names can be used by developers to link to
     729help topics from within their application, using the HM&us.DISPLAY&us.HELP
     730message with parameter 2 being HM&us.PANELNAME.
     731:p.These are not so often used.
     732:p.NewView can find a particular topic name, using Tools - Find
     733Topic Name.
    822734:euserdoc.
Note: See TracChangeset for help on using the changeset viewer.