Skip to content

Commit 098bb02

Browse files
committed
Added specifications web site.
1 parent 12ba347 commit 098bb02

9 files changed

+756
-0
lines changed

docs/specs/README.md

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# novelibre specifications
2+
3+
The web pages containing the specifications are created using the [Zim Desktop Wiki](https://zim-wiki.org/) application.
4+
5+
Copyright (c) 2025 Peter Triesberger. All rights reserved.

docs/specs/html/.nojekyll

Whitespace-only changes.

docs/specs/html/index.html

+197
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,197 @@
1+
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2+
<html>
3+
<head>
4+
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5+
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
6+
7+
<title>Index of the novelibre specifications</title>
8+
<meta name="generator" content="Zim 0.69.1">
9+
<meta name="viewport" content="width=device-width">
10+
<!-- <link href='http://fonts.googleapis.com/css?family=Open+Sans:300&subset=latin,greek,latin-ext' rel='stylesheet' type='text/css'> -->
11+
<![if !IE]>
12+
<!-- comment out for IE since it spams the user with warnings -->
13+
<script type='text/javascript' src='http://code.jquery.com/jquery-1.7.1.js'></script>
14+
<script type='text/javascript'>
15+
$(window).load(function(){$("#navigation").height( $("#content").height()+65 );});
16+
</script>
17+
<![endif]>
18+
<style>
19+
body, html {
20+
height:100%;
21+
font-family:'Open Sans', sans-serif;
22+
line-height:1.5em;
23+
font-weight:300;
24+
background-color:#FAFAFA;
25+
text-rendering:geometricPrecision;
26+
margin:0;
27+
padding:0;
28+
}
29+
.wrapper {
30+
height:100%;
31+
position:relative;
32+
}
33+
#navigation {
34+
background-color:#F3F3F3;
35+
display:inline-block;
36+
border-right:1px solid #EAEAEA;
37+
padding-right:65px;
38+
padding-top:65px;
39+
padding-left:25px;
40+
position:relative;
41+
float:left;
42+
min-height:100%;
43+
}
44+
#content {
45+
float:left;
46+
display:inline-block;
47+
position:absolute;
48+
max-width:960px;
49+
padding:65px;
50+
}
51+
#navigation ul {
52+
margin-top:0;
53+
margin-bottom:0;
54+
padding-left:40px;
55+
}
56+
#navigation li {
57+
list-style-type:none;
58+
}
59+
#navigation a {
60+
text-decoration:none;
61+
color:gray;
62+
}
63+
#navigation strong {
64+
color:#4E9A06;
65+
font-weight:400;
66+
}
67+
#navigation a:hover {
68+
text-decoration:underline;
69+
}
70+
#content h1:nth-child(1) {
71+
margin-top:0;
72+
}
73+
h1,h2,h3,h4,h5,h6 {
74+
color:#4E9A06;
75+
font-weight:300;
76+
margin-bottom: 0;
77+
}
78+
p {
79+
margin-top: 0;
80+
}
81+
#content a {
82+
color:#CE5C00;
83+
}
84+
#content a {
85+
text-decoration: none;
86+
}
87+
#content a:hover {
88+
text-decoration: underline;
89+
}
90+
#content a:active {
91+
text-decoration: underline;
92+
}
93+
#content strike {
94+
color: grey;
95+
}
96+
#content u {
97+
text-decoration: none;
98+
background-color: yellow;
99+
}
100+
#content tt {
101+
color: #2e3436;
102+
}
103+
#content pre {
104+
color: #2e3436;
105+
margin-left: 20px;
106+
}
107+
.backlinks {
108+
color:gray;
109+
}
110+
hr.footnotes {
111+
width: 20%;
112+
margin-left: 0;
113+
}
114+
@media print{
115+
#navigation{
116+
background-color:#FFF;
117+
}
118+
}
119+
120+
span.zim-tag {
121+
color: #ce5c00;
122+
}
123+
div.zim-object {
124+
border-style:solid;
125+
border-width:1px;
126+
}
127+
128+
.checked-box {list-style-image: url(data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABgAAAAYCAYAAADgdz34AAAAAXNSR0IArs4c6QAAAAZiS0dEAP8A/wD/oL2nkwAAAAlwSFlzAAANOgAADMQBiN+4gQAAAAd0SU1FB9gKGQ8sMEGsKGkAAAAZdEVYdENvbW1lbnQAQ3JlYXRlZCB3aXRoIEdJTVBXgQ4XAAAEBUlEQVRIx62V22tdRRTGf7Nn73P2ybntnNOe3NqkPTGgLTVUUZF6QatSLOKTPgqCIqLgQ0H/A1sQQbBYCBb1QfAxiC8tSO1FqHkwJVKtjdTGNraUmObsc9nXmfGh7cGYpM1D5nHWzPetteZb3wg2eB2YqYm4zSadsMtoboiNBH/3TE0awx6j+MRoxoTg/IYRvP19TQrJS0bzhdHGSyKFkLTtjSKwMjyiEz43ynhtP6bdjBCWyFobAf7eT7VhNF/q1FRbjYjmUohlCVPwnB+6FUxMTJipqSmUUhhjEGKd3bMT4ks/Y6oLBK2Yth8hHYtCJXOix7Nf7xLMzc0xOzvLzp078TyPNE3viW3QJPXzhNWbxFFKHCmMhoLn/FHodd48vGfhapdAacXQlkFK5dL6wIUm6fuTZPuvqDQhaMUYYyiVyuQr6rXDexYuAdi3tSv1ZJNs/R/CaszzT+1na88uXFnCEnJVgivBNN8uTJKmHQI/ptOOcXNZzMz9mOqFs90OHpipWcYwlo5P4ebnuOkrvr5wgrH+h3im7y36MzuwRXYZeKha/OhP0EkadFoxQSdGSotedR/+XwMc2XvKdNUFOFqZx6LKZWIiwjgkikNmLp/hm8sH+K1zjFTHXfBYdTi+eJArzXM0GxFxoBDCopLvo/fqEwi1XPkWkGqjFo2TgB1jOYZUKZTS/D1/ncmLh7jon0IbRWoiTi59ymzzJEEQE3cStNZsGxqlfPE57MBbOR8fP3hDGalOO9fq2DlBvmZw8xa2IxACGn6TydlD/O6f5OzSV/zif0cYhLQaEXGkKBbz7Ov/AOlXV1cxgBJRI3fuSTrpTawt18kWIZN1CFuaONI0w0WOXfsI43YIggh/KUSlhqxrMz74AkOZcWBm9QkH+Gw8NDLuITi+m0yzhluSyJzBLcpblUhFxywSRAEtPwQjsKVN30CNh0uvYuOubSHLtN3J0TO1j0pmBNuFbFWRK0gyPRZpktL2I5JQkclKakNlnh54g6ocvevUr/Ai2a7wineEkcJupA3S1Wg0nVZM2E6wbEF5U5G9Q++wI7sfR7h3N8HVNstykBfzH+KJEZwiWD0aIwxCgJ0R1Mu7GXOeJSuK93bZtQIle4D9pUNU5DC5jEsu55AvZakM5NicGyEj8uuz8bUCQgj67QfY671P3vEoeC69gy695U1U7NG7XV0pUwBjDJa1/JJlWWxzHuflzQe5FJ/GsgUVuZ2t8lEkTvfc0aNHb72flBhjVicQQqCUuvM3/M+WDVguWBrMVdDXEGZlBVEUrVCU9d9s5+fnaTQa2PZyPxEIhJaI1EEoZwX4ncynp6fXrmB4eJjR0VFarRbNZnP9P9rt9gohqNVq1Ov1ZbF/AZGev3hLJ2/zAAAAAElFTkSuQmCC)}
129+
.xchecked-box {list-style-image: url(data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABgAAAAYCAYAAADgdz34AAAAAXNSR0IArs4c6QAAAAZiS0dEAP8A/wD/oL2nkwAAAAlwSFlzAAANOgAADMQBiN+4gQAAAAd0SU1FB9gKGQ8bDYnDxEwAAAAZdEVYdENvbW1lbnQAQ3JlYXRlZCB3aXRoIEdJTVBXgQ4XAAAEK0lEQVRIx9WVS2hTWRjHf/eR3CY1nbxMH2YiZRQS6qO13YlMVxY3SnVcuNIBFezGpSADLoQqLu1sHJCqdCFSXFpw4YOCSH3BtFqttTNamabX3DS5bfO6uffMoglja3RGcDMHzuac7/z/53++//cd+L8P6VuCPQYZ8ADNgBd4J31DcDcQs+GnHByRocEDv0kfBSjAOlYCs11Q+gpwDegS8LMJ+3QIK0ATzEhV8Odnz5bzw8P4dJ25aJQ/WlvJ1df/K7hSLtOcTNI+Pk69rpMTgqIQhCDvh1/VSpw79+gRrRMTmLZNezLJJsPg+a5dmOEwQlFqg1sWG16/Jv7sGWXDwBACFQjC9HcwIMONKkGp4PGAJGEDS0IQmZlhnWnye3c3eiyGo6qr3WHbrJ+dJf7gAXI6zSIr72T7/fgzmT4FHnTBsgrQBfYvTU0km5vxz86iADnAm0rRPTWFt7cXZccOJJcLAGHb2K9ekT93jmwmwwdAAFpjI6Ntbfxw5879ag7l6o1sr5eHHR3IsRgeQK/M4sQE+YEB7JcvEY6zAj45SWFgAPPxYwzHoQxIkQjTPT0kIxE+Noj8sexFn4/xnh58iQTeSpHkHAdrbIzi0BCOrmNPTpK/eJHM3bt8sCyKQCiR4NWePWSiUZw1+ZLXJm4pFKLhzBlCsRh2RUXacVgeGaF47RrL58+zcP8+RrmMkCQinZ1EL1zAjERqmkH+tLYl1G3bCJw4QUjT0IA0MJfLMX/5MqmHD0nZNiUgtGULG/r7ccXjINWuWbnmqsuFu7sb/4EDNLlcBIEioNs2KUAFGmMxmk6dQm1tRZI+3xBqEkiShBQOox05Ql1nJ26gvuIUAWiKQnj/ftStW5Fk+YuF+NldsbBA4cYN9KdPmaso8Fc62ZJtk7l1C2t0FGdxESHE1xE4hkHh6lX0oSHSpRIewC/LrPf7CSgKNpCamkI/fZr8pUuIZBIcpyaBunahPp1mub+fDyMjGKUSChCsq6Nh717q9u2jbnSU0uAgRrFIwTThyhUCqRS+hgZKLS1fJvDm87SNjZGcnsYUAjcQ8vsJ9/Xh7u1FDgRQN20iks3iDA+zZFmYhQLqzZtsj8WY3L0baY2Sf55ICCKpFHUzM2SEQAJCHg+hY8fQDh5EDgRWDoRC1J88SePRo2geD0XAcBy8b98Sv3ePYDZbbf2rFQjLIphMsmDbaEBQVQkePox26BCSz7e6i4bDrDt+nGYhmBscpFAskheC4Js3bPR4qHphFYEnlcI7P4/jdqNpGu8TCe4oCsXr1z//F2ga3+/cSfTJE0qmSVYIsKzaOZDcbjKyzFIiwfvt21kMBLA07YsetzWNd+3tLLW0sH5igvT8PH9Go/z44kX+E4LGjg7GDYOcy4XlOEgLC//5P/5LCFzxOPLmzWyIx+m6fduu7v0NVGqyTSycKksAAAAASUVORK5CYII=)}
130+
.unchecked-box {list-style-image: url(data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABgAAAAYCAYAAADgdz34AAAAAXNSR0IArs4c6QAAAAZiS0dEAP8A/wD/oL2nkwAAAAlwSFlzAAANOgAADMQBiN+4gQAAAAd0SU1FB9gKGQ8qAt8h3m8AAAAZdEVYdENvbW1lbnQAQ3JlYXRlZCB3aXRoIEdJTVBXgQ4XAAAA60lEQVRIx+2VsQqDMBRF70sCLg5OLoKgjk7+lJ/hh+STXBwcnRz8ArMEkrxOFktbaC3tULzTg5e8k5vADXDq70VbobXmvu/hvQczg4heHrJfXxQFuq67blZbMc8zpmlCXddIkgTOuZcBUko45zCOI6y1Nz2xFSEEZFmGOI7fGg4A3nsQEZqmuXOu9jallACAtm3fvmutNaIoAjM/dkBECCF89KCbk4eAb+kEnIAT8EsAM0OIz3hSyrssUvss8t5fg+uIrLXPs0gIgWVZYIyBUurQyYdheO4gz3NUVQVjDNZ1PfSjpWmKsixvehfB9GBZ3NndrgAAAABJRU5ErkJggg==)}
131+
.migrated-box {list-style-image: url(data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABgAAAAYCAYAAADgdz34AAAABGdBTUEAALGPC/xhBQAAAAZiS0dEAP8A/wD/oL2nkwAAAAlwSFlzAAANOgAADMQBiN+4gQAAAAd0SU1FB+AKHREFA8vJSnkAAAAZdEVYdENvbW1lbnQAQ3JlYXRlZCB3aXRoIEdJTVBXgQ4XAAAC1klEQVRIx+2VT0hUURTGf/e958w4Tc3TYowMw1GyEgwr1MqsFmbZIrIWQZsWJUjbdoHQpl3Qps0swnCRECQFYkR/TC1iKkqmfzAKTo2Vf8hoRsfR995tkRMT87RRWkUHHhy495zvnvvu933wP/75EKkkEAjIYDCIaZpIKRFCZN0kfX9xcTGtra2/irVUEolECIfDlJeXo+s6hmFkDaCqKoZhEAqFSCaTv60pqcSyLAoLC/F4PEtqDmCaJkIIKisrMybX0sdUVRWA5ubmPzdNjjI1cpXkZC/O1fV03PXgdDqRUtpPIITAsqxsDz0Z/3CZQv8uqo4N4C8/Tp2/DdM0MiZQlvk41OTkI/LW1SGtCVb5drD3eCc71wcA+VcAHA5vDd8+3UGakxiJV7i9pdQevU5T1R35pJ3MV5QW1pf+0kWBheJ2SWua8EQXZXsu4fVVYEz1sEKvof5EuxjoPvzpcRvrdp9C2gGMx6cpOHBmbImMesds7BZubwMVDTfXDnQ3vQfK7AC8wLfExMX5whyQc3q2OEnjGm5vE76SQxsfBLr77a7CNf+n0r/l6sSMtsBSnurckiIILCobAtVZhpF4gZF4jubaymj4Ch/fd380LE7bAnjc0NPxk2yqpmEuwGxF0ag+0k5uTpzZeBeaazvj0We8fXojainsb2xh2BZgbe0gSIllzSIUh63wfQ6dZ/O2fbjcKlOj58jJ3cVENESw5yErc9nf2MLQ4jwQAkV1Lqiq37/cZ9WaahJjF9AcmxiPDhLs7ePe23oOnmUwg2hSShQle96tKDjA2HAniusgo9FxnvY9Jxw7RWzGYy92QghM00x5g53qp9sHmtB58/o2umOI2NwGolMnMYUHIb7aAyiKwsjICLqu2/qBEIKUUAohMaSHSLyBSMoPTINQ6CX5+fn2AEVFRZSUlBCPx4nFYhl3L4RESjF/GEgX3pSj+Xw+/H7/b3U/AEOZFnp7O5+5AAAAAElFTkSuQmCC)}
132+
ul {list-style-image: none}
133+
/* ul rule needed to reset style for sub-bullets */
134+
135+
</style>
136+
</head>
137+
138+
<body>
139+
<div class="wrapper">
140+
<div id="navigation"> <ul>
141+
<li><b>index</b>
142+
<ul>
143+
<li><a href="./index/Requirements_Overview.html" title="Requirements Overview" class="page">Requirements Overview</a></li>
144+
<li><a href="./index/User_Stories.html" title="User Stories" class="page">User Stories</a></li>
145+
</ul></li>
146+
</ul>
147+
</div>
148+
<div id="content">
149+
<h1>Index of the novelibre specifications <a name='index'></a></h1>
150+
151+
<p>
152+
This web site contains the specifications for the <a href="https://github.com/peter88213/novelibre" title="novelibre" class="https">novelibre</a> novel organizer software.
153+
</p>
154+
155+
<h2>Requirements</h2>
156+
157+
<br>
158+
159+
<p>
160+
<a href="./index/Requirements_Overview.html" title="+Requirements Overview" class="page">+Requirements Overview</a><br>
161+
<a href="./index/User_Stories.html" title="+User Stories" class="page">+User Stories</a>
162+
</p>
163+
164+
<h2>Software Architecture</h2>
165+
166+
<br>
167+
<br>
168+
169+
<h2>Software Design</h2>
170+
171+
<br>
172+
173+
<p>
174+
<a href="https://github.com/peter88213/novelibre/blob/main/docs/specifications_for_file_export.md" title="Template and placeholder specifications for file export" class="https">Template and placeholder specifications for file export</a>
175+
</p>
176+
177+
<br>
178+
179+
<h2>The .novx file format</h2>
180+
181+
<br>
182+
183+
<p>
184+
See the <a href="https://peter88213.github.io/novxlib-docs/the_novx_file_format.html" title="novx file format documentation" class="https">novx file format documentation</a> web site.
185+
</p>
186+
187+
188+
<br>
189+
<span class="backlinks">
190+
</span>
191+
192+
193+
</div>
194+
</div>
195+
</body>
196+
</html>
197+

0 commit comments

Comments
 (0)