aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorGravatar Rogan Creswick <creswick@gmail.com>2012-10-17 10:32:16 -0700
committerGravatar Rogan Creswick <creswick@gmail.com>2012-10-17 10:32:16 -0700
commit28308f34390cdd6500dda238e2b52018081bff6c (patch)
tree61dfc7ec501946c536b3e20efb1ed0247bb69a7d /doc
parentce511cd19b0b9a321aa740d75ef4a41ee57b7345 (diff)
incorporated the new web templates for documentation
Diffstat (limited to 'doc')
-rw-r--r--doc/Makefile5
-rw-r--r--doc/manual_src/Makefile5
-rw-r--r--doc/manual_src/galois-github-header.txt8
-rw-r--r--doc/manual_src/images/code-tag.pngbin0 -> 1354 bytes
-rw-r--r--doc/manual_src/images/images/Galois_design_03.pngbin0 -> 999 bytes
-rw-r--r--doc/manual_src/images/logo.pngbin0 -> 3096 bytes
-rw-r--r--doc/manual_src/reset.css48
-rw-r--r--doc/manual_src/style.css339
-rw-r--r--doc/manual_src/template.html66
9 files changed, 439 insertions, 32 deletions
diff --git a/doc/Makefile b/doc/Makefile
index 6d0fc25..fb2fecb 100644
--- a/doc/Makefile
+++ b/doc/Makefile
@@ -18,7 +18,10 @@ $(MANUAL_DIR):
web-manual: $(MANUAL_DIR) $(MAN_DEPS)
@make -C $(MANUAL_SRC)
@cp -r $(MANUAL_SRC)/figures $(MANUAL_DIR)
- @mv $(MANUAL_SRC)/*.html $(MANUAL_DIR)
+ @cp -r $(MANUAL_SRC)/images $(MANUAL_DIR)
+ @cp $(MANUAL_SRC)/*.html $(MANUAL_DIR)
+ @cp $(MANUAL_SRC)/*.css $(MANUAL_DIR)
+# @mv $(MANUAL_SRC)/*.html $(MANUAL_DIR)
clean:
@make -C $(MANUAL_SRC) clean
diff --git a/doc/manual_src/Makefile b/doc/manual_src/Makefile
index 45b0cd3..e924b3f 100644
--- a/doc/manual_src/Makefile
+++ b/doc/manual_src/Makefile
@@ -4,7 +4,7 @@ LIBDIR=../..
HEADER=galois-github-header.txt
BEFORE_BODY=galois-github-before-body.txt
AFTER_BODY=galois-github-after-body.txt
-CSS=$(LIBDIR)/galois-github.css
+#CSS=$(LIBDIR)/galois-github.css
HTML5=-t html5
DOCS := $(patsubst %.md,%.html,$(wildcard *.md))
@@ -15,5 +15,6 @@ clean:
$(RM) $(DOCS)
%.html: %.md
- pandoc $< -o $@ -s --highlight-style=kate -H $(HEADER) -B $(BEFORE_BODY) -A $(AFTER_BODY) -c $(CSS) $(HTML5)
+ pandoc $< -o $@ -s --highlight-style=kate --template=template.html #$(HTML5)
+# pandoc $< -o $@ -s --highlight-style=kate -H $(HEADER) -B $(BEFORE_BODY) -A $(AFTER_BODY) -c $(CSS) $(HTML5)
diff --git a/doc/manual_src/galois-github-header.txt b/doc/manual_src/galois-github-header.txt
index 76b6bb2..3a77f8b 100644
--- a/doc/manual_src/galois-github-header.txt
+++ b/doc/manual_src/galois-github-header.txt
@@ -1,3 +1,11 @@
+ <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" />
+ <title>Install Guide</title>
+
+ <link rel="stylesheet" type="text/css" href="../../reset.css" media="all">
+ <link rel="stylesheet" type="text/css" href="../../style.css" media="all">
+
<style type="text/css">
#siteTitle {
display: block;
diff --git a/doc/manual_src/images/code-tag.png b/doc/manual_src/images/code-tag.png
new file mode 100644
index 0000000..6497ed2
--- /dev/null
+++ b/doc/manual_src/images/code-tag.png
Binary files differ
diff --git a/doc/manual_src/images/images/Galois_design_03.png b/doc/manual_src/images/images/Galois_design_03.png
new file mode 100644
index 0000000..c7fc299
--- /dev/null
+++ b/doc/manual_src/images/images/Galois_design_03.png
Binary files differ
diff --git a/doc/manual_src/images/logo.png b/doc/manual_src/images/logo.png
new file mode 100644
index 0000000..151d3f0
--- /dev/null
+++ b/doc/manual_src/images/logo.png
Binary files differ
diff --git a/doc/manual_src/reset.css b/doc/manual_src/reset.css
new file mode 100644
index 0000000..af94440
--- /dev/null
+++ b/doc/manual_src/reset.css
@@ -0,0 +1,48 @@
+/* http://meyerweb.com/eric/tools/css/reset/
+ v2.0 | 20110126
+ License: none (public domain)
+*/
+
+html, body, div, span, applet, object, iframe,
+h1, h2, h3, h4, h5, h6, p, blockquote, pre,
+a, abbr, acronym, address, big, cite, code,
+del, dfn, em, img, ins, kbd, q, s, samp,
+small, strike, strong, sub, sup, tt, var,
+b, u, i, center,
+dl, dt, dd, ol, ul, li,
+fieldset, form, label, legend,
+table, caption, tbody, tfoot, thead, tr, th, td,
+article, aside, canvas, details, embed,
+figure, figcaption, footer, header, hgroup,
+menu, nav, output, ruby, section, summary,
+time, mark, audio, video {
+ margin: 0;
+ padding: 0;
+ border: 0;
+ font-size: 100%;
+ font: inherit;
+ vertical-align: baseline;
+}
+/* HTML5 display-role reset for older browsers */
+article, aside, details, figcaption, figure,
+footer, header, hgroup, menu, nav, section {
+ display: block;
+}
+body {
+ line-height: 1;
+}
+ol, ul {
+ list-style: none;
+}
+blockquote, q {
+ quotes: none;
+}
+blockquote:before, blockquote:after,
+q:before, q:after {
+ content: '';
+ content: none;
+}
+table {
+ border-collapse: collapse;
+ border-spacing: 0;
+} \ No newline at end of file
diff --git a/doc/manual_src/style.css b/doc/manual_src/style.css
new file mode 100644
index 0000000..e2e6b0c
--- /dev/null
+++ b/doc/manual_src/style.css
@@ -0,0 +1,339 @@
+
+
+/* Layout */
+.wrap {
+ width: 90%;
+ margin: 0 auto;
+}
+
+/* Global */
+body {
+ font-family: "HelveticaNeue-Light", "Helvetica Neue Light", "Helvetica Neue", Helvetica, Arial, "Lucida Grande", sans-serif;
+ font-weight: 300;
+ color: #2C2C2C;
+}
+#content p {
+ font-size: 1em;
+ line-height: 1.125em;
+}
+ /* Header */
+ header {
+ background: #366689;
+ height: 45px;
+ }
+ #logo {
+ display: inline-block;
+ margin-top: 8px;
+ float: left;
+ margin-right: 10px;
+ }
+ header h2,
+ .interior header h2 {
+ font-weight: 300;
+ color: white;
+ padding-top: 10px;
+ font-size: 1.4375em;
+ float: left;
+ }
+ /* Navigation */
+ nav#primary {
+ float: right;
+ margin-top: 8px;
+ }
+ nav#primary ul {
+ margin-right: 70px;
+ }
+ nav#primary ul li {
+ display: inline-block;
+ margin-left: 10px;
+ padding-left: 10px;
+ border-left: 1px solid #fff;
+ }
+ nav#primary ul li:first-child {
+ margin-left: 0;
+ padding-left: 0;
+ border-left: none;
+ }
+ nav#primary ul li a {
+ font-size: 0.875em;
+ text-decoration: none;
+ color: white;
+ }
+
+ /* Footer */
+ footer {
+ clear: both;
+ margin-top: 120px;
+ padding-top: 20px;
+ background: #366689;
+ min-height: 150px;
+ color: white;
+ }
+ footer p {
+ float: right;
+ }
+ footer nav {
+ float: left;
+ }
+ footer nav ul li a {
+ color: white;
+ text-decoration: none;
+ font-size: 0.875em;
+ }
+
+a.button {
+ border: 2px solid #618200;
+ background:#8ea548;
+ -webkit-border-radius: 6px;
+ border-radius: 6px;
+ -webkit-box-shadow: inset 0px 0px 12px 1px rgba(150, 150, 155, .75);
+ box-shadow: inset 0px 0px 12px 1px rgba(150, 150, 155, .75);
+ text-shadow: 1px 1px 1px #628200;
+ filter: dropshadow(color=#628200, offx=1, offy=1);
+ color: white;
+ font-size: 1.5em;
+ text-decoration: none;
+ padding:20px;
+ width: 300px;
+ display: inline-block;
+ text-align: center;
+ margin: 25px 12px;
+}
+p + p,
+p + ul,
+p + a,
+p + h2,
+p + h3,
+p + h4,
+p + img,
+ul + img,
+ol + img,
+ul + div,
+ol + div,
+ul + p,
+ul + h2,
+ul + h3,
+ul + h4,
+ol + p {
+ margin-top: 1em;
+}
+li + li {
+ margin-top: 0.5em;
+}
+a, a:visited {
+ color: #d73f27;
+}
+a:hover {
+ color: #aa2f1b;
+}
+h2{}
+h3{}
+h4{}
+em {font-style: italic;}
+strong {font-weight: 600;}
+
+
+.clearfix {clear:both;}
+
+
+.title {
+
+}
+
+/* Landing Page Styles */
+#content .download {
+ background: #e1e1e1;
+ border: 1px solid #cacaca;
+ -webkit-box-shadow: inset 0px 0px 10px 1px rgba(150, 150, 155, .5);
+ box-shadow: inset 0px 0px 10px 1px rgba(150, 150, 155, .5);
+ text-align: center;
+ padding: 45px 0;
+}
+#content .download h1 {
+ font-weight: 600;
+ font-size: 5.9375em;
+}
+#content .download h1 a {
+ color: #2c2c2c;
+ text-decoration: none;
+}
+#content .download h1 small {
+ font-size: 0.252631578947368em;
+ font-weight: 300;
+ display: block;
+ font-style: italic;
+ line-height: .75em;
+}
+#content .download h2 {
+ font-size: 2.1875em;
+ margin-top: 20px;
+}
+#content .download p {
+ font-size: 1.5em;
+ line-height: 1.25em;
+}
+#content .download pre {
+ background: #2c2c2c;
+ padding: 5px;
+ color: white;
+ font: normal 1em/1em "Lucida Console", "Courier New", Courier, monospace;
+ display: block;
+ max-width: 60%;
+ text-align: left;
+ margin: 0 auto;
+ -webkit-border-radius: 2px;
+ margin-top: 25px;
+ border-radius: 2px;
+}
+.column {
+ width: 31%;
+ float: left;
+ margin-top: 40px;
+ border-left: 1px solid #d7d7d9;
+ padding-left: 2%;
+ margin-right: .3%;
+}
+.column:last-of-type {
+ margin-right: 0;
+}
+.column h2 {
+ font-size: 1.5em;
+ margin-bottom: .75em;
+}
+
+
+
+
+
+/* Interior Page Styles */
+
+/* Subnav */
+.subnav {
+ width: 100%;
+ background: #e1e1e1;
+}
+ .interior .subnav ul {
+ width: 90%;
+ max-width: 90%;
+ margin: 0 auto;
+ padding: 15px 0;
+ }
+ .subnav ul li {
+ display: inline;
+ padding: 0 7px;
+ border-right: 2px solid #2c2c2c;
+ }
+ .subnav ul li:last-of-type {
+ border-right: none;
+ }
+ .subnav ul li a {
+ color: #2c2c2c;
+ font-weight: 600;
+ font-size: 0.875em;
+ text-decoration: none;
+ text-transform: uppercase;
+ }
+ .subnav ul li a:hover {
+ text-decoration: underline;
+ }
+
+.interior h1.title {
+ font-size: 5.9375em;
+ font-weight: 600;
+ text-align: center;
+ margin: 45px 0;
+}
+
+.interior h1 {
+ font-size: 2.625em;
+ margin-bottom: 0.5em;
+ margin-top: 1em;
+}
+
+.interior h2 {
+ font-size: 2.125em;
+ margin-bottom: 0.5em;
+}
+.interior h3 {
+ font-size: 1.5em;
+ margin-bottom: 0.75em;
+ font-weight: 600;
+}
+.interior h4 {
+ font-size: 1em;
+ margin-bottom: 1em;
+ text-transform: uppercase;
+}
+
+.interior #content .wrap > p {
+ line-height: 1.25em;
+ max-width: 80%;
+}
+.interior ul,
+.interior ol {
+ max-width: 80%;
+}
+.interior .figure,
+.interior figure {
+ background: #e1e1e1;
+ padding: 10px;
+ display: inline-block;
+ -webkit-border-radius: 2px;
+ border-radius: 2px;
+}
+.interior code {
+ font-family: Consolas, monospace;
+}
+.interior pre {
+ border-top: 1px solid #E1E1E1;
+ padding: 25px;
+ display: inline-block;
+ border-bottom: 1px solid #E1E1E1;
+ margin: 25px 0;
+ /*background: url(images/code-tag.png) right 5px no-repeat; */
+}
+figure,
+.figure + .figure,
+.figure + p,
+.figure + ul,
+.figure + ol,
+.figure + h2,
+.figure + h3,
+.figure + h4,
+p + .figure,
+ul + .figure,
+ol + .figure,
+.figure + h2,
+.figure + h3,
+.figure + h4,
+pre + p,
+pre + h2,
+pre + h3,
+pre + h4,
+p + pre,
+h2 + pre,
+h3 + pre,
+h4 + pre {
+ margin-top: 1em;
+}
+figure img, .figure img {
+ max-width: 100%;
+ height: auto;
+}
+figcaption, .caption {
+ font-size: 0.875em;
+ font-weight: 600;
+ padding-top: 10px;
+}
+
+ul.steps li {
+ color: #366689;
+ font-weight: 600;
+ padding-left: 1em;
+ list-style: square inside;
+}
+
+
+
+
+
diff --git a/doc/manual_src/template.html b/doc/manual_src/template.html
index 161b998..9aae1de 100644
--- a/doc/manual_src/template.html
+++ b/doc/manual_src/template.html
@@ -1,4 +1,4 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<!DOCTYPE html>
<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" />
@@ -19,7 +19,8 @@ $endif$
$for(css)$
<link rel="stylesheet" href="$css$" $if(html5)$$else$type="text/css" $endif$/>
$endfor$
- <link rel="stylesheet" type="text/css" href="../../galois-github.css" />
+ <link rel="stylesheet" type="text/css" href="reset.css" media="all">
+ <link rel="stylesheet" type="text/css" href="style.css" media="all">
$if(math)$
$math$
$endif$
@@ -27,26 +28,30 @@ $for(header-includes)$
$header-includes$
$endfor$
</head>
-<body>
-<div id="canvasWrapper">
- <div id="canvas">
+<body class="interior">
- <!-- PAGE HEADER -->
- <div id="pageHeaderWrapper">
- <div id="pageHeader">
- <br class="clearer">
- <div id="bannerAreaWrapper"> <div id="bannerArea">
- <div id="siteTitleWrapper">
- <h1 id="siteTitle">
- <a href="http://galois.com/">Galois</a>
- </h1>
- </div>
- </div>
- </div>
- <! -- Banner Area (and wrapper) -->
- </div>
- </div> <!-- Page Header (and wrapper) -->
+ <header>
+ <div class="wrap">
+ <a href="http://galoisinc.github.com/FiveUI" id="logo"
+ title="Galois Open Source"><img src="images/logo.png" alt="Galois" /></a>
+ <h2>Open Source</h2>
+ <nav id="primary">
+ <ul>
+ <li><a href="http://galois.com">Company website</a></li>
+ <li><a href="https://github.com/GaloisInc/">Github home</a></li>
+ </ul>
+ </nav><!-- /#primary -->
+ </div><!-- /.wrap -->
+ </header>
+<!-- ///////////////////////////////////////////
+
+ Template Stops Here, Enter Page Content Below
+
+ //////////////////////////////////////////// -->
+
+ <section id="content">
+ <div class="wrap">
<!-- PAGE BODY -->
<div id="pageBodyWrapper"> <div id="pageBody">
@@ -76,16 +81,19 @@ $include-after$
$endfor$
-</div> </div> <!-- Content (and wrapper) -->
-</div> </div> <!-- Page Body (and wrapper) -->
+ </div><!-- /.wrap -->
+ </section><!-- /#content -->
-<!-- PAGE FOOTER -->
-<div id="pageFooterWrapper"> <div id="pageFooter">
- Get the source code on GitHub:
- <a href="https://github.com/GaloisInc/FiveUI">GaloisInc/FiveUI</a>
-</div> </div> <!-- Page Footer -->
-</div> </div> <!-- Canvas -->
+ <footer>
+ <div class="wrap">
+ <nav id="footer-nav">
+ <ul>
+ <li><a href="http://corp.galois.com/contact/">Contact</a></li>
+ </ul>
+ </nav>
-<div class="clearer" id="bodyClearer"></div>
+ <p>Copyright &copy; 2012 Galois, Inc. All rights reserved.</p>
+ </div><!-- /.wrap -->
+ </footer>
</body>
</html>