-
Notifications
You must be signed in to change notification settings - Fork 0
/
docs.html
295 lines (270 loc) · 10.5 KB
/
docs.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
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="author" content="Nicholas Bernhard">
<meta name="description" content="A user manual for Lazius, a browser-based inventory management program">
<meta name="keywords" content="manual,documentation,lazius,inventory management,Nicholas Bernhard">
<meta http-equiv="X-UA-Compatible" content="ie=edge">
<link rel="stylesheet" type="text/css" href="assets/style/docsStyle.css" />
<link rel="icon" type="img/png" href="assets/images/lazius_favicon.png">
<title>LAZIUS DOCS</title>
</head>
<body>
<header>
<h1>LAZIUS</h1>
<h3>DOCUMENTATION</h3>
<h3><i>VER. 2 // IN-DEVELOPMENT</i></h3>
</header>
<main>
<figure id="librarianPainting">
<img src="./assets/images/lazius.jpg" />
<figcaption>
<b><i>The Librarian</i></b>, Giuseppe Arcimboldo, c. <time datetime="1566">1566</time>.
<br>
Likely a portrait of Hapsburg court historian <b><i>Wolfgang Lazius</i></b>.
</figcaption>
</figure>
<section id="tableOfContents">
<h1>TABLE OF CONTENTS</h1>
<ul>
<li><a href="#tableOfContents">TABLE OF CONTENTS</a></li>
<li><a href="#overviewSection">OVERVIEW</a></li>
<li><a href="#programLayout">PROGRAM LAYOUT</a></li>
<li><a href="">CREATING A DATABASE</a></li>
<li><a href="">EDITING DATABASE PARAMETERS</a></li>
<li><a href="">ADDING AN ENTRY</a></li>
<li><a href="">EDITING AN ENTRY</a></li>
<li><a href="">IMPORTING AND EXPORTING YOUR DATABASE</a></li>
<li><a href="#credits">CREDITS</a></li>
</ul>
</section>
<section id="overviewSection">
<h1>OVERVIEW</h1>
<p><strong>Lazius</strong> (<i>lot-zee-us</i>) is a
<strong><em>browser-based inventory management
program</em></strong> designed
for <strong><em>rapid data entry</em></strong>.
Adding items to the inventory does not require a mouse,
the <strong>Enter</strong> key moves to the next item.
This allows a large number of items to be entered
into the inventory very quickly, without the hassle of
clicking between different input fields in a form. Editing
entries and searching the inventory are also performed with
the keyboard.</p>
<p>Data is stored in the <strong>JSON</strong> format.
The data may be read and written from the browser's local storage
for fast access. If the user is running Lazius with a local server,
data may also be read and written from a .txt file.
The program does not rely on any
prior libraries or frameworks. Data may also be copied to the
clipboard and pasted to a text file.
</p>
</section>
<section id="programLayout">
<h1>PROGRAM LAYOUT</h1>
<p>The <strong>Lazius</strong> database uses a database object
with the following structure:</p>
<code>
{
<br>
"name":"DB Test",
<br>
"comments":"",
<br>
"contactInfo":"",
<br>
"dataStructureArray":[
<br>
{
<br>
"parameterName":"title",
<br>
"parameterToDisplay":"Title",
<br>
"parameterNotes":"",
<br>
"parameterInputType":"input",
<br>
"parameterAutoComplete":"no"},
<br>
{
<br>
"parameterName":"authorLastName",
<br>
"parameterToDisplay":"Author, Last Name",
<br>
"parameterNotes":"",
<br>
"parameterInputType":"input",
<br>
"parameterAutoComplete":"no"
<br>
},
<br>
{
<br>
"parameterName":"authorFirstName",
<br>
"parameterToDisplay":"Author, First Name",
<br>
"parameterNotes":"",
<br>
"parameterInputType":"input",
<br>
"parameterAutoComplete":"no"
<br>
},
<br>
{
<br>
"parameterName":"location",
<br>
"parameterToDisplay":"Location",
<br>
"parameterNotes":"",
<br>
"parameterInputType":"input",
<br>
"parameterAutoComplete":"yes"
<br>
},
<br>
{
<br>
"parameterName":"topics",
<br>
"parameterToDisplay":"Topic",
<br>
"parameterNotes":"",
<br>
"parameterInputType":"array",
<br>
"parameterAutoComplete":"no"
<br>
},
<br>
{
<br>
"parameterName":"quantity",
<br>
"parameterToDisplay":"Quantity",
<br>
"parameterNotes":"",
<br>
"parameterInputType":"number",
<br>
"parameterAutoComplete":"no"
<br>
},
<br>
{
<br>
"parameterName":"id",
<br>
"parameterToDisplay":"ID",
<br>
"parameterNotes":"",
<br>
"parameterInputType":"number",
<br>
"parameterAutoComplete":"no"
<br>
}],
<br>
"databaseArray":[
<br>
{
<br>
"title":"Armchair Universe",
<br>
"authorLastName":"Dewdney",
<br>
"authorFirstName":"A.K.",
<br>
"location":"Main Shelf",
<br>
"topics":["fractals","computer science","recreational mathematics","analog computers"],
<br>
"quantity":1,
<br>
"id":1
<br>
},
<br>
{
<br>
"title":"Kitty and the Midnight Hour",
<br>
"authorLastName":"Vaughn",
<br>
"authorFirstName":"Carrie",
<br>
"location":"Main Shelf",
<br>
"topics":["Horror","Romance Horror","Talk Radio","Werewolves","Vampires"],
<br>
"quantity":1,
<br>
"id":2
<br>
}],
<br>
"bufferArray":[],
<br>
"dateCreated":"2020-02-05T17:26:43.869Z"
<br>
}
</code>
<ul>
<li>The <b>Data Structure Array</b> contains all information on the database parameters:
their names, how those names are displayed to the user, and what kind of information the parameter
uses (either a string, number, or array)</li>
<li>The <b>Database Array</b> contains all the contents of the database.</li>
<li>The <b>Buffer Array</b> is used to store values before they are applied to the database.</li>
</ul>
<p>In the above example, we have a database with the name 'DB Test.' This database is set up to store
information about books. The Data Structure Array contains information on the
properties that each item in the database can have: a <b>title</b>, the author's <b>last name</b> and
<b>first name</b>, the <b>location of the book</b>, <b>topics</b> covered in the book, the
<b>quantity</b>
of that book, and an <b>ID</b>. All items in a Lazius database have an ID, which is generated by
auto-increment.
</p>
<p>Notice that each property can be either a <b>string</b> (a mixture of letters and numbers),
an <b>array</b> (a list of sub-properties), or a <b>number</b>.
</p>
<p>After the Data Structure Array, the Database Array contains two items: a book on computers and recreational mathematics
called <i>The Armchair Universe</i>, and the horror novel <i>Kitty and the Midnight Hour</i>, about the secret lives
of werewolves and vampires in Denver.
</p>
<p>This object is stored in the browser's local storage.
Local storage allocates at least 5 MB per domain, which is
plenty for small-scale databases.
</p>
</section>
<section id="commandsSection">
<h1>COMMANDS</h1>
<p>All inventory work for Lazius is done using the keyboard. If have prior experience with a DOS
environment, or using the command-line
in general, Lazius will feel familiar to you.
</p>
<p>In essence, if you want to do something in Lazius, you simply tell Lazius what to do by typing it into
the text box. For example, if you want
to add an item to the inventory, you would type '<kbd>add</kbd>', which will allow you to begin entering
item parameters.
</p>
</section>
<section id="creditsSection">
<h1 id="credits">CREDITS</h1>
<ul>
<li><strong>Developed by Nicholas Bernhard</strong></li>
<li>© 2020 Nicholas Bernhard</li>
</ul>
</section>
</main>
<footer>
</footer>
</body>
</html>