From cbd8d09849fbbd8ccd8f5cbe29f09949fc344767 Mon Sep 17 00:00:00 2001
From: Aldo Cortesi <aldo@nullcube.com>
Date: Wed, 3 Aug 2011 20:28:52 +1200
Subject: Miscelaneous doc updates.

    - Make typography less hideous.
    - Stub out the docs I'm about to write.
---
 doc-src/02-docstyle.css             | 35 ++++++++++++++++++++--------------
 doc-src/index.html                  | 27 +++++++++++++++++++-------
 doc-src/index.py                    |  7 +++++--
 doc-src/interception.html           | 38 -------------------------------------
 doc-src/mitmdump.html               |  0
 doc-src/mitmproxy.html              |  0
 doc-src/mitmproxy/encodings.html    |  0
 doc-src/mitmproxy/eventlog.html     |  0
 doc-src/mitmproxy/index.py          |  7 +++++++
 doc-src/mitmproxy/interception.html | 38 +++++++++++++++++++++++++++++++++++++
 doc-src/scripts/api.html            |  0
 doc-src/scripts/flows.html          |  0
 doc-src/scripts/index.py            |  6 ++++++
 13 files changed, 97 insertions(+), 61 deletions(-)
 delete mode 100644 doc-src/interception.html
 create mode 100644 doc-src/mitmdump.html
 create mode 100644 doc-src/mitmproxy.html
 create mode 100644 doc-src/mitmproxy/encodings.html
 create mode 100644 doc-src/mitmproxy/eventlog.html
 create mode 100644 doc-src/mitmproxy/index.py
 create mode 100644 doc-src/mitmproxy/interception.html
 create mode 100644 doc-src/scripts/api.html
 create mode 100644 doc-src/scripts/flows.html
 create mode 100644 doc-src/scripts/index.py

diff --git a/doc-src/02-docstyle.css b/doc-src/02-docstyle.css
index a971799f..7a7f49a4 100644
--- a/doc-src/02-docstyle.css
+++ b/doc-src/02-docstyle.css
@@ -8,7 +8,7 @@ a {
 #hd.doc {
     -x-system-font:none;
     font-family: Helvetica,Arial,Tahoma,Verdana,Sans-Serif;
-    color: #555555;
+    color: #444444;
     margin: 0;
     margin-bottom: 1em;
 }
@@ -16,7 +16,6 @@ a {
 #hd.doc h1 {
     letter-spacing: 3px;
     font-size: 2.5em;
-    line-height: 100%;
     margin: 0.3em 0;
     font-weight: normal;
 }
@@ -27,32 +26,34 @@ a {
 
 
 #bd {
-    -x-system-font:none;
-    font-family: Helvetica,Arial,Tahoma,Verdana,Sans-Serif;
-    font-size: 1.6em;
-    color: #555555;
+    font: 16px/21px "HelveticaNeue","Helvetica Neue",Helvetica,Arial,sans-serif;
+    line-height: 1.5;
+    color: #444444;
+}
+
+#bd h1, #bd h2 {
+    font-family: "Georgia","Times New Roman",Helvetica,Arial,sans-serif;
+    font-weight: normal;
 }
 
 #bd h1 {
-    font-size: 1.4em;
-    border-bottom: 5px solid #ff7033;
+    font-size: 1.8em;
+    border-bottom: 2px solid #ff7033;
     margin-top: 5px;
     margin-bottom: 5px;
-    color: #000000;
+    color: #181818;
 }
 
 #bd h2 {
-    font-size: 1.1em;
+    font-size: 1.3em;
     border-bottom: 1px solid #cccccc;
     margin-top: 5px;
     margin-bottom: 5px;
-    color: #000000;
+    color: #181818;
 }
 
 #bd p {
     margin: 1em 0;
-
-
 }
 
 #ft.doc {
