docs update

2012-08-21 14:45:53 +02:00 · 2012-08-21 14:45:53 +02:00 · f2b5b05072
commit f2b5b05072
parent 1330e37ad0
3 changed files with 178 additions and 3 deletions
--- a/docs/guide/CMakeLists.txt
+++ b/docs/guide/CMakeLists.txt
@ -1,14 +1,16 @@
+cmake_minimum_required(VERSION 2.4)
+
 macro(ADD_TEXTILE SRC TITLE)
 	STRING(REGEX REPLACE ".textile\$" "" outfileName "${SRC}")
 	SET(outfile "${CMAKE_CURRENT_BINARY_DIR}/${outfileName}.html")
 	# Custom command to do the processing
 	if(${ARGN})
 		ADD_CUSTOM_COMMAND(OUTPUT "${outfile}"
-			COMMAND pandoc -o "${outfile}" "${SRC}" -f textile -t html -s --base-header-level=2 --template=template.html -T "${TITLE}"
+			COMMAND pandoc -o "${outfile}" "${SRC}" -f textile -t html -s --base-header-level=2 --template=${CMAKE_CURRENT_SOURCE_DIR}/template.html -T "${TITLE}"
 			DEPENDS "${SRC}")
 	else()
 		ADD_CUSTOM_COMMAND(OUTPUT "${outfile}"
-			COMMAND pandoc -o "${outfile}" "${SRC}" -f textile -t html -s --toc --base-header-level=2 --template=template.html -T "${TITLE}"
+			COMMAND pandoc -o "${outfile}" "${SRC}" -f textile -t html -s --toc --base-header-level=2 --template=${CMAKE_CURRENT_SOURCE_DIR}/template.html -T "${TITLE}"
 			DEPENDS "${SRC}")
 	endif()

@ -24,6 +26,12 @@ ADD_TEXTILE("server_ssl.textile" "Spectrum 2 - Server mode SSL support")
 ADD_TEXTILE("mysql.textile" "Spectrum 2 - MySQL Support")
 ADD_TEXTILE("postgresql.textile" "Spectrum 2 - PostgreSQL Support")
 ADD_TEXTILE("logging.textile" "Spectrum 2 - Logging")
+ADD_TEXTILE("backends.textile" "Spectrum 2 - Backends overview")
+ADD_TEXTILE("libpurple.textile" "Spectrum 2 - Libpurple backend")
+ADD_TEXTILE("libcommuni.textile" "Spectrum 2 - Libcommuni backend")
+ADD_TEXTILE("swiften.textile" "Spectrum 2 - Swiften backend")
+ADD_TEXTILE("skype.textile" "Spectrum 2 - Skype backend")
+ADD_TEXTILE("spectrum2_manager.textile" "Spectrum 2 - spectrum2_manager tool")


 # Setup a target to drive the conversion
--- a/docs/guide/index.textile
+++ b/docs/guide/index.textile
@ -1,7 +1,8 @@
 h2. About

 h2. Installation
-* "From source code":from_source_code.html
+
+* "Installing from source code":from_source_code.html

 h2. Configuration

@ -10,3 +11,16 @@ h2. Configuration
 * "PostgreSQL Support":postgresql.html
 * "Using SSL in server mode":server_ssl.html
 * "Logging":logging.html
