home *** CD-ROM | disk | FTP | other *** search
/ Black Box 4 / BlackBox.cdr / editors / hsevlsfx.exe / EDINTRO.HYP < prev    next >
Text File  |  1992-02-15  |  44KB  |  1,457 lines
  1. .INDEX
  2. .HEADER
  3. ~hi~M ~TwF~TKile ~PMFile~Kf~E ~M ~TwG~TKoto ~PMGoto~Kg~E ~M ~TwS~TKearch ~PMSearch~Ks~E ~M ~TwO~TKther ~PMOther~Ko~E ~M ~TwA~TKdd ~PMAdd~Ka~E ~M ~TwE~TKdit ~PMEdit~Ke~E ~M ~TwM~TKaint ~PMMaintenance~Km~E ~M ~TwH~TKelp ~PMHelp~Kh~E  Hyper Notebook
  4. ~hi╔══╧═════╧═══════╧════════╧══════╧══════╧══════╧═══════╧════════════════════╗
  5. ~ji~M ~TwF~TKile ~PMFile~Kf~E ~M ~TwG~TKoto ~PMGoto~Kg~E ~M ~TwS~TKearch ~PMSearch~Ks~E ~M ~TwO~TKther ~PMOther~Ko~E ~M ~TwH~TKelp ~PMHelp~Kh~E     HyperShell Notebook (VIEW only)
  6. ~ji╔══╧══════╧══════╧════════╧═══════╧═════════════════════════════════════════╗
  7. ╚╡~DU ~Tw $1 - $2 ~h/~C72~DV<*>~DU~Z~C76~DT╞╝
  8.  
  9. .REMARK 
  10. Menubar style hyperfile template
  11. Copyright (c) 1990 N.G.Taylor
  12. .
  13. .CHECK +fa
  14. Check both menu types
  15.  
  16. .
  17. .MENU File
  18. Notebook   |NNotebook
  19. Type file  |T?File name
  20. ───────────|
  21. Command    |D?Command line
  22. DOS shell  |d
  23. ───────────|
  24. ?iSave to TMP|#S
  25. ?iExit (save)|#X
  26. Quit       |Q
  27. .
  28. .MENU Search
  29. Title search    |A@S?Search string
  30. Search Text   F6|A@X?Search string
  31. Pick and search |SPicksrch
  32. ────────────────|
  33. Add to search   |O*64;MSearch
  34. Refine search   |O*63;MSearch
  35. ────────────────|
  36. Matched flag ±  |ZL/
  37. ────────────────|
  38. Next matching   |F+1
  39. List matching  l|A@C1
  40. Unmatched list  |A@C2
  41. ?i────────────────|
  42. ?iGlobal items    |#V@Y?Search string
  43. ?iItems (Local)   |#V@y?Search string
  44. .
  45. .MENU Goto
  46. Contents list    F2|A@C
  47. From current       |A@C3$1
  48. Starting with      |A@C0?Starting with
  49.  ───────────────── |
  50. Next frame        n|F+
  51. Matching frame    m|F+1
  52. Previous frame    p|F-
  53. Home frame         |b1
  54.  ───────────────── |
  55. Backtrack one     b|B
  56. Unwind backtrack F4|b@B
  57. Revisit frame      |A@b
  58.  ───────────────── |
  59. View noted ref   F5|A@R
  60. .
  61. .MENU Other
  62. ?iLocal notes |n@p1 Notes
  63. ?iGlobal notes|N@P1 Notes
  64. Calculator  |SCalculator
  65. ?iPrint frame |SPrint Frame
  66. ?iSet colours |Scolours
  67. Error text  |Sperror
  68. Action    F8|A?What action
  69. .
  70. .MENU Help
  71. Selecting    |NSelecting
  72. Key mappings |NKey mappings
  73. Funct. keys  |NFkeys
  74. Menu bar     |NMenu bar
  75. Information i|NInfo
  76. Colour key   |NKey
  77. Paged lists  |MPaged Help
  78. Editing mode |MEditing
  79. .
  80. .MENU Paged Help
  81. Control Keys |NPaged control keys
  82. Paged lists  |NPaged lists
  83. Selecting    |NSelecting
  84. .
  85. .CHECK -fax
  86. .
  87. .MENU Scheme
  88. Action ref  |A
  89. Menu Choice |C
  90. Title       |D
  91. Frame ref   |F
  92. Menu heading|H
  93. Note heading|J
  94. Note text   |K
  95. Menu ref    |M
  96. Note ref    |N
  97. Menu seln   |O
  98. Pop message |P
  99. Invisible   |Q
  100. Request     |R
  101. Script ref  |S
  102. Frame text  |T
  103. .
  104. .MENU Error text
  105. 1 - Operation cancelled
  106. 2 - No selection from menu
  107. 3 - End of file
  108. 4 - Cant open file
  109. 5 - File not open
  110. 6 - File open
  111. 7 - File changed
  112. 8 - At start of backtrack
  113. 9 - Divide by 0
  114. 10 - Value not expected
  115. 11 - Value expected
  116. 12 - Undefined opcode
  117. 13 - Unmatched parenthesis
  118. 14 - Syntax error
  119. 15 - Script not available
  120. 16 - Menu not available
  121. 17 - Note not available
  122. 18 - Frame not available
  123. 19 - Key not defined
  124. 20 - Invalid key code
  125. 21 - Local ref can't be noted
  126. 22 - Not at reference
  127. 23 - Key not mapped
  128. 24 - No action or disabled
  129. 25 - Invalid action code
  130. 26 - No command
  131. 27 - Env var not present
  132. 28 - Invalid dynamic menu
  133. 29 - Line too wide for screen
  134. 30 - String too long
  135. 31 - Too many lines in frame
  136. 32 - Max script reached
  137. 33 - Maximum menu size reached
  138. .
  139. .NOTE Notebook
  140.  The Notebook Hyperfile is
  141.  an electronic notebook
  142.  which you can use for your
  143.  own data.
  144. .
  145. .NOTE Paged lists
  146.  Type contents of file
  147.  Search titles or texts
  148.  Detailed directory list
  149.  Contents list
  150.  Backtrack list
  151.  Noted references list
  152. ~hi Global/Local item lists
  153. ~hi Check scans
  154. .
  155. .NOTE Paged control keys
  156.  F1 or ?    - This help
  157.  F2 or #    - Page number (*T)
  158.  F3 or PgUp - Previous page
  159.  F4 or Home - Start of list/file
  160.  F5         - Find next (*T)
  161.  F6 or /    - Search file (*T)
  162.  F8 or End  - End of file (*T)
  163.  F9         - Quit (*T Suspend list)
  164.  F10        - Quit (*T Quit list)
  165.  Return     - Select (*T Suspend)
  166.  (*T - Type file control keys)
  167. .
  168. .NOTE Info
  169.    - $9 -
  170.  Frame: $1
  171.  Title: $2
  172.  File : $3
  173.  Date : $4
  174.  Time : $5
  175.  ~ABacktrack ~O2 ~PO2A;NInfo~E with $6 entries
  176.  ~AAutoref ~O4 ~PO4A;NInfo~E
  177.  Error status $? ~C32~AClear~PYah;NInfo~E
  178. .
  179. .NOTE Menu bar
  180.  The menus on the menu bar can be selected using their initial
  181.  letters. With a menu on display, the options can be selected with
  182.  the initial letter of the option. The available facilities are
  183.  shown below (the names of the options differ in the menus).
  184.  
  185.  ~TwF~TKile    ~TwG~TKoto       ~TwS~TKearch  ~TwO~TKther   ~TwA~TKdd    ~TwE~TKdit    ~TwM~TKaint    ~TwH~TKelp
  186.  
  187.  DOS     Contents   Titles  Local   Frame  Current View     Selecting
  188.  Type    Backtrack  Text    Global  Global Frame   Rename   Keys
  189.  Exit    Next       List     notes  Local  Global  Check    Menubar
  190.  Quit    Previous   Next    Calc    File   Local   Delete   Information
  191.  Command Revisit    Pick    Error          File    Undelete Colour key
  192.                     Local   Action         Header  Move     Editing
  193.                     Global  Colours        Footer  Print
  194.  
  195. .
  196. .NOTE Key mappings
  197.  The following key mappings
  198.  are always provided:-
  199.  
  200.   q     Quit HyperShell
  201.   n     Next frame
  202.   p     Previous frame
  203.   b     Backtrack one step
  204.   m     Next matching frame
  205. .
  206. .NOTE Key
  207.  A ~Mmenu~PNKey~E gives a menu.
  208.  A ~Nnote~PNKey~E displays a note.
  209.  A ~Freference~PNKey~E allows a
  210.  new frame to be selected.
  211.  An ~Aaction~PNKey~E does some
  212.  other action.
  213.  An ~Iinput field~PNKey~E permits some
  214.  value to be entered.
  215. .
  216. .NOTE Notepad
  217.  The notepad allows you to store a
  218.  reference that you may want to use
  219.  later. The INS key adds the reference
  220.  pointed at to the notepad, or the
  221.  current frame if not pointing at any.
  222.  The DEL key deletes a reference.
  223.  The NOTEPAD option on the main menu
  224.  allows you to select from the notepad
  225.  and delete unwanted references.
  226. .
  227. .NOTE Selecting
  228.  Use the cursor keys or the TAB and
  229.  SHIFT/TAB keys to move to a reference
  230.  Press RETURN to select the reference.
  231.  Press ESCAPE for the control menu, or
  232.  to cancel a menu, note or list.
  233.  
  234.  When using a mouse, move mouse to
  235.  position cursor to select a reference,
  236.  Press LEFT mouse button to select.
  237.  Press RIGHT mouse button for the
  238.  control menu or to cancel a menu,
  239.  note, or list.
  240.  
  241.  See Also:- ~NFunction keys~PNFkeys~E
  242. .
  243. .NOTE Colour
  244.   Select $\ground colour
  245.  
  246. ~F~BW~TKBlack~PK~E~BK  ~F~TBBlue~PB~E    ~F~TGGreen~PG~E  ~F~TCCyan~PC~E
  247. ~F~TRRed~PR~E    ~F~TMMagenta~PM~E ~F~TYBrown~PY~E  ~F~TWWhite~PW~E
  248. ~F~BW~TkGrey~Pk~E~BK   ~F~TbBlue~Pb~E    ~F~TgGreen~Pg~E  ~F~TcCyan~Pc~E
  249. ~F~TrRed~Pr~E    ~F~TmMagenta~Pm~E ~F~TyYellow~Py~E ~F~TwWhite~Pw~E
  250.  
  251.  Choose bright for blink
  252.      on backgrounds
  253. .
  254. .NOTE Fkeys
  255.  F1 Help        F2  Full Contents
  256.  F3 Backtrack   F4  Select back
  257.  F5 Notepad     F6  Search text
  258.  F7 Type file   F8  Do action
  259.  F9 DOS Shell   F10 Quit Program
  260.  
  261.  See also: ~NKey mappings~E
  262. .
  263. .CHECK +fa
  264.  
  265. .
  266. .SCRIPT Colours
  267. -- Configure colours
  268. Y?Press escape to abort at any time.   (Return to continue)
  269. pChoose Item to change colour of
  270. V[@MScheme
  271. V{@NColour(Fore)
  272. V]@NColour(Back)
  273. O$[${$]
  274. -- Now add to set colours script
  275. #BG999$,sO$[${$]$,X
  276. #ESSET COLOURS
  277. y
  278. .
  279. .SCRIPT Calculator
  280. Ve?Enter expression (x = last result $x)
  281. Vx=$e
  282. pExpr $e = $x
  283. .
  284. .CHECK +fax
  285.  
  286. .
  287. .SCRIPT perror
  288. p@MError text($?)|Error %s
  289. .
  290. .SCRIPT Picksrch
  291. pPick a word with the mouse
  292. P;Ve&P;abq
  293. A@X$e
  294. .
  295. .SCRIPT SETUP
  296. O#
  297. O16
  298. O*11
  299. KF1MHelp
  300. KM1HELP
  301. KH4SMENBAR
  302. KH3Paged Help
  303. K#nF+
  304. K#pF-
  305. K#bB
  306. K#qQ
  307. K#iNinfo
  308. K#lA@C1
  309. Vsfirst
  310. VZ$d?
  311. VrY?Press escape to abort at any time.   (Return to continue)
  312. ZVnext=~L23~C5~APress space to continue~PF+~K ~E
  313. +SET COLOURS
  314. .
  315. .SCRIPT SET COLOURS
  316. OUwK
  317. OVrk
  318. OKKW
  319. .
  320. .SCRIPT MENBAR
  321. ZX1;ZY1
  322. .
  323. .REMARK 
  324. Editing items
  325. .
  326. .MENU Edit
  327. Current frame|#EF$1
  328. Frame        |SEDIT(C)
  329. Global Item  |SEDIT(I)
  330. Local Item   |SEDIT(i)
  331. Text file    |SEDIT(l*.*)
  332. Header       |#EU
  333. Edit Footer  |#EV
  334. .
  335. .MENU Add
  336. Frame        |SADD(C)
  337. Global Item  |SADD(I)
  338. Local Item   |SADD(i)
  339. Text file    |SADD(l*.*)
  340. .
  341. .MENU Maintenance
  342. View item    |SMAINT(V)
  343. Rename item  |SRENAME
  344. Title change |STITLE CHANGE
  345. Delete item  |SMAINT(D)
  346. Whats deleted|#V@Z
  347. Undelete item|SUNDEL
  348. Move item    |SMOVE
  349. Print item   |SMAINT(P)
  350. Check item   |SMAINT(C)
  351. Full Check   |A@MCHECK
  352. .
  353. .MENU APPEND
  354. Global item     |i@I
  355. Local item      |i@i
  356. Frame           |i@C
  357. Referenced item |i@R
  358. Text file       |f@d*.*
  359. Note file       |f@d*.NTE
  360. Menu file       |f@d*.MNU
  361. Script file     |f@d*.HSF
  362. BLOAD screen    |t@d*.PIC
  363. BLOAD with attrs|w@d*.PIC
  364. .
  365. .MENU CHECK
  366. Frames       |#V@U
  367. Global Items |#V@V
  368. Local Items  |#V@v
  369. .
  370. .MENU CONVERSION
  371. Convert line to uppercase |cu
  372. Convert line to lowercase |cl
  373. Strip spaces in line      |cs
  374. Convert word to uppercase |bLBeLBpcu;BdEDb
  375. Convert word to lowercase |bLBeLBpcl;BdEDb
  376. .
  377. .MENU H_EDHELP
  378. ?vKeys         |hNVIEW KEYS
  379. \vKeys         |hNEDIT KEYS
  380. \vControl Keys |hNEDIT CTLKEYS
  381. \vFunction Keys|hNEDIT FUNKEYS
  382. \vEditing      |h@MEditing
  383. \vPrimitives   |hNEDIT CODES
  384. \vGraphics Map |s@NGRAPHIC CHARS
  385. .
  386. .MENU INSERT REF
  387. Global item ref |s~;s@I;s~E
  388. Local item ref  |s~;s@i;s~E
  389. Frame reference |s~;s@C;s~E
  390. Referenced item |s~;s@R;s~E
  391. Input field     |s~I;s?text;s~W;s?width;s~P;s?pattern;s~E
  392. .
  393. .MENU EDIT TYPE
  394. Frame       |C
  395. Global Item |I
  396. Local Item  |i
  397. Search Items|Y?search for
  398. Text file   |l*.*
  399. .
  400. .MENU GLOBAL ITEM
  401. Note      |N
  402. Menu      |M
  403. Script    |S
  404. Remark    |R
  405. Print     |P
  406. Check     |C
  407. Text file |T
  408. Header    |U
  409. Footer    |V
  410. .
  411. .MENU LOCAL ITEM
  412. Note    |n
  413. Menu    |m
  414. Script  |s
  415. Remark  |r
  416. Print   |p
  417. Check   |c
  418. .
  419. .MENU H_EDMENU
  420. ?vHelp          |hNVIEW KEYS
  421. \vHelp          |x@MH_EDHELP
  422. \vAppend item   |x@MAPPEND
  423. \vInsert ref    |x@MINSERT REF
  424. \vConversions   |x@MCONVERSION
  425. \vMark line     |.
  426. \vCut from mark |-
  427. \vPaste lines   |+
  428. \vInsert string |s?String
  429. \vDo function   |x?Function
  430. Toggle Verbatim |H
  431. Quit            |Q
  432. \vExit          |X
  433. .
  434. .SCRIPT ADD
  435. -- Parameter shows type of item to add
  436. v\;aeq
  437. VÇ$\
  438. vÇC;jeFRAME
  439. -- Items of various descriptions
  440. pSelect item type
  441. vÇI;jcGLOBS
  442. LLOCS
  443. Vü@MLOCAL ITEM
  444. JNAME
  445. -- Global items
  446. LGLOBS
  447. Vü@MGLOBAL ITEM
  448. -- If Header or footer just bare add
  449. ZI"üU"e!"üV"e;JCONTROL
  450. LNAME
  451. Vé?Item name
  452. Vâ&N1$Ç;vâl;jeTEXT
  453. #BAfter which item
  454. Vä@$Ç
  455. JCOMMON
  456. -- And now for frames
  457. LFRAME
  458. Vé?Frame name
  459. Và?Frame Title
  460. VüF
  461. #BAfter which frame
  462. Vä@C
  463. -- Common processing
  464. LCOMMON
  465. #A$ü$é~$ä
  466. vÇC;anq
  467. -- Add title
  468. #TF$é~$à
  469. q
  470. -- Text file
  471. LTEXT
  472. Vâ&N1$é;vâT;anVéT$é
  473. #A$é
  474. q
  475. -- Control item
  476. LCONTROL
  477. #A$ü
  478. .
  479. .SCRIPT EDIT
  480. -- Stash parameter
  481. VÇ$\
  482. -- Set function and name
  483. VäE
  484. VàEdit
  485. +DOFUN
  486. .
  487. .SCRIPT MAINT
  488. -- Stash parameter
  489. Vä$\
  490. -- Get function name
  491. Và@MVED[$ä]
  492. p$à what type
  493. VÇ@MEDIT TYPE
  494. abq
  495. +DOFUN
  496. .
  497. .SCRIPT DOFUN
  498. -- Item selection
  499. #BSelect item to $à
  500. Vé@$Ç
  501. abq
  502. -- See if print
  503. väP;jnDOTHEFUN
  504. O51
  505. Y?Ready Printer (ESC to cancel)
  506. LDOTHEFUN
  507. #$ä$é
  508. q
  509. .
  510. .MENU VED
  511. V|View
  512. E|Edit
  513. D|Delete
  514. C|Check
  515. P|Print
  516. .
  517. .SCRIPT MOVE
  518. VÇ@MEDIT TYPE
  519. #BSelect item to move
  520. Vå@$Ç
  521. #BMove to after which item
  522. Vä@$Ç
  523. #M$å~$ä
  524. #BPress any key to continue
  525. Y@$Ç
  526. .
  527. .SCRIPT RENAME
  528. VÇ@MEDIT TYPE
  529. abq
  530. #BSelect item to rename
  531. Vå@$Ç
  532. abq
  533. Vç&S2$å
  534. Vä?Rename '$ç' as what/$ç
  535. abq
  536. #R$å~$ä
  537. -- ???? Need to handle TITLE for frames as well
  538. Y@$Ç
  539. .
  540. .SCRIPT TITLE CHANGE
  541. -- Title change
  542. #BSelect frame to change title of
  543. Vé@C
  544. abq
  545. -- Get old title
  546. Vä&S2$é
  547. Vä&T$ä
  548. -- Get new one
  549. Vä?New title/$ä
  550. #T$é~$ä
  551. q
  552. .
  553. .SCRIPT UNDEL
  554. Vé@Z
  555. abq
  556. pWhat list to undelete to
  557. VÇ@MEDIT TYPE
  558. abq
  559. vÇC;jeFRAME
  560. -- Items
  561. #BInsert after which item
  562. Vä@$Ç
  563. JCOMMON
  564. -- Frame
  565. LFRAME
  566. #BInsert after which frame
  567. Vä@C
  568. -- Common
  569. LCOMMON
  570. #U$é~$ä
  571. .
  572. .SCRIPT Print Frame
  573. L?Ready Printer ! (ESC to cancel)
  574. O51;#PF$1
  575. .
  576. .SCRIPT H_SETUP
  577. q
  578. .
  579. .NOTE EDIT KEYS
  580. Enter                      - Insert new line / break current line
  581. Backspace                  - Delete previous character
  582. Escape or Right Mouse      - Edit menu
  583. LEFT Mouse                 - Position cursor / use scrollbar
  584. Cursor Up,Down,Left,Right  - Prev line, Next line, Prev char, Next char
  585. Home, End                  - Beginning of line, End of line
  586. Ctrl Home, Ctrl End        - Go to start of word, end of word
  587. Page Up, Page Down         - Previous page, Next page
  588. Ctrl PgUp, Ctrl PgDn       - Go to start, end of buffer
  589. Insert                     - Toggle Insert mode
  590. Delete                     - Delete next character
  591. Ctrl Left, Ctrl Right      - Delete to start, end of line
  592. .
  593. .NOTE EDIT CTLKEYS
  594. ^A,^B - open new line After current, Before current
  595. ^E    - Enter EDIT command
  596. ^F    - reformat paragraph
  597. ^J    - Join current line to next line
  598. ^K    - Kill (delete) current line
  599. ^L,^R - Set temporary Left margin, Right margin
  600. ^N    - Write edit buffer to file EDITBUFF.SAV
  601. ^O    - Toggle margins (clear temporary margins)
  602. ^Q    - Quote verbatim character (next char typed)
  603. ^T,^G - Toggle cursor Tracking, Flag interpretation
  604. ^U    - Undelete line
  605. ^V    - Verify (check) buffer
  606. ^W    - Wipe reference flags
  607. ^X,^D - Mark start for inline cut, delete inline
  608. ^Y    - paste in line
  609. ^Z    - duplicate character from mouse position
  610. .
  611. .NOTE EDIT FUNKEYS
  612.       UNSHIFTED     SHIFT (flag as)  CONTROL (insert)  ALTERNATE
  613.  
  614. F1  - Help menu      Frame step    F1  Frame reference   Frame autoref
  615. F2  - Refresh        Frame ref     F2  Global item ref   Global note autoref
  616. F3  - Macro (check)  Global note   F3  Local item ref    Local note autoref
  617. F4  - Swap with mark Local note    F4  Append Frame      Search/replace
  618. F5  - Mark for cut   Global menu   F5  App Global item   Search again
  619. F6  - Cut from mark  Local menu    F6  App Local item    Search for string
  620. F7  - Paste lines    Global Script F7  App File text     Copy to kill buffer
  621. F8  - Symbol shift   Local Script  F8  App Screen file   Paste kill buffer
  622. F9  - QUIT edit      Action        F9  App Screen (att)  DOS Exit
  623. F10 - Save & exit    Input field   F10 App EDITBUFF.SAV  Write PASTE buffer
  624. .
  625. .NOTE GRAPHIC CHARS
  626. GRAPHICS CHARACTERS SHOWING MAPPINGS AVAILABLE IN SYMBOL SHIFT
  627.  
  628. `abcdefghijklmnopqrstuvwxyz+,./{}|  3 4 5 6 7 8 9 = ; : @ < >
  629. αßΓπΣσµτΦΘΩδ∞φε∩≡±≥≤⌠⌡÷≈°∙·½¼«»√²ⁿ  │ ┤ ╡ ╢ ╖ ╕ ╣ ╜ ╗ ║ └ ╝ ╛
  630.  
  631. A B C D E F G H I J K L M N O P Q R S T U V W X Y Z
  632. ┴ ┬ ├ ─ ┼ ╞ ╟ ╚ ╔ ╩ ╦ ╠ ═ ╬ ╧ ╨ ╤ ╥ ╙ ╘ ╒ ╓ ╫ ╪ ┘ ┌
  633.  
  634.   ┌─┬─┐  ZDBD?   ╔═╦═╗  IMKM;   ░  0     U   â ä à å Ä Å á
  635.   ├─┼─┤  CDED4   ╠═╬═╣  LMNM9   ▒  1     N   Ç ç
  636.   │ │ │  3 3 3   ║ ║ ║  : : :   ▓  2     -   é ê ë è É
  637.   └─┴─┘  @DADY   ╚═╩═╝  HMJM<   █  [     M   ï î ì í
  638.                                          A   ¢ £ ¥ ₧ ƒ ⌐ ¬ ¡
  639.   ╒═╤═╕  UMQM8   ╓─╥─╖  VDRD7   ▌  ]     P   ô ö ò Ö ó
  640.   │ │ │  3 3 3   ║ ║ ║  : : :   ▐  ^     P   ü û ù Ü ú
  641.   ╞═╪═╡  FMXM5   ╟─╫─╢  GDWD6   ▀  _     E   æ Æ
  642.   ╘═╧═╛  TMOM>   ╙─╨─╜  SDPD=   ▄  \     D   ÿ ñ Ñ ª º ¿
  643.  
  644. You may select any character directly, by use of the HOME key
  645. .
  646. .NOTE EDIT CODES
  647.  </>    Previous char/Next char         R       Refresh screen
  648.  B/b    Beginning of line/word          E/e     End of line/word
  649.  N/n    Next page/line                  P/p     Prev page/line
  650.  .      Mark start line                 -       Cut from start line
  651.  +      Paste cut lines                 D/d     Delete current/prev char
  652.  Z/z    Delete to start/end of line     K       Delete current line
  653.  U      Undelete line                   J       Join lines
  654.  L      Insert newline char             O/o     open line before/after
  655.  =c     actual character 'c'            V       Verbatim character
  656.  T      Insert TAB character            cxxx    convert line using xxx
  657.  xsspec Execute function string         ssspec  Insert string
  658.  A/a    Autoref global/local            F       Autoref from frame list         
  659.  W      wipe current reference flags    hnspec  Popup note
  660.  ffspec Append file                     iispec  Append item
  661.  tfspec Append text screen              wfspec  Append screen with attributes
  662.  C      Toggle cursor tracking          H       Toggle flag interp
  663.  I      Toggle Insert/Overwrite         S       Toggle symbol shift
  664.  M      Toggle margins                  l/r     Set temp left/right margin
  665.  X      Exit edit with save             Q       Quit edit
  666. .
  667. .NOTE VIEW KEYS
  668.       VIEW MODE KEYS
  669.  
  670. F1         HELP
  671. F2         REFRESH SCREEN
  672. F9 or F0   QUIT ITEM EDIT
  673. .
  674. .MENU Editing
  675. Edit mode     |NEdit Mode
  676. View mode     |NView Mode
  677. Text display  |NText Display
  678. Moving around |NMoving around
  679. Inserting text|NInserting text
  680. Deleting text |NDeleting text
  681. Set margins   |NMargins
  682. Formatting    |NFormatting
  683. Referencing   |NReferencing
  684. Copy / Import |NCopying and Importing
  685. Global search |NSearching and replacing
  686. Key functions |NKey functions
  687. .
  688. .NOTE View Mode
  689.  
  690.  VIEW mode is a variation of ~Nedit mode~E, which
  691.  works in the same way, only does not permit
  692.  the item to be saved, except to a disk file.
  693.  View mode is indicated on the bottom line,
  694.  and by the bottom line being a different
  695.  colour to when in edit mode.
  696.  
  697.  If you press Function key 9 in View mode,
  698.  you will exit to the frame display directly.
  699.  If you accidentally press Function key 10,
  700.  the edit buffer will be saved to the buffer
  701.  save file called EDITBUFF.SAV, and you will
  702.  remain in view mode.
  703.  
  704. .
  705. .NOTE Edit mode
  706.  
  707.  The edit mode provides a full screen editor,
  708.  which permits the insertion, deletion and
  709.  reformatting of text.
  710.  
  711.  [k] ~NEDIT KEYS~Kk~E [c] ~NEDIT CTLKEYS~Kc~E [f] ~NEDIT FUNKEYS~Kf~E
  712.  
  713.  The edits you make in edit mode do not have any
  714.  effect until they are saved. You can optionally
  715.  QUIT out of edit mode if you do not wish to
  716.  save the edited item.
  717.  
  718.  See also: ~NVIEW mode~E
  719.  
  720. .
  721. .NOTE Text display
  722.  The text is displayed in the top 22 lines of the
  723.  screen, flush with the left edge of the screen.
  724.  
  725.  For display items, highlighting and formatting will
  726.  be performed. For other items, the text will be
  727.  shown in its raw form.  All items can be toggled to
  728.  the other state at any time using Function key 4.
  729.  
  730.  The display can be redrawn using the F2 key.
  731.  
  732.  The bottom line of the display shows the type and
  733.  name of the item being edited, the current page and
  734.  line number and the number of pages. It also shows
  735.  the modes and any warnings about the current item.
  736. .
  737. .NOTE Moving around
  738.  The cursor keys are used to move around the text,
  739.  and permit character, word, line and page movement
  740.  in both directions. If a mouse is attached to the
  741.  system, the mouse cursor can be used to position
  742.  the text cursor, using the left mouse button.
  743.  
  744.  If the text is over a page full, a scrollbar is
  745.  shown indicating the current position in the item.
  746.  The up and down arrows at top and bottom of the
  747.  scrollbar can be used to move up and down a screen
  748.  at a time, like the PgUp and PgDn keys.
  749. .
  750. .NOTE Inserting text
  751.  Text is inserted at the current cursor position by typing
  752.  characters. An OVERWRITE mode may be toggled-in to allow
  753.  existing text to be overwritten. The current insertion mode
  754.  is indicated by the cursor shape, as in the string edit
  755.  mode of the reader, a block signifying insert mode and an
  756.  underscore signifying overwrite mode.
  757.  
  758.  The RETURN (or NEWLINE) key is used to start a new line or
  759.  to split a line if the cursor is positioned within it.
  760.  The TAB key inserts a tab character in the current position,
  761.  and uses this to tab to the next tab position.
  762.  
  763.  Special symbols, with codes above decimal 175, are entered
  764.  by use of a special `symbol shift' which is toggled using
  765.  Function Key 8.  When the symbol shift is in effect, all
  766.  characters entered have decimal 128 added to their codes
  767.  before being inserted, also all characters between 128 and
  768.  175 have 128 subtracted from their codes.
  769. .
  770. .NOTE Margins
  771.  Text auto-wraps at column 80, unless a right margin has been
  772.  specified, in which case it wraps at the specified column.
  773.  
  774.  Both global margin settings and temporary margins can be used.
  775.  To toggle the global margins on or off, press the Ctrl-O key.
  776.  
  777.  Temporary left and right margins are brought into effect using
  778.  the Ctrl-L and Ctrl-R keys respectively. To set a left margin,
  779.  start a fresh line, enter spaces etc in the left margin, then
  780.  press Ctrl-L.  The spaces etc will then be entered whenever a
  781.  new line is started.  To set a right margin, simply press
  782.  Ctrl-R when the text cursor is at the position where the
  783.  right margin should be.
  784. .
  785. .NOTE Formatting
  786.  To format existing paragraphs to the current ~Nmargins~E, position the
  787.  text cursor immediately before, or inside, the paragraph and
  788.  press Ctrl-F.  This should stop at the end of the paragraph, but
  789.  may not if the line after the paragraph contains formatting
  790.  flags or inconsistent spaces and tabs.
  791.  
  792.  The reformatting allows for references contained in the text, but
  793.  cannot allow for special formatting or hidden text flags, so it
  794.  should be used with care.
  795.  
  796.  It is a good idea to save your edits before undertaking any
  797.  formatting in case it goes wrong.
  798. .
  799. .NOTE Deleting text
  800.  Text is deleted in a number of ways.  Single characters and line
  801.  breaks can be deleted either side of the cursor using the DELETE
  802.  (or BACKSPACE) key and the cursor pad DEL key.
  803.  
  804.  The current line can be deleted using the Ctrl-K key. The deleted
  805.  line can be re-inserted, at the same or a different location,
  806.  using the Ctrl-U key.
  807.  
  808.  Ranges of lines can be deleted by selecting one end with Function
  809.  key 5, then positioning at the other end of the inclusive range
  810.  and pressing Function key 6.  The deleted lines can be inserted
  811.  elsewhere using Function key 7.
  812.  
  813.  As a range of deleted lines are retained until another item is
  814.  edited, text can be moved between items, using the paste buffer.
  815. .
  816. .NOTE Copying and importing
  817.  Text can be copied from another item into the end of
  818.  the current item, and you can move the required text
  819.  where you want it. The Ctrl shifted Function keys
  820.  provide a range of item types, as follows:-
  821.  
  822.     Ctrl F4  - Frame selected from contents   
  823.     Ctrl F5  - Global item selected from list 
  824.     Ctrl F6  - Local item selected from list  
  825.     Ctrl F7  - Text file                      
  826.     Ctrl F8  - Captured text screen           
  827.     Ctrl F9  - Text screen with attributes    
  828.  
  829.  The append text screen functions allow text screens
  830.  captured from other programs to be imported to the edit
  831.  buffer. The `with attributes' interprets the screen
  832.  attributes and inserts formatting flags to give the
  833.  text the correct colours.
  834. .
  835. .NOTE Referencing
  836.  Reference flags can be inserted in a number of ways.
  837.  
  838.  1. The flag characters can be typed directly into the text at
  839.  the required point. If a line has an incomplete reference in it,
  840.  the editor will flash a `~~' character at the end of the line.
  841.  
  842.  2. Flagging words using the shifted ~NFunction keys~PNKey Functions~E.
  843.  
  844.  3. Adding cross references by selecting the item to be
  845.  referenced from a list. The Control shifted ~NFunction keys~PNKey functions~E
  846.  provide the three main item lists.
  847.  
  848.  4. Automatic referencing is available on the Alt shifted
  849.  ~NFunction keys~PNKey functions~E.
  850.  
  851.  The reference flags can be removed from a string by placing
  852.  the text cursor in the reference and pressing Ctrl-W.
  853.  
  854.  The references for an item can be checked by pressing Ctrl-V.
  855.  
  856. .
  857. .NOTE Searching and replacing
  858.  A search can be made for a string in the edit buffer.
  859.  This is done by pressing Alt shifted F6. This prompts
  860.  for a string, then searches forwards in the buffer
  861.  for that string.
  862.  
  863.  To search again for the same string, the Alt shifted
  864.  F5 key may be pressed.
  865.  
  866.  One operation which is often necessary is to replace
  867.  all occurrences of one string with another. The Alt
  868.  shifted F4 key provides a simple search and replace
  869.  function.
  870. .
  871. .NOTE Key functions
  872.  Function key 1 - Help - Displays a help menu
  873.  Function key 2 - Refresh - Redraws the screen display
  874.  Function key 3 - Check buffer -  Verifies references exist
  875.    and that the number and size of lines do not exceed a limit.
  876.  Function key 4 - Swap -  causes the current position in the
  877.    edit buffer to be swapped with the `marked' line (see below)
  878.  Function key 5 - Mark - Sets a `mark' at the current
  879.    position which is used by other functions (cut, swap).
  880.  Function key 6 - Cut - Cuts all lines from and including the
  881.    `mark' line to the current line, placing them into a paste buffer.
  882.  Function key 7 - Paste - Inserts the lines in the paste buffer
  883.    before the current line.
  884.  Function key 8 - Symbol shift - Toggles symbol shift
  885.    mode. This is used for entering symbol characters.
  886.  Function key 9 - Quit - This abandons the changes made to the item
  887.    and retains the original state of the item.
  888.  Function key 10 - Save and exit - Applies the changes made during
  889.    the edit, and returns to the frame display.
  890.  Alt shifted F9 - DOS Escape - this allows small tasks to be
  891.    performed such as copying a text file.
  892. .
  893. .REMARK 
  894.  
  895. --------------------------- FRAME SECTION ----------------------------------
  896. .
  897. .FRAME Notebook
  898. .TITLE What it provides
  899.       Welcome to the HyperShell Integrated Development Environment.
  900.  
  901.       This example is an interactive introduction to using the IDE
  902.       and to editing and producing your own hypertext material.
  903.  
  904. [1]   ~FOverview~K1~E      Of Notebook hyperfile
  905.  
  906. [2]   ~FTutorial~K2~E      On using the Integrated Development Environment
  907.  
  908.  
  909.       If you intend to work through the tutorial, please ensure that
  910.       you have made a copy of this file in case you accidentally lose
  911.       part of it.
  912.  
  913. [9]   ~FQuit~PQ~K9~E          From IDE, without saving changes
  914.  
  915.  
  916. .
  917. .FRAME Overview
  918. .TITLE Overview
  919.       This section gives a brief overview of the facilities given
  920.       in the Notebook hyperfile.
  921.  
  922.       The notebook hyperfile can be used as the basis for your
  923.       own free format text databases, as it includes readily
  924.       available facilities for a number of general purposes,
  925.       such as the search facilities. A hyperfile produced using
  926.       this can then immediately be used with the reader program,
  927.       and will configure itself to exclude the editing options.
  928.  
  929.       Whilst this hyperfile has pulldown menus to assist with the
  930.       production and maintenance of material, the IDE can be used
  931.       in a number of ways, and the functions provided by these
  932.       pulldown menus can be supplied in other forms.
  933.  
  934.       Firstly, the various pulldown menus are explained.
  935.  
  936. $(next) 
  937. .
  938. .FRAME Menubar
  939. .TITLE Menubar
  940.  
  941.  The pulldown menus on the menu bar provide the following facilities:-
  942.  
  943.    ╔ File operations - Save, quit etc
  944.    ║      ╔ Navigation - next, previous etc
  945.    ║      ║       ╔ Searches, refinement and matching lists
  946.    ║      ║       ║        ╔ Miscellaneous - calcultor, error messages etc
  947.    ║      ║       ║        ║      ╔ Add frames and items
  948.    ║      ║       ║        ║      ║     ╔ Edit frames and items
  949.    ║      ║       ║        ║      ║     ║      ╔ View, rename, delete etc
  950.    ║      ║       ║        ║      ║     ║      ║       ╔ Help notes
  951.    ║      ║       ║        ║      ║     ║      ║       ║
  952.    ║      ║       ║        ║      ║     ║      ║       ║
  953.  1 ╩    2 ╩    3  ╩     4  ╩    5 ╩   6 ╩    7 ╩     8 ╩
  954.  ~M ~TwF~TKile ~PFFile~K1~E ~M ~TwG~TKoto ~PFGoto~K2~E ~M ~TwS~TKearch ~PFSearch~K3~E ~M ~TwO~TKther ~PFOther~K4~E ~M ~TwA~TKdd ~PFAdd~K5~E ~M ~TwE~TKdit ~PFEdit~K6~E ~M ~TwM~TKaint ~PFMaint~K7~E ~M ~TwH~TKelp ~PFHelp~K8~E  Hyper Notebook
  955. ╔══╧═════╧═══════╧════════╧══════╧══════╧══════╧═══════╧════════════════════╗
  956. ╚╡~DU ~Tw frame name - frame title ~C72~DV<*>~DU~Z~C76~DT╞╝
  957.  
  958.  Select the number by the menu to obtain more information about it
  959. .
  960. .FRAME File
  961. .TITLE File operations
  962.  
  963.   Option         Function
  964.  
  965.   Notebook       A note about the notebook
  966.   Type file      Type a text file
  967.   ───────────
  968.   Command        Do a DOS command (eg. a DIR listing)
  969.   DOS shell      Temporary exit to DOS (allowing later return)
  970.   ───────────
  971.   Save to TMP    Save to temporary file
  972.   Exit (save)    Save edits and exit
  973.   Quit           Quit without saving
  974.  
  975. $(next)
  976. .
  977. .FRAME Goto
  978. .TITLE Navigation, contents lists etc.
  979. ~i4    Option             Function
  980.  
  981. Contents list     Full contents list
  982. From current      Starting from the current frame
  983. Starting with     Frame name starting with the entered string
  984.  ──────────────
  985. Next frame        Next frame
  986. Matching frame    Next matching frame
  987. Previous frame    Previous frame
  988. Home frame        First frame in hyperfile
  989.  ──────────────
  990. Backtrack one     Step back one frame
  991. Unwind backtrack  Step back directly to a previous frame
  992. Revisit frame     Revisit a frame without winding back
  993.  ──────────────
  994. View noted ref    Noted reference selection 
  995.  
  996. $(next)
  997. .
  998. .FRAME Search
  999. .TITLE Location of information
  1000. ~i4    Option            Function
  1001.  
  1002. Title search      Search titles for string
  1003. Search Text       Search titles and text of frames
  1004. Pick and search   Allow selection of word for search using mouse
  1005. ────────────────
  1006. Add to search     Further search to add extra frames
  1007. Refine search     Refine current matching frame list
  1008. ────────────────
  1009. Matched flag ±    Toggle match flag on current frame
  1010. ────────────────
  1011. Next matching     Next matching frame
  1012. List matching     Contents list of matched frames
  1013. Unmatched list    List unmatched frames only
  1014. ────────────────
  1015. Global items      List of global items
  1016. Items (Local)     List of local items
  1017.  
  1018. $(next)
  1019. .
  1020. .FRAME Other
  1021. .TITLE Miscellaneous
  1022. ~i4    Option          Function
  1023.  
  1024. Local notes    Menu of local notes
  1025. Global notes   Menu of global notes
  1026. Calculator     Simple calculator
  1027. Print frame    Print current frame
  1028. Set colours    Set colour scheme
  1029. Error text     Display text of last error
  1030. Action         Perform action
  1031.  
  1032. $(next)
  1033. .
  1034. .FRAME Add
  1035. .TITLE Creating new items
  1036. ~i4
  1037. Option       Function
  1038.  
  1039. Frame        Add a new frame
  1040. Global Item  Add a global item such as a note
  1041. Local Item   Add a local item such as a note
  1042. Text file    Create a text file
  1043.  
  1044. $(next)
  1045. .
  1046. .FRAME Edit
  1047. .TITLE Maintain items
  1048. ~i4    Option        Function
  1049.  
  1050. Current frame  Edit the current frame
  1051. Frame          Edit a frame selected from a contents list
  1052. Global Item    Edit a global item selected from a list
  1053. Local Item     Edit a local item selected from a list
  1054. Text file      Edit a text file
  1055. Header         Edit the header text
  1056. Edit Footer    Edit the footer text
  1057.  
  1058. $(next)
  1059. .
  1060. .FRAME Maint
  1061. .TITLE Miscellaneous editing
  1062. ~i4
  1063. Option        Function
  1064.  
  1065. View item     Enter view mode for item
  1066. Rename item   Change name of frame or item
  1067. Title change  Change title of frame
  1068. Delete item   Delete frame or item
  1069. Whats deleted See whats on the deleted list
  1070. Undelete item Recall deleted item
  1071. Move item     Move frame or item in list
  1072. Print item    Print frame or item
  1073. Check item    Check frame or item
  1074. Full Check    Do check scan of frames or items
  1075.  
  1076. $(next)
  1077. .
  1078. .FRAME Help
  1079. .TITLE Using the notepad
  1080. ~i4
  1081. Option         Function
  1082.  
  1083. Selecting      Navigation
  1084. Key mappings   Default key mappings
  1085. Funct. keys    Function key mappings
  1086. Menu bar       Using the menu bar
  1087. Information    Current status information
  1088. Colour key     Colours of references
  1089. Paged lists    Help menu for paged mode
  1090. Editing mode   Help menu for editing operations
  1091.  
  1092. $(next)
  1093. .
  1094. .FRAME Using the editor
  1095. .TITLE Modifying text
  1096. ~i4    The ~Nedit mode~E is a built-in full screen editor used for
  1097. creating and modifying text. It is itself configurable, as the
  1098. functions mapped to the control keys can be changed to suit
  1099. individual preferences. This example uses the default mappings.
  1100.  
  1101. The edit mode allows frames, notes, scripts and other items to
  1102. be edited. When the editing is complete, you can exit from edit
  1103. mode, whereupon the changes are immediately available, or quit
  1104. from the edit mode to retain the previous item contents. The
  1105. set of changes made within a IDE session can then globally be
  1106. applied to the hyperfile, or discarded by quitting. There are
  1107. therefore two levels of saving to be considered. There is a more
  1108. advanced form of incremental file modification which is not
  1109. covered here, but is described in the full documentation.
  1110.  
  1111. $(next)
  1112. .
  1113. .FRAME Try it out
  1114. .TITLE Lets do some editing
  1115.     Well, the best way of learning about something is to jump
  1116.     straight in and try it out.
  1117.  
  1118.     The next few frames show you how to do the basic editing
  1119.     operations.
  1120.  
  1121.     You can then try the other facilities provided by the pulldown
  1122.     menus on the ~FMenubar~E. Remember that the ~FFile~E menu can be used
  1123.     to either abandon the changes you have made, or to save them.
  1124.     You could work through the various options one at a time so
  1125.     that you understand what they do.
  1126.  
  1127.     After you have added a few frames of your own, with references
  1128.     of different kinds, why not run the 'full check' from the maint
  1129.     menu against the frames to see if there are any problems. The
  1130.     Ctrl-V key combination can be used in edit mode to check out
  1131.     the item currently being edited.
  1132.  
  1133. $(next)
  1134. .
  1135. .FRAME Tutorial
  1136. .TITLE using the editing facilities
  1137.     Here are some exercises to allow you to learn how to use
  1138.     the integrated environment.
  1139.  
  1140. [1] ~FEditing~P#EFExample frame~K1~E - Using the ~Nedit mode~E
  1141.  
  1142.     The edit mode is used for creating and modifying frames,
  1143.     notes, scripts and other HyperShell items.
  1144.  
  1145. [2] ~FAdding a frame~K2~E - Expanding the hyperfile.
  1146.  
  1147.     A frame is the named set of text about a particular topic
  1148.     normally displayed by HyperShell. This frame, called 'tutorial'
  1149.     is an example.
  1150.  
  1151. [3] ~FAdding a note~K3~E - and its reference
  1152.  
  1153.     A ~nNote~E is a temporary popup block of supporting information.
  1154. $(next)
  1155. .
  1156. .NOTE Note
  1157. The note is a useful way of
  1158. giving brief explanations of
  1159. technical terms.
  1160.  
  1161. It can be used for help text
  1162. or for simple single field
  1163. data entry boxes.
  1164.  
  1165. Name: ~I~W15~PpHello %s~E~Q
  1166. .
  1167. .FRAME Adding a frame
  1168. .TITLE Creating a new frame of text
  1169. ~i4    We will now add a new frame in the notebook hyperfile.
  1170.  
  1171. To do this, just press 'a' (for ~FAdd~E) then 'f' (for Frame).
  1172. The 'a' key selects the Add menu, and the 'f' key selects
  1173. the frame option of that menu.
  1174.  
  1175. After you press these, you will be prompted for the name
  1176. of the frame. This can be a short name of up to 20 characters.
  1177.  
  1178. You will then be prompted for a title, which can be a longer
  1179. description of the frame - up to 35 or so characters.
  1180.  
  1181. You will then be asked where the frame is to be positioned
  1182. in the hyperfile, and you can ~Nselect~PNSelecting~E the frame after which
  1183. the new one should be inserted.
  1184.  
  1185. You will then enter ~Nedit mode~E, within which you can enter
  1186. the text for the frame.
  1187.  
  1188. Do this now, and when you are in edit mode, press F1 for help.
  1189. .
  1190. .FRAME Adding a note
  1191. .TITLE Adding a popup note item
  1192. ~i4    To add a global note, the procedure is similar to adding a
  1193. frame. Press 'a' (for ~FAdd~E) then 'g' (for Global) and 'n'
  1194. (for Note).
  1195.  
  1196. After you press these, you will be prompted for the name
  1197. of the note. This can be a short name of up to 20 characters.
  1198.  
  1199. You will then be asked where the note is to be positioned
  1200. in the list of global items, and you can ~Nselect~PNSelecting~E the item
  1201. after which the new one should be inserted.
  1202.  
  1203. You will then enter ~Nedit mode~E, within which you can enter
  1204. the text for the note.
  1205.  
  1206. The note text should be kept to roughly rectangular shape.
  1207. When displayed, it will be surrounded by a box of the
  1208. correct size.
  1209.  
  1210. Lets look at references now:-
  1211. $(next)
  1212. .
  1213. .FRAME References
  1214. .TITLE Links and actions
  1215. ~i4
  1216. References are links from the displayed text to other items
  1217. of text, such as frames and popup notes, to various ~Factions~E
  1218. such as running another program, and for the entry of data.
  1219.  
  1220. A frame reference is encoded in the text as:-
  1221.  
  1222.   ~~FFrame name~~E,
  1223.  
  1224. which displays as:-
  1225.  
  1226.   ~FFrame Name~PpThis normally displays a frame~E
  1227.  
  1228. The highlighting indicates that the reference can be selected.
  1229.  
  1230. Now lets see how to add a reference~E to link in the note we
  1231. created above.
  1232. $(next)
  1233. .
  1234. .FRAME Adding a reference
  1235. .TITLE Linking frames and notes
  1236. ~i4
  1237. Now we will add a ~Freference~PFreferences~E from the frame to the note.
  1238. Press 'E'dit 'F'rame and select the frame you added.
  1239.  
  1240. Move to a position in the frame where you want the reference
  1241. to the note adding.
  1242.  
  1243. Then press ESCape to pop the edit menu up and select the
  1244. Insert Ref option - then the Global Item option - then the
  1245. note which you added earlier.
  1246.  
  1247. Press F10 to save the edited frame, then move to the frame
  1248. using the contents list (Function key 2).
  1249.  
  1250. You should then be able to select the highlighted reference.
  1251.  
  1252. Next, lets learn about ~Fvariables~E.
  1253. $(next)
  1254. .
  1255. .FRAME Variables
  1256. .TITLE Containers for information
  1257. ~i4
  1258. Variables are an extremely useful feature of HyperShell.
  1259.  
  1260. [1]  ~FVariable tokens~K1~E
  1261.  
  1262.      Explains what variables are, and how to use them.
  1263.  
  1264. [2]  ~FVariable assignment~K2~E
  1265.  
  1266.      Explains about storing information in variables.
  1267. $(next)
  1268. .
  1269. .FRAME Variable tokens
  1270. .TITLE Using variables to hold information
  1271. ~i4    A variable is a named container for information such as a text
  1272. string or a number. HyperShell treats variables as substitution
  1273. strings, as in other 'shell' programs. What this means is that
  1274. when an instance of a variable token is placed in text or in an
  1275. action string, it is replaced by the value of the variable.
  1276.  
  1277. So, if variable L has a value of 'Larch' ~Fassigned~PFVariable assignment~E to it, the string:-
  1278.  
  1279.   Number 1, the $$L
  1280. would appear in text display as
  1281.   Number 1, the Larch
  1282.  
  1283. The variable token is the $$ symbol, followed by the variable name.
  1284. For 'named' variables, ie. those with a name longer than one letter,
  1285. the name is provided within parentheses:-   The $$(tree)
  1286.  
  1287. $(next)
  1288. .
  1289. .FRAME Variable assignment
  1290. .TITLE Giving a value to a variable
  1291. ~i4    A variable can have a value assigned to it using the action 'V':-
  1292.  
  1293. VFPineapple
  1294.  
  1295. This puts the string 'Pineapple' in variable F. If you assign a
  1296. different value to a variable, this replaces the previous value. 
  1297.  
  1298. A named variable uses the action 'ZV' for a simple assignment:-
  1299.  
  1300. ZVFruit=Banana
  1301.  
  1302. The variable 'Fruit' has the string 'Banana' loaded in it.
  1303.  
  1304. There are a set of 'system' variables, maintained by HyperShell,
  1305. which cannot have values assigned to them, but provide such
  1306. information as the current frame name, the date, etc. eg.
  1307.  
  1308. Date($$4) = $4,  Title($$2) = $2
  1309. $(next)
  1310. .
  1311. .FRAME Variable examples
  1312. .TITLE using variables
  1313. ~i4
  1314. So, why not assign a variable and expand it. The variable named
  1315. 'x' has its token coded in this box -> [$x].
  1316.  
  1317. This will probably be empty, as it does not yet have a value.
  1318. Press F8, then enter the action string:-
  1319.  
  1320. VxExcalibur
  1321.  
  1322. Then press END to refresh the frame display, and the value
  1323. should be displayed in the box.
  1324.  
  1325. Also, press F8 and enter the action string:-
  1326.  
  1327. ZVname=Your Name;y
  1328.  
  1329. Your name is $(name)
  1330.  
  1331. $(next)
  1332. .
  1333. .FRAME Actions
  1334. .TITLE HyperShell commands
  1335. ~i4    HyperShell commands are known as actions. The action is coded in
  1336. HyperShell as an action code (of one or two characters), followed
  1337. by parameters.
  1338.  
  1339. The action code tells HyperShell what to do, and the parameters
  1340. give further information about the command. For example, the
  1341. action:-
  1342.  
  1343. NDeciduous trees
  1344.  
  1345. Displays a note called 'Deciduous trees'.
  1346.  
  1347. The parameter can be a 'literal' string, as in the above example,
  1348. or the result of some other operation, known as an ~Faction modifier~E.
  1349.  
  1350. The parameter can also be provided using a ~Fvariable token~PFvariable tokens~E.
  1351. $(next)
  1352. .
  1353. .FRAME action modifier
  1354. .TITLE providing a parameter for an action
  1355. ~i4
  1356. An action modifier is similar to a 'function' in a programming
  1357. language. It is something which provides a string as a result.
  1358. For example, the prompted input action modifier is coded as
  1359. the ? character followed by a prompt:-
  1360.  
  1361. N?Which note
  1362.  
  1363. The '?Which note' string causes a prompt to be issued, and then
  1364. accepts a string typed by the user, which forms the result of the
  1365. function. So, if the user typed 'Meadow flowers', the note called
  1366. Meadow flowers would be displayed.
  1367.  
  1368. There are a number of different types of action modifier. One of
  1369. these, the ~Fdynamic menu~E can itself have its parameters supplied
  1370. from a further action modifier.
  1371. $(next)
  1372. .
  1373. .FRAME dynamic menu
  1374. .TITLE instant selection lists
  1375. ~i4    The dynamic menu is a 'dynamic' list of options presented to
  1376. the user for selection. These are 'dynamic' because they are
  1377. produced when you issue the command, rather than you having
  1378. to code them explicitly. For instance, the dynamic menu:-
  1379.  
  1380. T@d*.TXT
  1381.  
  1382. Will display a file selection list of those files in the current
  1383. directory with an extension of 'TXT'. When a file name is selected,
  1384. it will be returned as the result of the action modifier, providing
  1385. the parameter to the 'T' action, which displays the selected file.
  1386.  
  1387. A dynamic menu can have a further ~Faction modifier~E coded to
  1388. supply its parameter:-
  1389.  
  1390. @D?Wildcard file specification
  1391.  
  1392. This allows the user to decide which set of files to select from.
  1393. $(next)
  1394. .
  1395. .FRAME Example actions
  1396. .TITLE and action modifiers
  1397.     Try pressing F8 and entering each of these action strings:-
  1398.  
  1399.     ~AVx?Name~PZL3~E   Select this for more detail
  1400. ~h3    ^ ^------ '?' = prompt for input, using 'Name' as prompt 
  1401. ~h3    |-------- 'V' = Load variable (x) with string entered by user
  1402.  
  1403.       Asks for a name, then loads it into variable 'x'.
  1404.  
  1405.     ~AT@d*.HIX~PZL4~E  Select this for more detail
  1406. ~h4    ^ ^------ '@d' = menu of files matching wildcard *.HIX
  1407. ~h4    |-------- 'T'  = display selected file
  1408.  
  1409.       Allows selection of a .HIX file, which it then displays.
  1410.  
  1411.     ~AP&L$$x~PZL5~E     Select this for more detail
  1412. ~h5    ^^ ^----- '$$x' = contents of variable 'x'
  1413. ~h5    ||------- '&L'  = length of following string (= length of variable)
  1414. ~h5    |-------- 'P'   = Pop up message showing result (length)
  1415.  
  1416.       Pops up a number which is the length of the name entered above.
  1417.  
  1418.     ~AA@C~PZL6~E       Select this for more detail
  1419. ~h6    ^^------- '@C' = Paged contents list allowing selection of frame
  1420. ~h6    |-------- 'A'  = Do result as action (result will be Fframename or null)
  1421.  
  1422.       The contents list selection action. (This is what F2 does)
  1423. $(next)
  1424. .
  1425. .FRAME Features
  1426. .TITLE of Note Book editor
  1427.    *   Editing of frames, notes and other control items.
  1428.  
  1429.    *   Item level and file level checking of syntax and cross references.
  1430.  
  1431.    *   Frame and item text output direct to printer or to a file.
  1432.  
  1433.    *   Menus for selection of items, searches and check scans.
  1434. .
  1435. .FRAME Example frame
  1436. .TITLE For editing
  1437. You are now in EDIT MODE (assuming you got here from the TUTORIAL
  1438. frame - if you didn't, you are probably not in edit mode, so ignore
  1439. the rest of this frame and go ~Fsomewhere else~PFTutorial~E).
  1440.  
  1441. Press F1 for editing help. Try moving the cursor around the screen
  1442. using the cursor keys, and typing new text in. Also try using the
  1443. DEL key to delete text. Then look at the help notes to find some
  1444. other text editing commands. Try deleting this block of text.
  1445.  
  1446. Try pressing the ESCape key for the edit menu, and then select
  1447. 'Insert ref; from it, then 'Frame ref'. Select a frame from the
  1448. list and its reference will be inserted in the text. If you look
  1449. at the bottom line, you will see the reference flags around the
  1450. reference you inserted. This is a reference as well -> ~FTutorial~E
  1451.  
  1452. To exit back to the tutorial frame, press Function key 9.
  1453. This will throw away the changes that you made to the frame.
  1454. To save the changes and exit, which is what you will normally
  1455. do after editing, press F10 instead.
  1456. .
  1457.