ViewVC Help
View File | Revision Log | Show Annotations | Root Listing
root/cvsroot/COMP/SCRAM/doc/html/node84.html
Revision: 1.1
Committed: Mon Nov 18 17:50:02 2002 UTC (22 years, 6 months ago) by sashby
Content type: text/html
Branch: MAIN
CVS Tags: V1_pre0, V0_19_7
Branch point for: SCRAM_V1_BRANCH
Log Message:
Generated and added HTML documentation.

File Contents

# User Rev Content
1 sashby 1.1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
2    
3     <!--Converted with jLaTeX2HTML 2002 (1.62) JA patch-1.4
4     patched version by: Kenshi Muto, Debian Project.
5     LaTeX2HTML 2002 (1.62),
6     original version by: Nikos Drakos, CBLU, University of Leeds
7     * revised and updated by: Marcus Hennecke, Ross Moore, Herb Swan
8     * with significant contributions from:
9     Jens Lippmann, Marek Rouchal, Martin Wilck and others -->
10     <HTML>
11     <HEAD>
12     <TITLE>8. Miscellaneous Items</TITLE>
13     <META NAME="description" CONTENT="8. Miscellaneous Items">
14     <META NAME="keywords" CONTENT="SCRAM">
15     <META NAME="resource-type" CONTENT="document">
16     <META NAME="distribution" CONTENT="global">
17    
18     <META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=iso-8859-1">
19     <META NAME="Generator" CONTENT="jLaTeX2HTML v2002 JA patch-1.4">
20     <META HTTP-EQUIV="Content-Style-Type" CONTENT="text/css">
21    
22     <LINK REL="STYLESHEET" HREF="SCRAM.css">
23    
24     <LINK REL="next" HREF="node85.html">
25     <LINK REL="previous" HREF="node82.html">
26     <LINK REL="up" HREF="SCRAM.html">
27     <LINK REL="next" HREF="node85.html">
28     </HEAD>
29    
30     <BODY bgcolor="beige" >
31     <!--Navigation Panel-->
32     <A NAME="tex2html1540"
33     HREF="node85.html">
34     <IMG WIDTH="37" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="next"
35     SRC="file:/usr/share/latex2html/icons/next.png"></A>
36     <A NAME="tex2html1534"
37     HREF="SCRAM.html">
38     <IMG WIDTH="26" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="up"
39     SRC="file:/usr/share/latex2html/icons/up.png"></A>
40     <A NAME="tex2html1528"
41     HREF="node83.html">
42     <IMG WIDTH="63" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="previous"
43     SRC="file:/usr/share/latex2html/icons/prev.png"></A>
44     <A NAME="tex2html1536"
45     HREF="node2.html">
46     <IMG WIDTH="65" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="contents"
47     SRC="file:/usr/share/latex2html/icons/contents.png"></A>
48     <A NAME="tex2html1538"
49     HREF="node85.html">
50     <IMG WIDTH="43" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="index"
51     SRC="file:/usr/share/latex2html/icons/index.png"></A>
52     <BR>
53     <B> Next:</B> <A NAME="tex2html1541"
54     HREF="node85.html">Index</A>
55     <B> Up:</B> <A NAME="tex2html1535"
56     HREF="SCRAM.html">SCRAM</A>
57     <B> Previous:</B> <A NAME="tex2html1529"
58     HREF="node83.html">7.1 Version V0_19_7</A>
59     &nbsp <B> <A NAME="tex2html1537"
60     HREF="node2.html">Contents</A></B>
61     &nbsp <B> <A NAME="tex2html1539"
62     HREF="node85.html">Index</A></B>
63     <BR>
64     <BR>
65     <!--End of Navigation Panel-->
66    
67     <H1><A NAME="SECTION00900000000000000000">
68     8. Miscellaneous Items</A>
69     </H1>
70     <A NAME="1911"></A>
71     For users of the text editing environment <TT>Emacs</TT>, the
72     following <TT>lisp</TT> code can be added to the startup file <TT>.emacs</TT>
73     to create a <TT>ToolDoc</TT> template in a buffer, ready for editing:
74    
75     <P>
76     <PRE>
77     (defun insert-tool-template ()
78     "Add a template for a new tool file. Change TOOLNAME and URLSTRING to suit."
79     (interactive)
80     (insert "&lt;doc type=BuildSystem::ToolDoc version=1.0&gt;\n"
81     "&lt;Tool name=TOOLNAME version=1.0&gt;\n"
82     "&lt;info url=URLSTRING&gt; Web-based information.&lt;/info&gt;\n"
83     "&lt;Lib name=XXXX&gt;\n"
84     "&lt;Client&gt;\n"
85     "&lt;Environment name=toolname_BASE &gt;\n"
86     "Put some useful information here.\n"
87     "&lt;/Environment&gt;\n"
88     "&lt;Environment name=LIBDIR default=\"DEFAULTVALUE\" type=lib&gt;"
89     "&lt;/Environment&gt;\n"
90     "&lt;Environment name=INCLUDE default=\"DEFAULTVALUE\" &gt;&lt;/Environment&gt;\n"
91     "&lt;/Client&gt;\n"
92     "&lt;Environment name=LD_LIBRARY_PATH value=$LIBDIR type=Runtime_path&gt;"
93     "&lt;/Environment&gt;\n"
94     "&lt;/Tool&gt;\n"
95     ))
96     </PRE><FONT SIZE="-1"></FONT>
97     <P>
98     Bind this function to a keystroke in your favourite editing mode. For
99     example, if you want to use this in <TT>text</TT> mode, add
100    
101     <P>
102     <PRE>
103     (add-hook 'text-mode-hook
104     (function (lambda ()
105     (define-key text-mode-map "\C-ct" 'insert-tool-template)
106     )))
107     </PRE>
108     <P>
109     in your <TT>.emacs</TT> file to bind the function to the sequence of
110     keys <TT>Ctrl-c t</TT>.
111    
112     <P>
113     <BR><HR>
114     <ADDRESS>
115     scram-developers@cern.ch
116     </ADDRESS>
117     </BODY>
118     </HTML>