neal
/
Typica
Watch 1
Star 0
Fork 0
Code Issues 15 Pull Requests 0 Releases 11 Activity
Browse Source

Started on Part 2 of the documentation.

Neal Wilson 10 years ago
parent
19745e5a24
commit
2cba2b953c
5 changed files with 95 additions and 17 deletions
Split View Show Diff Stats
  1. 1
    17
      docs/documentation.html
  2. 49
    0
      docs/documentation/part2.html
  3. 45
    0
      docs/documentation/part2/application.html
  4. BIN
      docs/documentation/part2/images/typica-icon-mac.png
  5. BIN
      docs/documentation/part2/images/typica-icon-windows.png

+ 1
- 17
docs/documentation.html View File 

@@ -66,23 +66,7 @@
66 66 
 						</ul>
67 67 
 						<li><a>Tips, Tricks, and Frequently Asked Questions</a></li>
68 68 
 					</ul>
69 
-					<li><a>Part 2: Comprehensive Feature Documentation</a></li>
70 
-					<ul>
71 
-						<li><a>Database Connection Settings</a></li>
72 
-						<li><a>Choosing Your Configuration</a></li>
73 
-						<li><a>The Main Navigation Window</a></li>
74 
-						<li><a>Configure Roasters</a></li>
75 
-						<li><a>Roast Coffee</a></li>
76 
-						<li><a>Purchase Green Coffee</a></li>
77 
-						<li><a>Manage Roasted Coffee Items</a></li>
78 
-						<li><a>Update Inventory</a></li>
79 
-						<li><a>Batch Log</a></li>
80 
-						<li><a>Cupping</a></li>
81 
-						<li><a>Import Target Roast Profiles</a></li>
82 
-						<li><a>Invoice List</a></li>
83 
-						<li><a>Enter Green Coffee Sales</a></li>
84 
-						<li><a>Reports</a></li>
85 
-					</ul>
69 
+					<li><a href="documentation/part2.html">Part 2: Comprehensive Feature Documentation</a></li>
86 70 
 					<li><a>Part 3: Interoperability Specifications</a></li>
87 71 
 					<ul>
88 72 
 						<li><a>File Format Documentation</a></li>

+ 49
- 0
docs/documentation/part2.html View File 

@@ -0,0 +1,49 @@
1 
+<html>
2 
+	<head>
3 
+		<title>Typica - Data for Coffee Roasters</title>
4 
+		<link rel="stylesheet" type="text/css" href="../style.css">
5 
+	</head>
6 
+	<body>
7 
+		<div id="page">
8 
+			<div id="topmatter">
9 
+				<div id="topbanner">
10 
+					<img src="../logo96.png" height="96px" width="96px" alt="Typica logo" />
11 
+					<h1>Typica</h1>
12 
+					<h2>Data for Coffee Roasters</h2>
13 
+				</div>
14 
+				<div id="menu">
15 
+					<a class="tab" href="../index.html">Project Home</a>
16 
+					<a class="tab" href="../downloads.html" >Downloads</a>
17 
+					<a class="tab active" href="../documentation.html" >Documentation</a>
18 
+					<a class="tab" href="../screenshots.html" >Screenshots and Videos</a>
19 
+					<a class="tab" href="../involvement.html" >Get Involved</a>
20 
+					<a href="http://appliedcoffeetechnology.tumblr.com/tagged/Typica" class="tab">Blog</a>
21 
+				</div>
22 
+			</div>
23 
+			<div id="maintext">
24 
+				<h1>Part 2: Comprehensive Feature Documentation</h1>
25 
+				<p>This part of the documentation describes the features of
26 
+				Typica.</p>
27 
+				<ul>
28 
+					<li><a href="part2/application.html">Opening the Application</a></li>
29 
+					<ul>
30 
+						<li>Database Connection Settings</a></li>
31 
+						<li>Open Configuration File</a></li>
32 
+						<li>Choose Your Path</a></li>
33 
+					</ul>
34 
+					<li><a>Configure Roasters</a></li>
35 
+					<li><a>Roast Coffee</a></li>
36 
+					<li><a>Purchase Green Coffee</a></li>
37 
+					<li><a>Manage Roasted Coffee Items</a></li>
38 
+					<li><a>Update Inventory</a></li>
39 
+					<li><a>Batch Log</a></li>
40 
+					<li><a>Cupping</a></li>
41 
+					<li><a>Import Target Roast Profiles</a></li>
42 
+					<li><a>Invoice List</a></li>
43 
+					<li><a>Enter Green Coffee Sales</a></li>
44 
+					<li><a>Reports</a></li>
45 
+				</ul>
46 
+			</div>
47 
+		</div>
48 
+	</body>
49 
+</html>

