Skip to content

Commit 20c3f52

Browse files
gustafngustafn
committed
updated documentation
1 parent 8980e0d commit 20c3f52

166 files changed

Lines changed: 2302 additions & 1555 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎packages/acs-core-docs/www/acs-admin.adp‎

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11

2-
<property name="context">{/doc/acs-core-docs/ {ACS Core Documentation}} {Part II. Administrator&#39;s Guide}</property>
3-
<property name="doc(title)">Part II. Administrator&#39;s Guide</property>
2+
<property name="context">{/doc/acs-core-docs/ {ACS Core Documentation}} {Part II. Administrator&#39;s
3+
Guide}</property>
4+
<property name="doc(title)">Part II. Administrator&#39;s
5+
Guide</property>
46
<master>
57
<style>
68
div.sect2 > div.itemizedlist > ul.itemizedlist > li.listitem {margin-top: 16px;}
@@ -12,7 +14,8 @@ div.sect3 > div.itemizedlist > ul.itemizedlist > li.listitem {margin-top: 6px;}
1214
rightLink="install-overview" rightLabel="Next">
1315
<div class="part">
1416
<div class="titlepage"><div><div><h1 class="title">
15-
<a name="acs-admin" id="acs-admin"></a>Part II. Administrator&#39;s Guide</h1></div></div></div><div class="toc">
17+
<a name="acs-admin" id="acs-admin"></a>Part II. Administrator&#39;s
18+
Guide</h1></div></div></div><div class="toc">
1619
<p><strong>Table of Contents</strong></p><dl class="toc">
1720
<dt><span class="chapter"><a href="install-overview">2.
1821
Installation Overview</a></span></dt><dd><dl>
@@ -101,8 +104,8 @@ Information</a></span></dt><dt><span class="section"><a href="install-resources"
101104
</div>
102105
<include src="/packages/acs-core-docs/lib/navfooter"
103106
leftLink="release-notes" leftLabel="Prev" leftTitle="OpenACS Release Notes"
104-
rightLink="install-overview" rightLabel="Next" rightTitle="Chapter 2. Installation
105-
Overview"
107+
rightLink="install-overview" rightLabel="Next" rightTitle="
108+
Chapter 2. Installation Overview"
106109
homeLink="index" homeLabel="Home"
107110
upLink="index" upLabel="Up">
108111

‎packages/acs-core-docs/www/acs-package-dev.adp‎

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11

2-
<property name="context">{/doc/acs-core-docs/ {ACS Core Documentation}} {Part III. For OpenACS Package Developers}</property>
3-
<property name="doc(title)">Part III. For OpenACS Package Developers</property>
2+
<property name="context">{/doc/acs-core-docs/ {ACS Core Documentation}} {Part III. For OpenACS Package
3+
Developers}</property>
4+
<property name="doc(title)">Part III. For OpenACS Package
5+
Developers</property>
46
<master>
57
<style>
68
div.sect2 > div.itemizedlist > ul.itemizedlist > li.listitem {margin-top: 16px;}
@@ -12,8 +14,8 @@ div.sect3 > div.itemizedlist > ul.itemizedlist > li.listitem {margin-top: 6px;}
1214
rightLink="tutorial" rightLabel="Next">
1315
<div class="part">
1416
<div class="titlepage"><div><div><h1 class="title">
15-
<a name="acs-package-dev" id="acs-package-dev"></a>Part III. For OpenACS Package
16-
Developers</h1></div></div></div><div class="partintro">
17+
<a name="acs-package-dev" id="acs-package-dev"></a>Part III. For OpenACS
18+
Package Developers</h1></div></div></div><div class="partintro">
1719
<p>Tutorials and reference material for creating new OpenACS
1820
packages.</p><div class="toc">
1921
<p><strong>Table of Contents</strong></p><dl class="toc">
@@ -90,8 +92,8 @@ with an OpenACS Site</a></span></dt>
9092
</div>
9193
<include src="/packages/acs-core-docs/lib/navfooter"
9294
leftLink="install-resources" leftLabel="Prev" leftTitle="Resources"
93-
rightLink="tutorial" rightLabel="Next" rightTitle="Chapter 9. Development
94-
Tutorial"
95+
rightLink="tutorial" rightLabel="Next" rightTitle="
96+
Chapter 9. Development Tutorial"
9597
homeLink="index" homeLabel="Home"
9698
upLink="index" upLabel="Up">
9799

‎packages/acs-core-docs/www/acs-plat-dev.adp‎

Lines changed: 11 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11

2-
<property name="context">{/doc/acs-core-docs/ {ACS Core Documentation}} {Part IV. For OpenACS Platform Developers}</property>
3-
<property name="doc(title)">Part IV. For OpenACS Platform Developers</property>
2+
<property name="context">{/doc/acs-core-docs/ {ACS Core Documentation}} {Part IV. For OpenACS Platform
3+
Developers}</property>
4+
<property name="doc(title)">Part IV. For OpenACS Platform
5+
Developers</property>
46
<master>
57
<style>
68
div.sect2 > div.itemizedlist > ul.itemizedlist > li.listitem {margin-top: 16px;}
@@ -12,8 +14,8 @@ div.sect3 > div.itemizedlist > ul.itemizedlist > li.listitem {margin-top: 6px;}
1214
rightLink="kernel-doc" rightLabel="Next">
1315
<div class="part">
1416
<div class="titlepage"><div><div><h1 class="title">
15-
<a name="acs-plat-dev" id="acs-plat-dev"></a>Part IV. For OpenACS Platform
16-
Developers</h1></div></div></div><div class="toc">
17+
<a name="acs-plat-dev" id="acs-plat-dev"></a>Part IV. For OpenACS
18+
Platform Developers</h1></div></div></div><div class="toc">
1719
<p><strong>Table of Contents</strong></p><dl class="toc">
1820
<dt><span class="chapter"><a href="kernel-doc">15. Kernel
1921
Documentation</a></span></dt><dd><dl>
@@ -46,10 +48,11 @@ Update the translations</a></span></dt>
4648
</div>
4749
</div>
4850
<include src="/packages/acs-core-docs/lib/navfooter"
49-
leftLink="cvs-tips" leftLabel="Prev" leftTitle="Appendix D. Using CVS with
50-
an OpenACS Site"
51-
rightLink="kernel-doc" rightLabel="Next" rightTitle="Chapter 15. Kernel
52-
Documentation"
51+
leftLink="cvs-tips" leftLabel="Prev" leftTitle="
52+
Appendix D. Using CVS with an OpenACS
53+
Site"
54+
rightLink="kernel-doc" rightLabel="Next" rightTitle="
55+
Chapter 15. Kernel Documentation"
5356
homeLink="index" homeLabel="Home"
5457
upLink="index" upLabel="Up">
5558

‎packages/acs-core-docs/www/analog-install.adp‎

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,13 +8,15 @@ div.sect3 > div.itemizedlist > ul.itemizedlist > li.listitem {margin-top: 6px;}
88
</style>
99
<include src="/packages/acs-core-docs/lib/navheader"
1010
leftLink="install-qmail" leftLabel="Prev"
11-
title="Appendix B. Install
12-
additional supporting software"
11+
title="
12+
Appendix B. Install additional supporting
13+
software"
1314
rightLink="install-nspam" rightLabel="Next">
1415
<div class="sect1">
1516
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
1617
<a name="analog-install" id="analog-install"></a>Install Analog web file analyzer</h2></div></div></div><p>Download the Analog <a class="link" href="individual-programs" title="Analog 5.32 or newer, OPTIONAL">source tarball</a> in <code class="computeroutput">/tmp</code>. Unpack, compile, and install
17-
analog.</p><pre class="screen">[root aolserver]# <strong class="userinput"><code>cd /usr/local/src</code></strong>
18+
analog.</p><pre class="screen">
19+
[root aolserver]# <strong class="userinput"><code>cd /usr/local/src</code></strong>
1820
[root src]# <strong class="userinput"><code>tar xzf /tmp/analog-5.32.tar.gz</code></strong>
1921
[root src]# <strong class="userinput"><code>cd analog-5.32</code></strong>
2022
[root analog-5.32]# <strong class="userinput"><code>make</code></strong>
@@ -33,8 +35,9 @@ cd analog-5.32
3335
make
3436
cd ..
3537
mv analog-5.32 /usr/share/</span></span>
36-
</pre><p>See also <a class="xref" href="analog-setup" title="Set up Log Analysis Reports">the section called “Set up Log
37-
Analysis Reports”</a>
38+
</pre><p>See also <a class="xref" href="analog-setup" title="Set up Log Analysis Reports">the section called
39+
&ldquo;Set up Log Analysis
40+
Reports&rdquo;</a>
3841
</p>
3942
</div>
4043
<include src="/packages/acs-core-docs/lib/navfooter"

‎packages/acs-core-docs/www/analog-setup.adp‎

Lines changed: 17 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,8 @@ div.sect3 > div.itemizedlist > ul.itemizedlist > li.listitem {margin-top: 6px;}
88
</style>
99
<include src="/packages/acs-core-docs/lib/navheader"
1010
leftLink="install-ssl" leftLabel="Prev"
11-
title="Chapter 6. Production
12-
Environments"
11+
title="
12+
Chapter 6. Production Environments"
1313
rightLink="uptime" rightLabel="Next">
1414
<div class="sect1">
1515
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
@@ -18,7 +18,8 @@ performs DNS lookup, and outputs HTML reports. Analog should
1818
<a class="link" href="analog-install" title="Install Analog web file analyzer">already be installed.</a> A
1919
modified configuration file is included in the OpenACS tarball.</p><div class="orderedlist"><ol class="orderedlist" type="1">
2020
<li class="listitem">
21-
<pre class="screen">[root src]# <strong class="userinput"><code>su - $OPENACS_SERVICE_NAME</code></strong>
21+
<pre class="screen">
22+
[root src]# <strong class="userinput"><code>su - $OPENACS_SERVICE_NAME</code></strong>
2223
[$OPENACS_SERVICE_NAME $OPENACS_SERVICE_NAME]$ <strong class="userinput"><code>cd /var/lib/aolserver/$OPENACS_SERVICE_NAME</code></strong>
2324
[$OPENACS_SERVICE_NAME $OPENACS_SERVICE_NAME]$ <strong class="userinput"><code>mkdir www/log</code></strong>
2425
[$OPENACS_SERVICE_NAME $OPENACS_SERVICE_NAME]$ <strong class="userinput"><code>cp -r /usr/share/analog-5.32/images www/log/</code></strong>
@@ -37,23 +38,30 @@ change <code class="computeroutput">OUTFILE
3738
to use a private directory. You&#39;ll also need to edit all
3839
instances of service0 to your $OPENACS_SERVICE_NAME.</p>
3940
</li><li class="listitem">
40-
<p>Run it.</p><pre class="screen">[$OPENACS_SERVICE_NAME $OPENACS_SERVICE_NAME]$ <strong class="userinput"><code>/usr/share/analog-5.32/analog -G -g/var/lib/aolserver/$OPENACS_SERVICE_NAME/etc/analog.cfg</code></strong>
41+
<p>Run it.</p><pre class="screen">
42+
[$OPENACS_SERVICE_NAME $OPENACS_SERVICE_NAME]$ <strong class="userinput"><code>/usr/share/analog-5.32/analog -G -g/var/lib/aolserver/$OPENACS_SERVICE_NAME/etc/analog.cfg</code></strong>
4143
/usr/share/analog-5.32/analog: analog version 5.32/Unix
4244
/usr/share/analog-5.32/analog: Warning F: Failed to open DNS input file
4345
/home/$OPENACS_SERVICE_NAME/dnscache: ignoring it
4446
(For help on all errors and warnings, see docs/errors.html)
4547
/usr/share/analog-5.32/analog: Warning R: Turning off empty Search Word Report
46-
[$OPENACS_SERVICE_NAME $OPENACS_SERVICE_NAME]$</pre><p>Verify that it works by browsing to <code class="computeroutput">http://yourserver.test:8000/log/traffic.html</code>
48+
[$OPENACS_SERVICE_NAME $OPENACS_SERVICE_NAME]$
49+
</pre><p>Verify that it works by browsing to <code class="computeroutput">http://yourserver.test:8000/log/traffic.html</code>
4750
</p>
4851
</li><li class="listitem">
49-
<p>Automate this by creating a file in <code class="computeroutput">/etc/cron.daily</code>.</p><pre class="screen">[$OPENACS_SERVICE_NAME $OPENACS_SERVICE_NAME]$ <strong class="userinput"><code>exit</code></strong>
52+
<p>Automate this by creating a file in <code class="computeroutput">/etc/cron.daily</code>.</p><pre class="screen">
53+
[$OPENACS_SERVICE_NAME $OPENACS_SERVICE_NAME]$ <strong class="userinput"><code>exit</code></strong>
5054
logout
5155

5256
[root root]# <strong class="userinput"><code>emacs /etc/cron.daily/analog</code></strong>
53-
</pre><p>Put this into the file:</p><pre class="programlisting">#!/bin/sh
57+
</pre><p>Put this into the file:</p><pre class="programlisting">
58+
#!/bin/sh
5459

55-
/usr/share/analog-5.32/analog -G -g/var/lib/aolserver/<span class="replaceable"><span class="replaceable">$OPENACS_SERVICE_NAME</span></span>/etc/analog.cfg</pre><pre class="screen">[root root]# <strong class="userinput"><code>chmod 755 /etc/cron.daily/analog</code></strong>
56-
</pre><p>Test it by running the script.</p><pre class="screen">[root root]# <strong class="userinput"><code>sh /etc/cron.daily/analog</code></strong>
60+
/usr/share/analog-5.32/analog -G -g/var/lib/aolserver/<span class="replaceable"><span class="replaceable">$OPENACS_SERVICE_NAME</span></span>/etc/analog.cfg
61+
</pre><pre class="screen">
62+
[root root]# <strong class="userinput"><code>chmod 755 /etc/cron.daily/analog</code></strong>
63+
</pre><p>Test it by running the script.</p><pre class="screen">
64+
[root root]# <strong class="userinput"><code>sh /etc/cron.daily/analog</code></strong>
5765
</pre><p>Browse to <code class="computeroutput">http://<span class="replaceable"><span class="replaceable">yourserver.test</span></span>/log/traffic.html</code>
5866
</p>
5967
</li>

0 commit comments

Comments
 (0)