+
+h2. Backends
+
+* "Backends overview":backends.html
+* "Libpurple backend":libpurple.html
+* "Swiften backend":swiften.html
+* "Libcommuni backend":swiften.html
+* "Skype backend":skype.html
+
+h2. Management
+
+* "spectrum2_manager tool":spectrum2_manager.html
+* "Munin integration":munin.html
--- a/docs/guide/template.html
+++ b/docs/guide/template.html
@ -0,0 +1,153 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml"$if(lang)$ lang="$lang$" xml:lang="$lang$"$endif$>
+<head>
+  <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+  <meta http-equiv="Content-Style-Type" content="text/css" />
+  <meta name="generator" content="pandoc" />
+$for(author-meta)$
+  <meta name="author" content="$author-meta$" />
+$endfor$
+$if(date-meta)$
+  <meta name="date" content="$date-meta$" />
+$endif$
+  <title>$title-prefix$</title>
+$if(highlighting-css)$
+  <style type="text/css">
+$highlighting-css$
+  </style>
+$endif$
+  <style type="text/css">
+/* html, body, */
+/* h1, h2, h3, h4, h5, h6, */
+/* p, ul, ol, li, dl, dd, dt, pre, form, fieldset{ margin: 0; padding: 0; }  */
+
+body{ background-color: #F9F9F9; color: #444444; font: normal normal 14px "Helvetica", "Arial", Sans-Serif; }
+
+pre, kbd, var, samp, tt{ font-family: "Courier", Monospace; }
+
+pre { font-size: 12px; }
+
+h1, h2, h3, h4, h5, h6, pre{ color: #094776; }
+
+h1{ font-size: 28px; }
+
+h2{ font-size: 24px; font-weight: normal; }
+
+h1, h2, h3, h4, h5, h6{ margin-bottom: 20px; }
+
+h2, h3{ border-bottom: 2px solid #EEEEEE; padding: 0 0 3px; }	
+
+h3{ border-color: #E5E5E5; border-width: 1px; }
+
+h4{ font-size: 18px; }
+
+	h1 a, h2 a{ font-weight: normal; }
+
+	h1 a, h2 a, h3 a{ text-decoration: none; }
+	
+h3, h5, h6{ font-size: 18px; }
+
+	h4, h5, h6{ font-size: 14px; }
+
+p, dl, ul, ol{ margin: 20px 0; }
+
+	p, dl, ul, ol, h3, h4, h5, h6{ margin-left: 20px; }
+
+	li > ul,
+	li > ol{ margin: 0; margin-left: 40px; }
+
+	dl > dd{ margin-left: 20px; }
+	
+	li > p { margin: 0; }
+
+p, li, dd, dt, pre{ line-height: 1.5; }
+
+table {
+	border-collapse: collapse;
+    margin-bottom: 20px;
+	margin-left:20px;
+	}
+
+th {
+	padding: 0 0.5em;
+	text-align: center;
+	}
+
+th {
+	border: 1px solid #FB7A31;
+	background: #FFC;
+	}
+
+td {
+	border-bottom: 1px solid #CCC;
+	border-right: 1px solid #CCC;
+	border-left: 1px solid #CCC;
+	padding: 0 0.5em;
+	}
+
+
+a:link,
+a:visited{ color: #1A5B8D; }
+
+a:hover,
+a:active{ color: #742CAC; }
+
+a.headerlink{ visibility: hidden; }
+
+	:hover > a.headerlink { visibility: visible; }
+
+a img{ 
+	border: 0;
+	outline: 0;
+}
+
+img{ display: block; max-width: 100%; }
+
+pre {
+ white-space: pre-wrap;
+ white-space: -moz-pre-wrap;
+ white-space: -o-pre-wrap;
+border: 1px solid #FB7A31;
+background: #FFC;
+padding:5px;
+padding-left: 15px;
+}
+
+  </style>
+$for(css)$
+  <link rel="stylesheet" href="$css$" $if(html5)$$else$type="text/css" $endif$/>
+$endfor$
+$if(math)$
+  $math$
+$endif$
+$for(header-includes)$
+  $header-includes$
+$endfor$
+</head>
+<body>
+<h1>$title-prefix$</h1>
+$for(include-before)$
+$include-before$
+$endfor$
+$if(title)$
+<div id="$idprefix$header">
+<h1 class="title">$title$</h1>
+$for(author)$
+<h2 class="author">$author$</h2>
+$endfor$
+$if(date)$
+<h3 class="date">$date$</h3>
+$endif$
+</div>
+$endif$
+$if(toc)$
+<div id="$idprefix$TOC">
+$toc$
+</div>
+$endif$
+$body$
+$for(include-after)$
+$include-after$
+$endfor$
+</body>
+</html>