-
Notifications
You must be signed in to change notification settings - Fork 30
/
assertj-help.html
183 lines (150 loc) · 8.76 KB
/
assertj-help.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="description" content="AssertJ site">
<meta name="author" content="Joel Costigliola">
<title>AssertJ / Fluent assertions for java</title>
<!-- CSS -->
<link rel="stylesheet" type="text/css" href="http://fonts.googleapis.com/css?family=Inconsolata|Source+Code+Pro|Open+Sans|Ubuntu|Varela+Round|Karla">
<link href="css/bootstrap.min.css" rel="stylesheet">
<link href="font-awesome/css/font-awesome.min.css" rel="stylesheet">
<script src="highlight/highlight.pack.js"></script>
<link rel="stylesheet" href="highlight/styles/railscasts.css">
<script>hljs.initHighlightingOnLoad();</script>
<link href="css/assertj.min.css" rel="stylesheet">
<link rel="shortcut icon" href="favicon.png" />
</head>
<body>
<nav class="navbar navbar-inverse navbar-fixed-top" role="navigation">
<div class="container">
<div class="navbar-header">
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".navbar-ex1-collapse">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<!-- You'll want to use a responsive image option so this logo looks good on devices - I recommend using something like retina.js (do a quick Google search for it and you'll find it) -->
<a class="navbar-brand" href="index.html">AssertJ</a>
</div>
<!-- Collect the nav links, forms, and other content for toggling -->
<div class="collapse navbar-collapse navbar-ex1-collapse">
<ul class="nav navbar-nav navbar-right">
<li><a href="assertj-core-quick-start.html">Quick start</a></li>
<li><a href="assertj-news.html">News</a></li>
<li><a href="assertj-core.html">Core</a></li>
<li><a href="assertj-assertions-generator.html">Assertions generator</a></li>
<li><a href="assertj-guava.html">Guava</a></li>
<li><a href="assertj-joda-time.html">Joda-Time</a></li>
<li><a href="assertj-db.html">DB</a></li>
<li><a href="assertj-neo4j.html">Neo4j</a></li>
<li><a href="assertj-swing.html">Swing</a></li>
<li><a href="assertj-help.html">Help</a></li>
</ul>
</div>
</div>
</nav>
<div class="container">
<div class="row">
<div class="col-md-2 assertj-sidebar-menu">
<div class="bs-sidebar hidden-print affix-top" role="complementary">
<ul class="bs-sidenav nav ">
<li class="sidenav-header">Releases</li>
<li><a href="assertj-core-news.html">Core assertions</a></li>
<li><a href="assertj-assertions-generator.html#news">Assertions generator</a></li>
<li><a href="assertj-guava.html#latest-release">Guava assertions</a></li>
<li><a href="assertj-joda-time.html#latest-release">Joda-Time assertions</a></li>
<li><a href="assertj-neo4j.html#latest-release">Neo4j assertions</a></li>
<li><a href="assertj-db.html#latest-release">DB assertions</a></li>
</ul>
</div>
</div>
<div class="col-lg-10 col-md-10 col-sm-10 text-left">
<h1 class="page-header">AssertJ Help and F.A.Q.</h1>
<ul>
<li><a href="#assertj-build-site">How to edit this site ?</a></li>
</ul>
<h3 class="page-header"><span id="assertj-build-site"></span>How to edit this site ?</h3>
<p>The AssertJ site is hosted on github, in the <span class="small-code">gh-pages</span> branch of the <a href="https://github.com/joel-costigliola/assertj">assertj repository</a>, just use github pull requests to contribute to it.</p>
<p>The site is composed of static HTML pages based on Bootstrap. A simple templating system is used to avoid duplicating site elements like menus or headers. The style aspects of AssertJs site are managed with <a href="http://lesscss.org/">LESS</a> files.</p>
<p>To generate the full site use the command:</p>
<pre><code class="bash">./build-site.sh</code></pre>
<p>As the site is composed of generated files (HTML, css), <b>you need to commit the generated files to publish them</b>.</p>
<h4 class="page-header">Templating system</h4>
<p>The templating system is a simple python script named <span class="small-code">generate-html.py</span> which performs the following steps :</p>
<ul>
<li>read HTML fragments from files like <span class="small-code">assertj-head.html</span> and store their content in a map under predefined keys</li>
<li>process all <span class="small-code">*template.html</span> files replacing <span class="small-code">$key</span> by their map value, e.g. <span class="small-code">$head</span> by the <span class="small-code">assertj-head.html</span> content</li>
<li>dump the resulting content into a file without the template extension, e.g. <span class="small-code">assertj-neo4j.html</span> for <span class="small-code">assertj-neo4j-template.html</span></li>
</ul>
<p>Thus the rules : </p>
<ul>
<li><b>Never directly edit the generated files.</b></li>
<li><b>Commit the generated files</b>, they have to be pushed to the remote git repository to be published.</li>
</ul>
<p>To generate HTML files (without building CSS files), use the command:</p>
<pre><code class="bash">python generate-html.py</code></pre>
<h4 class="page-header">CSS files</h4>
<p>The css files used are built from the following <a href="http://lesscss.org/">LESS</a> files :</p>
<ul>
<li><span class="small-code">custom-bootstrap.less</span> : main LESS file importing all the needed LESS files for Bootstrap</li>
<li><span class="small-code">custom-variables.less</span> : a link to the LESS file containing the main variables used by Bootstrap</li>
<li><span class="small-code">custom-other.less</span> : additional LESS instructions related to Bootstrap</li>
<li><span class="small-code">assertj.less</span> : additional LESS instructions for stuff not directly related to Bootstrap.</li>
</ul>
<p>To modify AssertJ style, either change existing values in <span class="small-code">custom-variables.less</span>
or add new instructions in <span class="small-code">assertj.less</span>.</p>
<p>To generate the CSS files, it is best to reuse the build all command since generating HTML files is super fast:</p>
<pre><code class="bash">./build-site.sh</code></pre>
</div>
</div>
</div>
<br>
<!--
<div class="container">
<footer>
<div class="row">
<div class="col-lg-12">
<p>AssertJ - Licensed under the Apache License, Version 2.0.</p>
</div>
</div>
</footer>
</div>
-->
<script src="js/jquery-1.10.2.js"></script>
<script src="js/bootstrap.js"></script>
<script src="js/modern-business.js"></script>
<script src="js/assertj.js"></script>
</body>
</html>
<nav class="navbar navbar-inverse navbar-fixed-top" role="navigation">
<div class="container">
<div class="navbar-header">
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".navbar-ex1-collapse">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<!-- You'll want to use a responsive image option so this logo looks good on devices - I recommend using something like retina.js (do a quick Google search for it and you'll find it) -->
<a class="navbar-brand" href="index.html">AssertJ</a>
</div>
<!-- Collect the nav links, forms, and other content for toggling -->
<div class="collapse navbar-collapse navbar-ex1-collapse">
<ul class="nav navbar-nav navbar-right">
<li><a href="assertj-core-quick-start.html">Quick start</a></li>
<li><a href="assertj-news.html">News</a></li>
<li><a href="assertj-core.html">Core</a></li>
<li><a href="assertj-assertions-generator.html">Assertions generator</a></li>
<li><a href="assertj-guava.html">Guava</a></li>
<li><a href="assertj-joda-time.html">Joda-Time</a></li>
<li><a href="assertj-db.html">DB</a></li>
<li><a href="assertj-neo4j.html">Neo4j</a></li>
<li><a href="assertj-swing.html">Swing</a></li>
<li><a href="assertj-help.html">Help</a></li>
</ul>
</div>
</div>
</nav>