File: helpview.gd

package info (click to toggle)
gap 4r8p6-2
  • links: PTS
  • area: main
  • in suites: stretch
  • size: 33,476 kB
  • ctags: 7,663
  • sloc: ansic: 108,841; xml: 47,807; sh: 3,628; perl: 2,342; makefile: 796; asm: 62; awk: 6
file content (40 lines) | stat: -rw-r--r-- 1,542 bytes parent folder | download | duplicates (4)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
#############################################################################
##  
#W  helpview.gd                 GAP Library                      Frank Lübeck
##  
##  
#Y  Copyright (C)  2001,  Lehrstuhl D für Mathematik,  RWTH Aachen,  Germany
#Y  (C) 2001 School Math and Comp. Sci., University of St Andrews, Scotland
#Y  Copyright (C) 2002 The GAP Group
##  
##  The  files  helpview.g{d,i} contain the configuration mechanism  for  the
##  different help viewer.
##  

##  <#GAPDoc Label="HELP_VIEWER_INFO">
##  <ManSection>
##  <Var Name="HELP_VIEWER_INFO"/>

##  <Description>
##  The record <Ref Var="HELP_VIEWER_INFO"/> contains one component for each
##  help viewer. Each such component is a record with two components:
##  <C>.type</C> and <C>.show</C>.
##  <P/>
##  The component <C>.type</C> refers to one of the <C>type</C>s recognized 
##  by the <C>HelpData</C> handler function explained in the previous 
##  section (currently one of <C>"text"</C>, <C>"url"</C>, <C>"dvi"</C>, 
##  or <C>"pdf"</C>).
##  <P/>
##  The component <C>.show</C> is a function which gets as input the result
##  of a corresponding <C>HelpData</C> handler call, if it was not <K>fail</K>. 
##  This function has to perform the actual display of the data. (E.g., by 
##  calling a function like <Ref Func="Pager"/> or by starting up an external 
##  viewer program.)
##  </Description>
##  </ManSection>
##  <#/GAPDoc>
DeclareGlobalVariable("HELP_VIEWER_INFO");

DeclareGlobalFunction("FindWindowId");
DeclareGlobalFunction("SetHelpViewer");