Skip to content

Commit 6f0ea24

Browse files
zwoopzwoop
committed
Cleaning up some existing docs for formatting
1 parent ef12012 commit 6f0ea24

File tree

7 files changed

+102
-70
lines changed

7 files changed

+102
-70
lines changed

‎doc/admin-guide/plugins/cachekey.en.rst‎

Lines changed: 52 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@ Cache key structure and related plugin parameters
7777
</TR>
7878
<TR>
7979
<TD BGCOLOR="lightblue">Prefix<BR/>section<BR/>(default)</TD>
80-
<TD BGCOLOR="lightgreen">User-Agent<BR/>section<BR/>(optional)</TD>
80+
<TD BGCOLOR="palegreen">User-Agent<BR/>section<BR/>(optional)</TD>
8181
<TD BGCOLOR="lightyellow">Headers<BR/>section<BR/>(optional)</TD>
8282
<TD BGCOLOR="mistyrose">Cookies<BR/>section<BR/>(optional)</TD>
8383
<TD BGCOLOR="lightsteelblue">Path<BR/>section<BR/>(default)</TD>
@@ -116,7 +116,7 @@ Cache key structure and related plugin parameters
116116
<TABLE BORDER="1" CELLBORDER="1" CELLSPACING="0" BGCOLOR="lightyellow">
117117
<TR>
118118
<TD BGCOLOR="lightblue">--static-prefix</TD>
119-
<TD BGCOLOR="lightgreen">--capture-prefix</TD>
119+
<TD BGCOLOR="palegreen">--capture-prefix</TD>
120120
<TD BGCOLOR="lightcyan">--capture-prefix-uri</TD>
121121
</TR>
122122
<TR>
@@ -173,7 +173,7 @@ Cache key structure and related plugin parameters
173173
<TABLE BORDER="1" CELLBORDER="1" CELLSPACING="0" BGCOLOR="lightyellow">
174174
<TR>
175175
<TD BGCOLOR="lightblue">--ua-class</TD>
176-
<TD BGCOLOR="lightgreen">--ua-capture</TD>
176+
<TD BGCOLOR="palegreen">--ua-capture</TD>
177177
</TR>
178178
<TR>
179179
<TD COLSPAN="2" ALIGN="CENTER">(empty)</TD>
@@ -215,7 +215,7 @@ Cache key structure and related plugin parameters
215215
<TABLE BORDER="1" CELLBORDER="1" CELLSPACING="0" BGCOLOR="lightyellow">
216216
<TR>
217217
<TD BGCOLOR="lightblue">--include-headers</TD>
218-
<TD BGCOLOR="lightgreen">--capture-header</TD>
218+
<TD BGCOLOR="palegreen">--capture-header</TD>
219219
</TR>
220220
<TR>
221221
<TD COLSPAN="2" ALIGN="CENTER">(empty)</TD>
@@ -288,7 +288,7 @@ Cache key structure and related plugin parameters
288288
<TABLE BORDER="1" CELLBORDER="1" CELLSPACING="0" BGCOLOR="lightyellow">
289289
<TR>
290290
<TD BGCOLOR="lightblue">--capture-path-uri</TD>
291-
<TD BGCOLOR="lightgreen">--capture-path</TD>
291+
<TD BGCOLOR="palegreen">--capture-path</TD>
292292
</TR>
293293
<TR>
294294
<TD COLSPAN="2" ALIGN="CENTER">URI path</TD>
@@ -376,75 +376,95 @@ Detailed examples and troubleshooting
376376

377377
.. graphviz::
378378
:alt: Cache Key Sample Breakdown
379-
:align: center
379+
:align: left
380380