@@ -70,6 +71,8 @@ a {
 }
 
 pre {
+    font-size: 0.9em;
+    line-height: 1.4;
     padding: 10px;
     background-color: #dddddd;
     margin: 1em 0;
@@ -82,7 +85,9 @@ pre {
 
 }
 
-.docindex, .docindex ul {
+.docindex {
+    font-size: 1.3em;
+    line-height: 1.3;
     margin-top: 0.1em;
     margin-bottom: 0;
     margin-left: 0px;
@@ -95,6 +100,8 @@ pre {
 
 .docindex ul {
     margin-left: 2em;
+    margin-top: 0.1em;
+    margin-bottom: 0.1em;
 }
 
 li a {
diff --git a/doc-src/index.html b/doc-src/index.html
index 7f9df3d6..27bcc896 100644
--- a/doc-src/index.html
+++ b/doc-src/index.html
@@ -1,14 +1,27 @@
 
 <ul class="docindex">
     <li><a href="@!urlTo("intro.html")!@">Introduction</a></li>
-    <li><a href="@!urlTo("interception.html")!@">Interception</a></li>
-    <li><a href="@!urlTo("clientreplay.html")!@">Client-side replay</a></li>
-    <li><a href="@!urlTo("serverreplay.html")!@">Server-side replay</a></li>
-    <li><a href="@!urlTo("sticky.html")!@">Sticky cookies and auth</a></li>
-    <li><a href="@!urlTo("anticache.html")!@">Anticache</a></li>
-    <li><a href="@!urlTo("filters.html")!@">Filter expressions</a></li>
+    <li><a href="@!urlTo("mitmproxy.html")!@">mitmproxy</a></li>
+        <ul>
+            <li><a href="@!urlTo("mitmproxy/interception.html")!@">Interception</a></li>
+            <li><a href="@!urlTo("mitmproxy/encodings.html")!@">Encodings</a></li>
+            <li><a href="@!urlTo("mitmproxy/eventlog.html")!@">Event log</a></li>
+        </ul>
+    <li><a href="@!urlTo("mitmdump.html")!@">mitmdump</a></li>
+    <li>Features</li>
+    <ul>
+        <li><a href="@!urlTo("clientreplay.html")!@">Client-side replay</a></li>
+        <li><a href="@!urlTo("serverreplay.html")!@">Server-side replay</a></li>
+        <li><a href="@!urlTo("sticky.html")!@">Sticky cookies and auth</a></li>
+        <li><a href="@!urlTo("anticache.html")!@">Anticache</a></li>
+        <li><a href="@!urlTo("filters.html")!@">Filter expressions</a></li>
+    </ul>
     <li><a href="@!urlTo("scripts.html")!@">Scripting API</a></li>
-    <li><a href="@!urlTo("ssl.html")!@">SSL</a></li>
+        <ul>
+            <li><a href="@!urlTo("scripts/flows.html")!@">Introduction to flows</a></li>
+            <li><a href="@!urlTo("scripts/api.html")!@">API</a></li>
+        </ul>
+    <li><a href="@!urlTo("ssl.html")!@">SSL interception</a></li>
         <ul>
             <li><a href="@!urlTo("certinstall/firefox.html")!@">Firefox</a></li>
             <li><a href="@!urlTo("certinstall/osx.html")!@">OSX</a></li>
diff --git a/doc-src/index.py b/doc-src/index.py
index 07924e63..f98c2dcd 100644
--- a/doc-src/index.py
+++ b/doc-src/index.py
@@ -68,14 +68,17 @@ ns.filt_help = filt_help
 pages = [
     Page("index.html", "docs"),
     Page("intro.html", "Introduction"),
-    Page("interception.html", "Interception"),
+    Page("mitmproxy.html", "mitmproxy"),
+    Directory("mitmproxy"),
+    Page("mitmdump.html", "mitmdump"),
     Page("clientreplay.html", "Client-side replay"),
     Page("serverreplay.html", "Server-side replay"),
     Page("sticky.html", "Sticky cookies and auth"),
     Page("anticache.html", "Anticache"),
     Page("filters.html", "Filter expressions"),
     Page("scripts.html", "External scripts"),
-    Page("ssl.html", "SSL"),
+    Directory("scripts"),
+    Page("ssl.html", "SSL interception"),
     Directory("certinstall"),
     Page("library.html", "libmproxy: mitmproxy as a library"),
     Directory("tutorials"),
diff --git a/doc-src/interception.html b/doc-src/interception.html
deleted file mode 100644
index 2f961b5f..00000000
--- a/doc-src/interception.html
+++ /dev/null
@@ -1,38 +0,0 @@
-
-__mitmproxy__'s interception functionality lets you pause an HTTP request or
-response, inspect and modify it, and then accept it to send it on to the server
-or client. Because this is an interactive function, it's only present in
-__mitmproxy__, not in __mitmdump__. 
-
-
-### 1: Set an interception pattern
-
-<img src="@!urlTo('intercept-filt.png')!@"/>
-
-We press __i__ to set an interception pattern. In this case, the __~q__ filter
-pattern tells __mitmproxy__ to intercept all requests. For complete filter
-syntax, see the [Filter expressions](@!urlTo("filters.html")!@) section of this
-document, or the built-in help function in __mitmproxy__.
-
-### 2: Intercepted connections are indicated with a red exclamation mark:
-
-<img src="@!urlTo('intercept-mid.png')!@"/>
-
-### 3: You can now view and modify the request:
-
-<img src="@!urlTo('intercept-options.png')!@"/>
-
-In this case, we viewed the request by selecting it, pressed __e__ for "edit"
-and __m__ for "method" to change the HTTP request method.
-
-### 4: Accept the intercept to continue
-
-<img src="@!urlTo('intercept-result.png')!@"/>
-
-Finally, we press __a__ to accept the modified request, which is then sent on
-to the server. In this case, we changed the request from an HTTP GET to to
-OPTIONS, and Google's server has responded with a 405 "Method not allowed". 
-
-
-
-
diff --git a/doc-src/mitmdump.html b/doc-src/mitmdump.html
new file mode 100644
index 00000000..e69de29b
diff --git a/doc-src/mitmproxy.html b/doc-src/mitmproxy.html
new file mode 100644
index 00000000..e69de29b
diff --git a/doc-src/mitmproxy/encodings.html b/doc-src/mitmproxy/encodings.html
new file mode 100644
index 00000000..e69de29b
diff --git a/doc-src/mitmproxy/eventlog.html b/doc-src/mitmproxy/eventlog.html
new file mode 100644
index 00000000..e69de29b
diff --git a/doc-src/mitmproxy/index.py b/doc-src/mitmproxy/index.py
new file mode 100644
index 00000000..d7e9717c
--- /dev/null
+++ b/doc-src/mitmproxy/index.py
@@ -0,0 +1,7 @@
+from countershape import Page
+
+pages = [
+    Page("interception.html", "Interception"),
+    Page("encodings.html", "Encodings"),
+    Page("eventlog.html", "Event log"),
+]
diff --git a/doc-src/mitmproxy/interception.html b/doc-src/mitmproxy/interception.html
new file mode 100644
index 00000000..2f961b5f
--- /dev/null
+++ b/doc-src/mitmproxy/interception.html
@@ -0,0 +1,38 @@
+
+__mitmproxy__'s interception functionality lets you pause an HTTP request or
+response, inspect and modify it, and then accept it to send it on to the server
+or client. Because this is an interactive function, it's only present in
+__mitmproxy__, not in __mitmdump__. 
+
+
+### 1: Set an interception pattern
+
+<img src="@!urlTo('intercept-filt.png')!@"/>
+
+We press __i__ to set an interception pattern. In this case, the __~q__ filter
+pattern tells __mitmproxy__ to intercept all requests. For complete filter
+syntax, see the [Filter expressions](@!urlTo("filters.html")!@) section of this
+document, or the built-in help function in __mitmproxy__.
+
+### 2: Intercepted connections are indicated with a red exclamation mark:
+
+<img src="@!urlTo('intercept-mid.png')!@"/>
+
+### 3: You can now view and modify the request:
+
+<img src="@!urlTo('intercept-options.png')!@"/>
+
+In this case, we viewed the request by selecting it, pressed __e__ for "edit"
+and __m__ for "method" to change the HTTP request method.
+
+### 4: Accept the intercept to continue
+
+<img src="@!urlTo('intercept-result.png')!@"/>
+
+Finally, we press __a__ to accept the modified request, which is then sent on
+to the server. In this case, we changed the request from an HTTP GET to to
+OPTIONS, and Google's server has responded with a 405 "Method not allowed". 
+
+
+
+
diff --git a/doc-src/scripts/api.html b/doc-src/scripts/api.html
new file mode 100644
index 00000000..e69de29b
diff --git a/doc-src/scripts/flows.html b/doc-src/scripts/flows.html
new file mode 100644
index 00000000..e69de29b
diff --git a/doc-src/scripts/index.py b/doc-src/scripts/index.py
new file mode 100644
index 00000000..805a17d9
--- /dev/null
+++ b/doc-src/scripts/index.py
@@ -0,0 +1,6 @@
+from countershape import Page
+
+pages = [
+    Page("flows.html", "Introduction to flows"),
+    Page("api.html", "API"),
+]
-- 
cgit v1.2.3