Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Newer
Older
100644 123 lines (111 sloc) 2.924 kB
479997e @docelic - Makefile: tuning
docelic authored
1 __NAME__ purpose
4a7a05a @racke new scratch attribute documented
racke authored
2 process page and save output to file and/or scratch variable
479997e @docelic - Makefile: tuning
docelic authored
3 __END__
4
5 __NAME__ missing
6 Explain what is expiry= parameter and how touch= affects it.
7 __END__
8
9
10 __NAME__ synopsis
11 <row>
12 <entry>
13 <arg choice='plain'>page</arg>
14 </entry>
15 <entry>Yes</entry><entry>Yes</entry>
16 <entry></entry>
087ca8c @docelic Not a large commit: just looks big.
docelic authored
17 <entry>Name of the &IC; page to process (as if the user visited
479997e @docelic - Makefile: tuning
docelic authored
18 it with the browser).</entry>
19 </row>
20 <row>
21 <entry>
22 <arg choice='plain'>file</arg>
23 </entry>
24 <entry>Yes</entry><entry>Yes</entry>
25 <entry></entry>
26 <entry>
27 File to dump contents to.
28 </entry>
29 </row>
30 <row>
31 <entry>
4a7a05a @racke new scratch attribute documented
racke authored
32 <arg choice='plain'>scratch</arg>
33 </entry>
34 <entry></entry><entry></entry>
35 <entry></entry>
36 <entry>
37 Store contents in this &glos-scratch; variable.
38 </entry>
39 </row>
40 <row>
41 <entry>
479997e @docelic - Makefile: tuning
docelic authored
42 <arg choice='plain'>scan</arg>
43 </entry>
44 <entry></entry><entry></entry>
45 <entry></entry>
46 <entry>Specifies the search string and reproduces a search
47 results page.</entry>
48 </row>
49 <row>
50 <entry>
51 <arg choice='plain'>auto_create_dir</arg>
52 </entry>
53 <entry></entry><entry></entry>
54 <entry>0</entry>
55 <entry>Create directory path to the dump file?</entry>
56 </row>
57 <row>
58 <entry>
59 <arg choice='plain'>expiry</arg>
60 </entry>
61 <entry></entry><entry></entry>
62 <entry></entry>
087ca8c @docelic Not a large commit: just looks big.
docelic authored
63 <entry>See if file Modification time is newer than expiry deadline.</entry>
479997e @docelic - Makefile: tuning
docelic authored
64 </row>
65 <row>
66 <entry>
67 <arg choice='plain'>touch</arg>
68 </entry>
69 <entry></entry><entry></entry>
70 <entry>0</entry>
71 <entry>If the file is expired, touch it?</entry>
72 </row>
a23b3b8 @docelic - docbook/literals.ent:
docelic authored
73 &ROW_UMASK_none;
6ec10b8 @docelic * fix interpolate/reparse attributes for about the first
docelic authored
74 &TAG_NON_CONTAINER;
479997e @docelic - Makefile: tuning
docelic authored
75 __END__
76
77 __NAME__ description
78 This tag processes the page (as if the user visited it with the browser),
6445a04 @docelic Large commit.
docelic authored
79 and writes contents to disk. This is usually called from &glos-jobs; but of
d9f83a1 @docelic - Weeding out <glossterm>s and replacing with entities pointing to gl…
docelic authored
80 course, nothing enforces this.
479997e @docelic - Makefile: tuning
docelic authored
81 </para><para>
82 The tag is able to reproduce both standard and search results pages.
087ca8c @docelic Not a large commit: just looks big.
docelic authored
83 <!-- XXX link 'search results' -->
479997e @docelic - Makefile: tuning
docelic authored
84 </para><para>
85 This is similar to the output you could get from
087ca8c @docelic Not a large commit: just looks big.
docelic authored
86 <userinput>lynx -source</userinput> or <userinput>w3m -dump_source</userinput>
479997e @docelic - Makefile: tuning
docelic authored
87 commands.
88 __END__
89
90
a341a44 @docelic - refs/*: Some news regarding (especially glossary) linking:
docelic authored
91 __NAME__ notes
6445a04 @docelic Large commit.
docelic authored
92 See the &glos-umask; glossary entry.
a341a44 @docelic - refs/*: Some news regarding (especially glossary) linking:
docelic authored
93 __END__
94
95
a23806c @docelic Fix the rest of items to adhere to new syntax in Example sections
docelic authored
96 __NAME__ example: Basic static page example
97 Create page named <filename>make-static.html</filename> with the following
98 content:
99 <programlisting>
100 [capture-page page=index file=static/index.html umask=022 auto_create_dir=1]
101 </programlisting>
102 This would create the <filename class='directory'>static/</filename>
103 directory in your catalog root, and a snapshot of
104 <filename>index.html</filename> in it.
479997e @docelic - Makefile: tuning
docelic authored
105 __END__
106
a23806c @docelic Fix the rest of items to adhere to new syntax in Example sections
docelic authored
107 __NAME__ example2: Static page example using scan=
108 Create page named <filename>make-static2.html</filename> with the following
109 content:
110 <programlisting>
479997e @docelic - Makefile: tuning
docelic authored
111 [loop list="Levels,Rulers,Squares"]
112 [capture-page page="[loop-code]" file="static/cats/[loop-code].html"
113 scan="fi=products/st=db/co=yes/sf=category/se=[loop-code]"
114 auto_create_dir=1]
115 [/loop]
a23806c @docelic Fix the rest of items to adhere to new syntax in Example sections
docelic authored
116 </programlisting>
479997e @docelic - Makefile: tuning
docelic authored
117 __END__
118
119 __NAME__ author
120 &racke;, &ICDEVGROUP;
121 __END__
122
Something went wrong with that request. Please try again.