381381
digraph cache_key_samples {
382382
node [shape=none, fontname="monospace"];
383383

384384
sample1 [label=<
385385
<TABLE BORDER="1" CELLBORDER="1" CELLSPACING="0">
386-
<TR><TD COLSPAN="7" ALIGN="LEFT" BGCOLOR="lightgray"><B>Sample 1 Cache Key</B></TD></TR>
386+
<TR><TD COLSPAN="12" ALIGN="LEFT" BGCOLOR="lightgray"><B>Sample 1 Cache Key</B></TD></TR>
387387
<TR>
388-
<TD COLSPAN="6" ALIGN="CENTER" BGCOLOR="wheat"><FONT POINT-SIZE="9">hierarchical part</FONT></TD>
388+
<TD COLSPAN="11" ALIGN="CENTER" BGCOLOR="wheat"><FONT POINT-SIZE="9">hierarchical part</FONT></TD>
389389
<TD COLSPAN="1" ALIGN="CENTER" BGCOLOR="lightcyan"><FONT POINT-SIZE="9">query</FONT></TD>
390390
</TR>
391391
<TR>
392392
<TD COLSPAN="2" ALIGN="CENTER" BGCOLOR="wheat"><FONT POINT-SIZE="8">URI host:port</FONT></TD>
393-
<TD COLSPAN="3" ALIGN="CENTER" BGCOLOR="wheat"><FONT POINT-SIZE="8">HTTP headers and cookies</FONT></TD>
394-
<TD ALIGN="CENTER" BGCOLOR="wheat"><FONT POINT-SIZE="8">URI path</FONT></TD>
395-
<TD ALIGN="CENTER" BGCOLOR="lightcyan"><FONT POINT-SIZE="8">URI query</FONT></TD>
393+
<TD COLSPAN="8" ALIGN="CENTER" BGCOLOR="wheat"><FONT POINT-SIZE="8">HTTP headers and cookies</FONT></TD>
394+
<TD COLSPAN="1" ALIGN="CENTER" BGCOLOR="wheat"><FONT POINT-SIZE="8">URI path</FONT></TD>
395+
<TD COLSPAN="1" ALIGN="CENTER" BGCOLOR="lightcyan"><FONT POINT-SIZE="8">URI query</FONT></TD>
396396
</TR>
397397
<TR>
398398
<TD BGCOLOR="lightblue">/www.example.com/80</TD>
399-
<TD BGCOLOR="lightgreen">popular</TD>
399+
<TD BORDER="0" WIDTH="10"><FONT POINT-SIZE="10">/</FONT></TD>
400+
<TD BGCOLOR="palegreen">popular</TD>
401+
<TD BORDER="0" WIDTH="10"><FONT POINT-SIZE="10">/</FONT></TD>
400402
<TD BGCOLOR="lightyellow">Mozilla/5.0</TD>
403+
<TD BORDER="0" WIDTH="10"><FONT POINT-SIZE="10">/</FONT></TD>
401404
<TD BGCOLOR="mistyrose">H1:v1/H2:v2</TD>
405+
<TD BORDER="0" WIDTH="10"><FONT POINT-SIZE="10">/</FONT></TD>
402406
<TD BGCOLOR="lavender">C1=v1;C2=v2</TD>
407+
<TD BORDER="0" WIDTH="10"><FONT POINT-SIZE="10">/</FONT></TD>
403408
<TD BGCOLOR="lightsteelblue">path/to/data</TD>
404409
<TD BGCOLOR="lightgray">?a=1&amp;b=2&amp;c=3</TD>
405410
</TR>
406411
<TR>
407-
<TD ALIGN="CENTER"><FONT POINT-SIZE="8">host:port</FONT></TD>
408-
<TD ALIGN="CENTER"><FONT POINT-SIZE="8">UA-class</FONT></TD>
409-
<TD ALIGN="CENTER"><FONT POINT-SIZE="8">UA-captures</FONT></TD>
410-
<TD ALIGN="CENTER"><FONT POINT-SIZE="8">headers</FONT></TD>
411-
<TD ALIGN="CENTER"><FONT POINT-SIZE="8">cookies</FONT></TD>
412-
<TD ALIGN="CENTER"><FONT POINT-SIZE="8">path</FONT></TD>
413-
<TD ALIGN="CENTER"><FONT POINT-SIZE="8">query</FONT></TD>
412+
<TD ALIGN="CENTER" BGCOLOR="lightblue"><FONT POINT-SIZE="8">host:port</FONT></TD>
413+
<TD WIDTH="10"></TD>
414+
<TD ALIGN="CENTER" BGCOLOR="palegreen"><FONT POINT-SIZE="8">UA-class</FONT></TD>
415+
<TD WIDTH="10"></TD>
416+
<TD ALIGN="CENTER" BGCOLOR="lightyellow"><FONT POINT-SIZE="8">UA-captures</FONT></TD>
417+
<TD WIDTH="10"></TD>
418+
<TD ALIGN="CENTER" BGCOLOR="mistyrose"><FONT POINT-SIZE="8">headers</FONT></TD>
419+
<TD WIDTH="10"></TD>
420+
<TD ALIGN="CENTER" BGCOLOR="lavender"><FONT POINT-SIZE="8">cookies</FONT></TD>
421+
<TD WIDTH="10"></TD>
422+
<TD ALIGN="CENTER" BGCOLOR="lightsteelblue"><FONT POINT-SIZE="8">path</FONT></TD>
423+
<TD ALIGN="CENTER" BGCOLOR="lightgray"><FONT POINT-SIZE="8">query</FONT></TD>
414424
</TR>
415425
</TABLE>
416426
>];
417427

418428
sample2 [label=<
419429
<TABLE BORDER="1" CELLBORDER="1" CELLSPACING="0">
420-
<TR><TD COLSPAN="7" ALIGN="LEFT" BGCOLOR="lightgray"><B>Sample 2 Cache Key</B></TD></TR>
430+
<TR><TD COLSPAN="12" ALIGN="LEFT" BGCOLOR="lightgray"><B>Sample 2 Cache Key</B></TD></TR>
421431
<TR>
422-
<TD COLSPAN="6" ALIGN="CENTER" BGCOLOR="wheat"><FONT POINT-SIZE="9">hierarchical part</FONT></TD>
432+
<TD COLSPAN="11" ALIGN="CENTER" BGCOLOR="wheat"><FONT POINT-SIZE="9">hierarchical part</FONT></TD>
423433
<TD COLSPAN="1" ALIGN="CENTER" BGCOLOR="lightcyan"><FONT POINT-SIZE="9">query</FONT></TD>
424434
</TR>
425435
<TR>
426436
<TD COLSPAN="2" ALIGN="CENTER" BGCOLOR="wheat"><FONT POINT-SIZE="8">URI host:port</FONT></TD>
427-
<TD COLSPAN="3" ALIGN="CENTER" BGCOLOR="wheat"><FONT POINT-SIZE="8">HTTP headers and cookies</FONT></TD>
428-
<TD ALIGN="CENTER" BGCOLOR="wheat"><FONT POINT-SIZE="8">URI path</FONT></TD>
429-
<TD ALIGN="CENTER" BGCOLOR="lightcyan"><FONT POINT-SIZE="8">URI query</FONT></TD>
437+
<TD COLSPAN="8" ALIGN="CENTER" BGCOLOR="wheat"><FONT POINT-SIZE="8">HTTP headers and cookies</FONT></TD>
438+
<TD COLSPAN="1" ALIGN="CENTER" BGCOLOR="wheat"><FONT POINT-SIZE="8">URI path</FONT></TD>
439+
<TD COLSPAN="1" ALIGN="CENTER" BGCOLOR="lightcyan"><FONT POINT-SIZE="8">URI query</FONT></TD>
430440
</TR>
431441
<TR>
432442
<TD BGCOLOR="lightblue">/nice_custom_prefix</TD>
433-
<TD BGCOLOR="lightgreen">popular</TD>
443+
<TD BORDER="0" WIDTH="10"><FONT POINT-SIZE="10">/</FONT></TD>
444+
<TD BGCOLOR="palegreen">popular</TD>
445+
<TD BORDER="0" WIDTH="10"><FONT POINT-SIZE="10">/</FONT></TD>
434446
<TD BGCOLOR="lightyellow">Mozilla/5.0</TD>
447+
<TD BORDER="0" WIDTH="10"><FONT POINT-SIZE="10">/</FONT></TD>
435448
<TD BGCOLOR="mistyrose">H1:v1/H2:v2</TD>
449+
<TD BORDER="0" WIDTH="10"><FONT POINT-SIZE="10">/</FONT></TD>
436450
<TD BGCOLOR="lavender">C1=v1;C2=v2</TD>
451+
<TD BORDER="0" WIDTH="10"><FONT POINT-SIZE="10">/</FONT></TD>
437452
<TD BGCOLOR="lightsteelblue">path/to/data</TD>
438453
<TD BGCOLOR="lightgray">?a=1&amp;b=2&amp;c=3</TD>
439454
</TR>
440455
<TR>
441-
<TD ALIGN="CENTER"><FONT POINT-SIZE="8">custom prefix</FONT></TD>
442-
<TD ALIGN="CENTER"><FONT POINT-SIZE="8">UA-class</FONT></TD>
443-
<TD ALIGN="CENTER"><FONT POINT-SIZE="8">UA-captures</FONT></TD>
444-
<TD ALIGN="CENTER"><FONT POINT-SIZE="8">headers</FONT></TD>
445-
<TD ALIGN="CENTER"><FONT POINT-SIZE="8">cookies</FONT></TD>
446-
<TD ALIGN="CENTER"><FONT POINT-SIZE="8">path</FONT></TD>
447-
<TD ALIGN="CENTER"><FONT POINT-SIZE="8">query</FONT></TD>
456+
<TD ALIGN="CENTER" BGCOLOR="lightblue"><FONT POINT-SIZE="8">custom prefix</FONT></TD>
457+
<TD WIDTH="10"></TD>
458+
<TD ALIGN="CENTER" BGCOLOR="palegreen"><FONT POINT-SIZE="8">UA-class</FONT></TD>
459+
<TD WIDTH="10"></TD>
460+
<TD ALIGN="CENTER" BGCOLOR="lightyellow"><FONT POINT-SIZE="8">UA-captures</FONT></TD>
461+
<TD WIDTH="10"></TD>
462+
<TD ALIGN="CENTER" BGCOLOR="mistyrose"><FONT POINT-SIZE="8">headers</FONT></TD>
463+
<TD WIDTH="10"></TD>
464+
<TD ALIGN="CENTER" BGCOLOR="lavender"><FONT POINT-SIZE="8">cookies</FONT></TD>
465+
<TD WIDTH="10"></TD>
466+
<TD ALIGN="CENTER" BGCOLOR="lightsteelblue"><FONT POINT-SIZE="8">path</FONT></TD>
467+
<TD ALIGN="CENTER" BGCOLOR="lightgray"><FONT POINT-SIZE="8">query</FONT></TD>
448468
</TR>
449469
</TABLE>
450470
>];

‎doc/admin-guide/plugins/header_rewrite.en.rst‎

Lines changed: 21 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -943,23 +943,26 @@ The condition flags are optional, and you can combine more than one into
943943
a comma-separated list of flags. Note that whitespaces are not allowed inside
944944
the brackets:
945945

946-
====== ========================================================================
947-
Flag Description
948-
====== ========================================================================
949-
AND Indicates that both the current condition and the next must be true.
950-
This is the default behavior for all conditions when no flags are
951-
provided.
952-
NOT Inverts the condition.
953-
OR Indicates that either the current condition or the next one must be
954-
true, as contrasted with the default behavior from ``[AND]``.
955-
NOCASE Indicates that the string comparison, or regular expression, should be
956-
case-insensitive. The default is to be case-sensitive.
957-
PRE Make a prefix match on a string comparison.
958-
SUF Make a suffix match on a string comparison.
959-
MID Make a substring match on a string comparison.
960-
EXT The substring match only applies to the file extension following a dot.
961-
This is generally mostly useful for the ``URL:PATH`` part.
962-
====== ========================================================================
946+
.. table:: Condition Flags
947+
:widths: 15 85
948+
949+
====== ========================================================================
950+
Flag Description
951+
====== ========================================================================
952+
AND Indicates that both the current condition and the next must be true.
953+
This is the default behavior for all conditions when no flags are
954+
provided.
955+
NOT Inverts the condition.
956+
OR Indicates that either the current condition or the next one must be
957+
true, as contrasted with the default behavior from ``[AND]``.
958+
NOCASE Indicates that the string comparison, or regular expression, should be
959+
case-insensitive. The default is to be case-sensitive.
960+
PRE Make a prefix match on a string comparison.
961+
SUF Make a suffix match on a string comparison.
962+
MID Make a substring match on a string comparison.
963+
EXT The substring match only applies to the file extension following a dot.
964+
This is generally mostly useful for the ``URL:PATH`` part.
965+
====== ========================================================================
963966

964967
.. note::
965968
At most, one of ``[PRE]``, ``[SUF]``, ``[MID]``, or ``[EXT]`` may be
@@ -1495,7 +1498,7 @@ The URL part names which may be used for these conditions and actions are:
14951498
<TR>
14961499
<TD ALIGN="CENTER" BGCOLOR="lightblue">SCHEME</TD>
14971500
<TD BORDER="0"></TD>
1498-
<TD ALIGN="CENTER" BGCOLOR="lightgreen">HOST</TD>
1501+
<TD ALIGN="CENTER" BGCOLOR="palegreen">HOST</TD>
14991502
<TD BORDER="0"></TD>
15001503
<TD ALIGN="CENTER" BGCOLOR="lightcyan">PORT</TD>
15011504
<TD ALIGN="CENTER" BGCOLOR="wheat">PATH</TD>

‎doc/admin-guide/plugins/index.en.rst‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -162,7 +162,6 @@ Plugins that are considered experimental are located in the
162162
directory of the |TS| source tree. Experimental plugins can be compiled by passing the
163163
``-DBUILD_EXPERIMENTAL_PLUGINS=ON``` variable to ``cmake`` command when building.
164164

165-
166165
.. toctree::
167166
:hidden:
168167

‎doc/conf.cmake.in.py‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -393,6 +393,8 @@ def issue_reference(self, match, lineno):
393393
top=1in,
394394
bottom=1in
395395
}
396+
% Customize table of contents title
397+
\renewcommand{\contentsname}{Table of Contents}
396398
% Better TOC depth
397399
\setcounter{tocdepth}{1}
398400
\setcounter{secnumdepth}{1}

‎doc/developer-guide/cache-architecture/cache-initialization.en.rst‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@ stripe assignment and is called for each :class:`CacheHostRecord` and the generi
7777
stripes to be assigned are in :member:`CacheHostRecord::vols`.
7878

7979
.. figure:: images/cache-init-cachehostrecord.png
80-
:align: left
80+
:align: center
8181

8282
:member:`CacheHostRecord::vols` is the union of all the stripes in the :class:`CacheVol` instances in :member:`CacheHostRecord::cp`.
8383

‎doc/ext/traffic-server.py‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -455,7 +455,8 @@ def get_objects(self):
455455

456456
# get the branch this documentation is building for in X.X.x form
457457
REPO_ROOT = os.path.join(os.path.dirname(os.path.dirname(os.environ['DOCUTILSCONFIG'])))
458-
contents = open('../CMakeLists.txt').read()
458+
with open('../CMakeLists.txt') as f:
459+
contents = f.read()
459460
match = re.search(r'project\(ats VERSION ([0-9\.]+)', contents)
460461

461462
if match:

‎doc/index-latex.rst‎

Lines changed: 24 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -23,16 +23,22 @@ Apache Traffic Server Documentation
2323
This is the LaTeX-only master document for improved PDF structure.
2424
HTML builds use index.rst instead.
2525

26+
.. raw:: latex
27+
28+
\part{Introduction and Getting Started}
29+
2630
.. toctree::
2731
:maxdepth: 1
28-
:caption: Introduction and Getting Started
2932

3033
preface/index.en
3134
getting-started/index.en
3235

36+
.. raw:: latex
37+
38+
\part{Administrator's Guide}
39+
3340
.. toctree::
3441
:maxdepth: 1
35-
:caption: Administration
3642

3743
admin-guide/introduction.en
3844
admin-guide/installation/index.en
@@ -49,7 +55,22 @@ HTML builds use index.rst instead.
4955

5056
.. toctree::
5157
:maxdepth: 1
52-
:caption: Development
58+
59+
admin-guide/files/index.en
60+
admin-guide/tools/index.en
61+
62+
.. toctree::
63+
:maxdepth: 1
64+
65+
release-notes/index.en
66+
appendices/index.en
67+
68+
.. raw:: latex
69+
70+
\part{Developer's Guide}
71+
72+
.. toctree::
73+
:maxdepth: 1
5374

5475
developer-guide/introduction/index.en
5576
developer-guide/release-process/index.en
@@ -73,20 +94,6 @@ HTML builds use index.rst instead.
7394
developer-guide/testing/index.en
7495
developer-guide/jsonrpc/index.en
7596

76-
.. toctree::
77-
:maxdepth: 1
78-
:caption: Reference Materials
79-
80-
admin-guide/files/index.en
81-
admin-guide/tools/index.en
82-
83-
.. toctree::
84-
:maxdepth: 1
85-
:caption: Release Information and Appendices
86-
87-
release-notes/index.en
88-
appendices/index.en
89-
9097
Indices and tables
9198
==================
9299

0 commit comments

Comments
 (0)