comparison doc/html/resources/template.html @ 6:78a9c59de053

Docs: synchronize templates with irccd-web
author David Demelier <markand@malikania.fr>
date Wed, 10 Feb 2016 09:00:58 +0100
parents 1158cffe5a5e
children 070a1ece2af6
comparison
equal deleted inserted replaced
5:59c152b4508d 6:78a9c59de053
3 <head> 3 <head>
4 <meta charset="utf-8"> 4 <meta charset="utf-8">
5 <meta http-equiv="X-UA-Compatible" content="IE=edge"> 5 <meta http-equiv="X-UA-Compatible" content="IE=edge">
6 <meta name="viewport" content="width=device-width, initial-scale=1"> 6 <meta name="viewport" content="width=device-width, initial-scale=1">
7 <!-- The above 3 meta tags *must* come first in the head; any other head content must come *after* these tags --> 7 <!-- The above 3 meta tags *must* come first in the head; any other head content must come *after* these tags -->
8 <meta name="description" content=""> 8 <meta name="description" content="IRC Client Daemon">
9 <meta name="author" content=""> 9 <meta name="author" content="David Demelier">
10 10
11 <title>$title$</title> 11 <title>$title$</title>
12 12
13 <!-- Bootstrap core CSS --> 13 <!-- CSS -->
14 <link href="$baseurl$css/bootstrap.css" rel="stylesheet"> 14 <link href="$baseurl$/css/bootstrap.min.css" rel="stylesheet">
15 15 <link href="$baseurl$/css/tomorrow.css" rel="stylesheet">
16 <!-- Custom styles for this template --> 16
17 <link href="$baseurl$css/doc.css" rel="stylesheet"> 17 $if(web)$
18 18 <link href="$baseurl$/css/irccd.css" rel="stylesheet">
19 <!-- Overrides for guide --> 19 $endif$
20
21 $if(doc)$
22 <link href="$baseurl$/css/doc.css" rel="stylesheet">
23 $endif$
24
20 $if(guide)$ 25 $if(guide)$
21 <link href="$baseurl$css/doc-guide.css" rel="stylesheet"> 26 <link href="$baseurl$/css/doc-guide.css" rel="stylesheet">
22 $endif$
23
24 <!-- Pandoc highlighting -->
25 $if(highlighting-css)$
26 <style type="text/css">
27 $highlighting-css$
28 </style>
29 $endif$ 27 $endif$
30 28
31 <!-- HTML5 shim and Respond.js for IE8 support of HTML5 elements and media queries --> 29 <!-- HTML5 shim and Respond.js for IE8 support of HTML5 elements and media queries -->
32 <!--[if lt IE 9]> 30 <!--[if lt IE 9]>
33 <script src="https://oss.maxcdn.com/html5shiv/3.7.2/html5shiv.min.js"></script> 31 <script src="https://oss.maxcdn.com/html5shiv/3.7.2/html5shiv.min.js"></script>
34 <script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script> 32 <script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script>
35 <![endif]--> 33 <![endif]-->
36 </head> 34 </head>
37 35
38 <body> 36 <body>
39 <div class="container-fluid"> 37 $if(web)$
40 <div class="row"> 38 <nav class="navbar navbar-fixed-top navbar-inverse">
41 <!-- Side bar --> 39 <div class="container">
42 <div class="col-sm-1 col-md-2 sidebar"> 40 <div class="navbar-header">
43 <!-- Side bar for JavaScript --> 41 <button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#navbar" aria-expanded="false" aria-controls="navbar">
42 <span class="sr-only">Toggle navigation</span>
43 <span class="icon-bar"></span>
44 <span class="icon-bar"></span>
45 <span class="icon-bar"></span>
46 </button>
47 <a class="navbar-brand" href="$baseurl$/index.html">irccd</a>
48 </div><!-- navbar-header -->
49 <div id="navbar" class="navbar-collapse collapse">
50 <ul class="nav navbar-nav">
51 <li><a href="$baseurl$/about.html">About</a></li>
52 <li><a href="$baseurl$/documentation.html">Documentation</a></li>
53 <li><a href="$baseurl$/download.html">Download</a></li>
54 <li><a href="$baseurl$/contribute.html">Contribute</a></li>
55 <li><a href="$baseurl$/support.html">Support</a></li>
56 </ul>
57 <p id="joke" class="navbar-text navbar-right">The definitive bot</p>
58 </div><!-- !navbar -->
59 </div><!-- !container -->
60 </nav>
61
62 $if(home)$
63 <!-- Main jumbotron for a primary marketing message or call to action -->
64 <div class="jumbotron">
65 <div class="container">
66 <h1>IRC Client Daemon</h1>
67 <p>Irccd is an IRC bot written in C++14 and Javascript. It is fast, light, powerful, scalable.</p>
68 <p><a class="btn btn-primary btn-lg" href="#" role="button">Download now &raquo;</a></p>
69 </div>
70 </div>
71 $endif$ <!-- ! endif home -->
72 $endif$ <!-- ! endif web -->
73
74 $if(doc)$
75 <div class="container-fluid">
76 $endif$
77 $if(general)$
78 <div class="container">
79 $endif$
80
81 $if(doc)$
82 <div class="row">
83 <!-- Side bar -->
84 <div class="col-sm-1 col-md-2 sidebar">
85 <!-- Side bar for JavaScript -->
44 $if(js)$ 86 $if(js)$
45 <a href="$baseurl$api/index.html"><h3>Home</h3></a> 87 <a href="$baseurl$api/index.html"><h3>Home</h3></a>
46 <h3>Events</h3> 88 <h3>Events</h3>
47 <ul class="nav nav-sidebar sidebar-list"> 89 <ul class="nav nav-sidebar sidebar-list">
48 <li><a href="$baseurl$api/event/onChannelMode.html">onChannelMode</a></li> 90 <li><a href="$baseurl$api/event/onChannelMode.html">onChannelMode</a></li>
49 <li><a href="$baseurl$api/event/onChannelNotice.html">onChannelNotice</a></li> 91 <li><a href="$baseurl$api/event/onChannelNotice.html">onChannelNotice</a></li>
50 <li><a href="$baseurl$api/event/onCommand.html">onCommand</a></li> 92 <li><a href="$baseurl$api/event/onCommand.html">onCommand</a></li>
51 <li><a href="$baseurl$api/event/onConnect.html">onConnect</a></li> 93 <li><a href="$baseurl$api/event/onConnect.html">onConnect</a></li>
52 <li><a href="$baseurl$api/event/onInvite.html">onInvite</a></li> 94 <li><a href="$baseurl$api/event/onInvite.html">onInvite</a></li>
53 <li><a href="$baseurl$api/event/onJoin.html">onJoin</a></li> 95 <li><a href="$baseurl$api/event/onJoin.html">onJoin</a></li>
54 <li><a href="$baseurl$api/event/onKick.html">onKick</a></li> 96 <li><a href="$baseurl$api/event/onKick.html">onKick</a></li>
55 <li><a href="$baseurl$api/event/onLoad.html">onLoad</a></li> 97 <li><a href="$baseurl$api/event/onLoad.html">onLoad</a></li>
56 <li><a href="$baseurl$api/event/onMe.html">onMe</a></li> 98 <li><a href="$baseurl$api/event/onMe.html">onMe</a></li>
57 <li><a href="$baseurl$api/event/onMessage.html">onMessage</a></li> 99 <li><a href="$baseurl$api/event/onMessage.html">onMessage</a></li>
58 <li><a href="$baseurl$api/event/onMode.html">onMode</a></li> 100 <li><a href="$baseurl$api/event/onMode.html">onMode</a></li>
59 <li><a href="$baseurl$api/event/onNames.html">onNames</a></li> 101 <li><a href="$baseurl$api/event/onNames.html">onNames</a></li>
60 <li><a href="$baseurl$api/event/onNick.html">onNick</a></li> 102 <li><a href="$baseurl$api/event/onNick.html">onNick</a></li>
61 <li><a href="$baseurl$api/event/onNotice.html">onNotice</a></li> 103 <li><a href="$baseurl$api/event/onNotice.html">onNotice</a></li>
62 <li><a href="$baseurl$api/event/onPart.html">onPart</a></li> 104 <li><a href="$baseurl$api/event/onPart.html">onPart</a></li>
63 <li><a href="$baseurl$api/event/onQuery.html">onQuery</a></li> 105 <li><a href="$baseurl$api/event/onQuery.html">onQuery</a></li>
64 <li><a href="$baseurl$api/event/onQueryCommand.html">onQueryCommand</a></li> 106 <li><a href="$baseurl$api/event/onQueryCommand.html">onQueryCommand</a></li>
65 <li><a href="$baseurl$api/event/onReload.html">onReload</a></li> 107 <li><a href="$baseurl$api/event/onReload.html">onReload</a></li>
66 <li><a href="$baseurl$api/event/onTopic.html">onTopic</a></li> 108 <li><a href="$baseurl$api/event/onTopic.html">onTopic</a></li>
67 <li><a href="$baseurl$api/event/onUnload.html">onUnload</a></li> 109 <li><a href="$baseurl$api/event/onUnload.html">onUnload</a></li>
68 <li><a href="$baseurl$api/event/onWhois.html">onWhois</a></li> 110 <li><a href="$baseurl$api/event/onWhois.html">onWhois</a></li>
69 </ul> 111 </ul>
70 <h3>Modules</h3> 112 <h3>Modules</h3>
71 <ul class="nav nav-sidebar sidebar-list"> 113 <ul class="nav nav-sidebar sidebar-list">
72 <li><a href="$baseurl$api/module/Irccd/index.html">Irccd</a></li> 114 <li><a href="$baseurl$api/module/Irccd/index.html">Irccd</a></li>
73 <li><a href="$baseurl$api/module/Irccd.Directory/index.html">Irccd.Directory</a></li> 115 <li><a href="$baseurl$api/module/Irccd.Directory/index.html">Irccd.Directory</a></li>
74 <li><a href="$baseurl$api/module/Irccd.ElapsedTimer/index.html">Irccd.ElapsedTimer</a></li> 116 <li><a href="$baseurl$api/module/Irccd.ElapsedTimer/index.html">Irccd.ElapsedTimer</a></li>
75 <li><a href="$baseurl$api/module/Irccd.File/index.html">Irccd.File</a></li> 117 <li><a href="$baseurl$api/module/Irccd.File/index.html">Irccd.File</a></li>
76 <li><a href="$baseurl$api/module/Irccd.Logger/index.html">Irccd.Logger</a></li> 118 <li><a href="$baseurl$api/module/Irccd.Logger/index.html">Irccd.Logger</a></li>
77 <li><a href="$baseurl$api/module/Irccd.Plugin/index.html">Irccd.Plugin</a></li> 119 <li><a href="$baseurl$api/module/Irccd.Plugin/index.html">Irccd.Plugin</a></li>
78 <li><a href="$baseurl$api/module/Irccd.Server/index.html">Irccd.Server</a></li> 120 <li><a href="$baseurl$api/module/Irccd.Server/index.html">Irccd.Server</a></li>
79 <li><a href="$baseurl$api/module/Irccd.System/index.html">Irccd.System</a></li> 121 <li><a href="$baseurl$api/module/Irccd.System/index.html">Irccd.System</a></li>
80 <li><a href="$baseurl$api/module/Irccd.Timer/index.html">Irccd.Timer</a></li> 122 <li><a href="$baseurl$api/module/Irccd.Timer/index.html">Irccd.Timer</a></li>
81 <li><a href="$baseurl$api/module/Irccd.Unicode/index.html">Irccd.Unicode</a></li> 123 <li><a href="$baseurl$api/module/Irccd.Unicode/index.html">Irccd.Unicode</a></li>
82 <li><a href="$baseurl$api/module/Irccd.Util/index.html">Irccd.Util</a></li> 124 <li><a href="$baseurl$api/module/Irccd.Util/index.html">Irccd.Util</a></li>
83 </ul> 125 </ul>
84 $endif$<!-- js --> 126 $endif$ <!-- endif js -->
85 127
86 <!-- Side bar for guide --> 128 <!-- Side bar for guide -->
87 $if(guide)$ 129 $if(guide)$
88 $toc$ 130 $toc$
89 $endif$ 131 $endif$ <!-- endif guide -->
90 </div><!-- Side bar --> 132 </div><!-- Side bar -->
91 133
92 <div class="col-sm-9 col-sm-offset-3 col-md-10 col-md-offset-2 main"> 134 <div class="col-sm-9 col-sm-offset-3 col-md-10 col-md-offset-2 main">
93 <!-- Page body for JavaScript --> 135 <!-- Page body for JavaScript -->
94 $if(js)$ 136 $if(js)$
95 <!-- Page header, may be: event | module | function | method --> 137 <!-- Page header, may be: event | module | function | method -->
96 <!-- Event --> 138 <!-- Event -->
97 $if(event)$ 139 $if(event)$
98 <h1 class="page-header">Event: $event$</h1> 140 <h1 class="page-header">Event: $event$</h1>
99 $endif$ 141 $endif$
100 142
101 <!-- Module --> 143 <!-- Module -->
102 $if(module)$ 144 $if(module)$
103 <h1 class="page-header">Module: $module$</h1> 145 <h1 class="page-header">Module: $module$</h1>
104 $endif$ 146 $endif$
105 147
106 <!-- Function --> 148 <!-- Function -->
107 $if(function)$ 149 $if(function)$
108 <h1 class="page-header">Function: $function$</h1> 150 <h1 class="page-header">Function: $function$</h1>
109 $endif$ 151 $endif$
110 152
111 <!-- Method --> 153 <!-- Method -->
112 $if(method)$ 154 $if(method)$
113 <h1 class="page-header">Method: $method$</h1> 155 <h1 class="page-header">Method: $method$</h1>
114 $endif$ 156 $endif$
115 <!-- End of page header --> 157 <!-- End of page header -->
116 158
117 <div class="table-responsive"> 159 <div class="table-responsive">
118 <!-- Summary -->
119 $summary$ 160 $summary$
120 <!-- !Summary --> 161
121
122 <!-- Synopsis -->
123 $if(synopsis)$ 162 $if(synopsis)$
124 <h2>Synopsis</h2> 163 <h2>Synopsis</h2>
125 164
126 <!-- Javascript function signature --> 165 <!-- Javascript function signature -->
127 <pre class="sourceCode javascript">$synopsis$</pre> 166 <pre class="sourceCode javascript">$synopsis$</pre>
128 $endif$ 167 $endif$ <!-- endif synopsis -->
129 <!-- !Synopsis --> 168
130 169 <!-- Arguments -->
131 <!-- Arguments -->
132 $if(arguments)$ 170 $if(arguments)$
133 <h2>Arguments</h2> 171 <h2>Arguments</h2>
134 <ul> 172 <ul>
135 $for(arguments)$ 173 $for(arguments)$
136 <li>$arguments$</li> 174 <li>$arguments$</li>
137 $endfor$ 175 $endfor$
138 </ul> 176 </ul>
139 $endif$ 177 $endif$ <!-- endif arguments -->
140 <!-- !Arguments --> 178
141
142 <!-- Returns -->
143 $if(returns)$ 179 $if(returns)$
144 <h2>Returns</h2> 180 <h2>Returns</h2>
145 <p>$returns$</p> 181 <p>$returns$</p>
146 $endif$ 182 $endif$ <!-- endif returns -->
147 <!-- !Returns --> 183
148
149 <!-- Body -->
150 $body$ 184 $body$
151 <!-- !Body --> 185 <!-- !Body -->
152 </div><!-- !table-responsive --> 186 </div><!-- !table-responsive -->
153 $endif$ 187 $endif$ <!-- endif js -->
154 188
155 <!-- Page body for guide --> 189 <!-- Page body for guide -->
156 $if(guide)$ 190 $if(guide)$
157 <div class="table-responsive"> 191 <div class="table-responsive">
158 <!-- Generic header --> 192 <!-- Generic header -->
159 $if(header)$ 193 $if(header)$
160 <h1 class="page-header">$header$</h1> 194 <h1 class="page-header">$header$</h1>
161 $endif$ 195 $endif$
162 196
163 $body$ 197 $body$
164 </div><!-- !table-responsive --> 198 </div><!-- !table-responsive -->
165 $endif$ 199 $endif$ <!-- endif guide -->
166 </div><!-- !column --> 200 </div><!-- !column -->
167 </div><!-- !row --> 201 </div><!-- !row -->
168 </div><!-- !container-fluid --> 202 $endif$
203
204 $if(general)$
205 $body$
206 $endif$ <!-- endif general -->
207
208 <hr>
209 <footer>
210 <p>&copy; 2013-2016 David Demelier.</p>
211 </footer>
212 </div> <!-- !container -->
169 213
170 <!-- Bootstrap core JavaScript 214 <!-- Bootstrap core JavaScript
171 ================================================== --> 215 ================================================== -->
172 <!-- Placed at the end of the document so the pages load faster --> 216 <!-- Placed at the end of the document so the pages load faster -->
173 <script src="$baseurl$js/jquery.min.js"></script> 217 <script src="$baseurl$/js/jquery.min.js"></script>
174 <script src="$baseurl$js/bootstrap.min.js"></script> 218 <script src="$baseurl$/js/bootstrap.min.js"></script>
175 219
176 <!-- Bootstrapify what is compiled by pandoc and not automatically managed by bootstrap --> 220 $if(web)$
177 <script> 221 <script src="$baseurl$/js/joke.js"></script>
178 jQuery("table").addClass("table"); 222 $endif$
179 </script> 223
224 <script src="$baseurl$/js/highlight.js"></script>
225 <script>hljs.initHighlightingOnLoad();</script>
226 <script>jQuery("table").addClass("table");</script>
180 </body> 227 </body>
181 </html> 228 </html>