+ 45
- 0
docs/documentation/part2/application.html View File 

@@ -0,0 +1,45 @@
1 
+<html>
2 
+	<head>
3 
+		<title>Typica - Data for Coffee Roasters</title>
4 
+		<link rel="stylesheet" type="text/css" href="../../style.css">
5 
+	</head>
6 
+	<body>
7 
+		<div id="page">
8 
+			<div id="topmatter">
9 
+				<div id="topbanner">
10 
+					<img src="../../logo96.png" height="96px" width="96px" alt="Typica logo" />
11 
+					<h1>Typica</h1>
12 
+					<h2>Data for Coffee Roasters</h2>
13 
+				</div>
14 
+				<div id="menu">
15 
+					<a class="tab" href="../../index.html">Project Home</a>
16 
+					<a class="tab" href="../../downloads.html" >Downloads</a>
17 
+					<a class="tab active" href="../../documentation.html" >Documentation</a>
18 
+					<a class="tab" href="../../screenshots.html" >Screenshots and Videos</a>
19 
+					<a class="tab" href="../../involvement.html" >Get Involved</a>
20 
+					<a href="http://appliedcoffeetechnology.tumblr.com/tagged/Typica" class="tab">Blog</a>
21 
+				</div>
22 
+			</div>
23 
+			<div id="maintext">
24 
+				<h1>Opening the Application</h1>
25 
+				<p>The initial location of Typica depends on which platform you
26 
+are using.
27 
+				<h2>Microsoft Windows</h2>
28 
+				<p>On Microsoft Windows, you should find the files distributed with Typica in two folders. The executable is located in the "program" folder.</p>
29 
+				<img src="images/typica-icon-windows.png" />
30 
+				<p>Double click the file "Typica.exe" (the .exe extension may or may not appear depending on your system configuration) to start the program. Note that it does not matter where this file is located on your system, however it must be in the same folder with its .dll files. It is possible to create shortcuts in various places to simplify starting Typica.</p>
31 
+				<h2>Mac OS X</h2>
32 
+				<p>On Mac OS X the libraries used by Typica are hidden within the .app bundle so there is no separate "program" folder.</p>
33 
+				<img src="images/typica-icon-mac.png" />
34 
+				<p>Double click the file "Typica.app" (the .app extension may or may not appear depending on your system configuration) to start the program. Note that it does not matter where this file is located on your system. It is possible to create aliases in various places to simplify starting Typica.</p>
35 
+				<h1>What Happens Next?</h1>
36 
+				<p>When Typica starts, it will bring up one of three windows.<p>
37 
+				<ul>
38 
+					<li><a>Database Connection Settings</a></li>
39 
+					<li><a>Open Configuration File</a></li>
40 
+					<li><a>Choose Your Path</a></li>
41 
+				</ul>
42 
+			</div>
43 
+		</div>
44 
+	</body>
45 
+</html>

BIN
docs/documentation/part2/images/typica-icon-mac.png View File


BIN
docs/documentation/part2/images/typica-icon-windows.png View File


Write Preview
Loading…
Cancel
Save