Browse Source

Remove obsolete web stuff

Neal Wilson 7 years ago
parent
commit
4313059962
100 changed files with 0 additions and 2931 deletions
  1. 0
    85
      docs/documentation.html
  2. 0
    31
      docs/documentation/appendix-a.1.html
  3. 0
    31
      docs/documentation/appendix-a.2.html
  4. 0
    28
      docs/documentation/appendix-a.3.html
  5. 0
    28
      docs/documentation/appendix-a.4.html
  6. 0
    32
      docs/documentation/appendix-a.5.html
  7. 0
    28
      docs/documentation/appendix-a.6.html
  8. 0
    372
      docs/documentation/dataentry.html
  9. 0
    62
      docs/documentation/faq.html
  10. 0
    310
      docs/documentation/firsttime.html
  11. BIN
      docs/documentation/images/adjustinventory.png
  12. BIN
      docs/documentation/images/coffeepurchase.png
  13. BIN
      docs/documentation/images/config1.png
  14. BIN
      docs/documentation/images/config2.png
  15. BIN
      docs/documentation/images/config3.png
  16. BIN
      docs/documentation/images/countconfig.png
  17. BIN
      docs/documentation/images/dbconnect.png
  18. BIN
      docs/documentation/images/explorer.png
  19. BIN
      docs/documentation/images/manageroasted.png
  20. BIN
      docs/documentation/images/modbusconfig.png
  21. BIN
      docs/documentation/images/nav.png
  22. BIN
      docs/documentation/images/navpurchase.png
  23. BIN
      docs/documentation/images/navroasted.png
  24. BIN
      docs/documentation/images/newbatchwindow.png
  25. BIN
      docs/documentation/images/properties.png
  26. BIN
      docs/documentation/images/rconfig1.png
  27. BIN
      docs/documentation/images/shortcut.png
  28. BIN
      docs/documentation/images/tc01config.png
  29. 0
    57
      docs/documentation/part1.html
  30. 0
    85
      docs/documentation/part2.html
  31. 0
    45
      docs/documentation/part2/application.html
  32. 0
    31
      docs/documentation/part2/argument-c.html
  33. 0
    47
      docs/documentation/part2/database-connection.html
  34. BIN
      docs/documentation/part2/images/database-settings.png
  35. BIN
      docs/documentation/part2/images/open-configuration.png
  36. BIN
      docs/documentation/part2/images/typica-icon-mac.png
  37. BIN
      docs/documentation/part2/images/typica-icon-windows.png
  38. 0
    40
      docs/documentation/part2/open-configuration.html
  39. 0
    154
      docs/documentation/platforms.html
  40. 0
    125
      docs/documentation/requiredsoftware.html
  41. 0
    79
      docs/documentation/windowreference/databaseconnection.html
  42. BIN
      docs/documentation/windowreference/databaseconnection.png
  43. BIN
      docs/documentation/windowreference/databasemenu.png
  44. BIN
      docs/documentation/windowreference/inventoryreports.png
  45. BIN
      docs/documentation/windowreference/inventorytransaction.png
  46. 0
    206
      docs/documentation/windowreference/logging.html
  47. BIN
      docs/documentation/windowreference/logging.png
  48. BIN
      docs/documentation/windowreference/loggingbatch.png
  49. BIN
      docs/documentation/windowreference/loggingfile.png
  50. BIN
      docs/documentation/windowreference/logginggraph.png
  51. BIN
      docs/documentation/windowreference/logginglog.png
  52. BIN
      docs/documentation/windowreference/losstransaction.png
  53. 0
    56
      docs/documentation/windowreference/manageroasted.html
  54. BIN
      docs/documentation/windowreference/manageroasted.png
  55. 0
    156
      docs/documentation/windowreference/navigation.html
  56. BIN
      docs/documentation/windowreference/navigation.png
  57. 0
    38
      docs/documentation/windowreference/openconfigurationfile.html
  58. BIN
      docs/documentation/windowreference/openconfigurationfile.png
  59. BIN
      docs/documentation/windowreference/productionreports.png
  60. BIN
      docs/documentation/windowreference/purchasereports.png
  61. BIN
      docs/documentation/windowreference/reportsmenu.png
  62. BIN
      docs/documentation/windowreference/salesreport.png
  63. 0
    43
      docs/documentation/windowreference/updateinventory.html
  64. 0
    18
      docs/logo.svg
  65. BIN
      docs/logo96.png
  66. 0
    92
      docs/style.css
  67. 0
    8
      web/build
  68. 0
    57
      web/output/download-mac-latest.html
  69. 0
    57
      web/output/download-windows-latest.html
  70. 0
    23
      web/output/downloads.html
  71. 0
    64
      web/output/index.html
  72. 0
    18
      web/output/logo.svg
  73. BIN
      web/output/logo96.png
  74. 0
    89
      web/output/media.html
  75. BIN
      web/output/photos/original/2012-11-09_11.00.22.jpg
  76. BIN
      web/output/photos/original/C-20121115-00003.jpg
  77. BIN
      web/output/photos/original/WP_20130303_003.jpg
  78. BIN
      web/output/photos/original/tumblr_mklwvnP9141qfwu90o1_1280.jpg
  79. BIN
      web/output/photos/resized/2012-11-09_11.00.22.jpg
  80. BIN
      web/output/photos/resized/C-20121115-00003.jpg
  81. BIN
      web/output/photos/resized/WP_20130303_003.jpg
  82. BIN
      web/output/photos/resized/tumblr_mklwvnP9141qfwu90o1_1280.jpg
  83. BIN
      web/output/release164tc.png
  84. 0
    110
      web/output/style.css
  85. 0
    5
      web/src/pages/download-mac-latest.m4
  86. 0
    5
      web/src/pages/download-windows-latest.m4
  87. 0
    14
      web/src/pages/downloads.m4
  88. 0
    46
      web/src/pages/fragments/downloadfragment.m4
  89. 0
    60
      web/src/pages/index.m4
  90. 0
    78
      web/src/pages/media.m4
  91. 0
    18
      web/src/resources/logo.svg
  92. BIN
      web/src/resources/logo96.png
  93. BIN
      web/src/resources/photos/original/2012-11-09_11.00.22.jpg
  94. BIN
      web/src/resources/photos/original/C-20121115-00003.jpg
  95. BIN
      web/src/resources/photos/original/WP_20130303_003.jpg
  96. BIN
      web/src/resources/photos/original/tumblr_mklwvnP9141qfwu90o1_1280.jpg
  97. BIN
      web/src/resources/photos/resized/2012-11-09_11.00.22.jpg
  98. BIN
      web/src/resources/photos/resized/C-20121115-00003.jpg
  99. BIN
      web/src/resources/photos/resized/WP_20130303_003.jpg
  100. 0
    0
      web/src/resources/photos/resized/tumblr_mklwvnP9141qfwu90o1_1280.jpg

+ 0
- 85
docs/documentation.html View File

@@ -1,85 +0,0 @@
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" >Documentation</a>
18
-					<a class="tab" href="screenshots.html" >Screenshots and Videos</a>
19
-					<a href="http://appliedcoffeetechnology.tumblr.com/tagged/Typica" class="tab">Blog</a>
20
-				</div>
21
-			</div>
22
-			<div id="maintext">
23
-				<p>Typica documentation is currently a work in progress. Once
24
-				finished it will be divided into three parts. Part 1
25
-				details what hardware can be used with Typica, how to set up
26
-				supporting software, and how to get started using Typica.
27
-				Everybody setting up Typica for the first time should read at
28
-				least the Supported Platforms and Hardware section
29
-				<em>before</em> buying hardware they intend to use with this
30
-				software. People who have used Typica previously may still want
31
-				to skim this section and read Configuring Typica for your
32
-				Hardware in detail. The Tips, Tricks, and Frequently Asked
33
-				Questions section may also be particularly useful.</p>
34
-				<p>Part 2 covers every feature of Typica in detail. This can be
35
-				read at your leisure and contains information that can help you
36
-				use Typica more effectively. If you have a question about how a
37
-				particular feature works, this is the place to look.</p>
38
-				<p>Part 3 is material that most people will never need to look
39
-				at. It provides all of the documentation you might want to have
40
-				if you intend to customize Typica to add new features or if you
41
-				intend to write another program that is interoperable with
42
-				Typica. The chapter documenting the database may also be useful
43
-				for those who want to obtain information that Typica does not
44
-				expose in exactly the way you'd like.</p>
45
-				<ul>
46
-					<li><a href="documentation/part1.html">Part 1: Basic Setup and Use</a></li>
47
-					<ul>
48
-						<li><a href="documentation/platforms.html">Supported Platforms and Hardware</a></li>
49
-						<li><a href="documentation/requiredsoftware.html">Required Software</a></li>
50
-						<li><a>Initial Setup</a></li>
51
-						<ul>
52
-							<li><a href="documentation/firsttime.html">Running Typica for the First Time</a></li>
53
-							<ul>
54
-								<li><a href="documentation/firsttime.html#database">Database Connection</a></li>
55
-								<li><a href="documentation/firsttime.html#configfile">Open Configuration File</a></li>
56
-								<li><a href="documentation/firsttime.html#hardware">Configuring Typica for your Hardware</a></li>
57
-							</ul>
58
-							<li><a href="documentation/dataentry.html">Initial Data Entry</a></li>
59
-							<ul>
60
-								<li><a href="documentation/dataentry.html#green">Green Coffee Purchases</a></li>
61
-								<li><a href="documentation/dataentry.html#roasted">Roasted Coffee Items</a></li>
62
-								<li><a href="documentation/dataentry.html#inventory">An Initial Inventory</a></li>
63
-								<li><a href="documentation/dataentry.html#profiles">Saving and Using Target Roast Profiles</a></li>
64
-							</ul>
65
-						</ul>
66
-						<li><a href="documentation/faq.html">Tips, Tricks, and Frequently Asked Questions</a></li>
67
-					</ul>
68
-					<li><a href="documentation/part2.html">Part 2: Comprehensive Feature Documentation</a></li>
69
-					<li><a>Part 3: Interoperability Specifications</a></li>
70
-					<ul>
71
-						<li><a>File Format Documentation</a></li>
72
-						<li><a>Database Documentation</a></li>
73
-						<li><a>Configuration XML Documentation</a></li>
74
-						<li><a>Configuration Script Documentation</a></li>
75
-					</ul>
76
-				</ul>
77
-				<p>Until the relevant portions of the current documentation are
78
-				finished, some may wish to consult the documentation for earlier
79
-				versions of Typica. This includes the
80
-				<a href="userguide.html">old user guide</a> and
81
-				the <a href="windows.html">old Windows installation instructions</a>.
82
-			</div>
83
-		</div>
84
-	</body>
85
-</html>

+ 0
- 31
docs/documentation/appendix-a.1.html View File

@@ -1,31 +0,0 @@
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" >Documentation</a>
18
-					<a class="tab" href="screenshots.html" >Screenshots and Videos</a>
19
-					<a href="http://appliedcoffeetechnology.tumblr.com/tagged/Typica" class="tab">Blog</a>
20
-				</div>
21
-			</div>
22
-			<div id="maintext">
23
-				<h1>Appendix A.1: Hardware Compatibility Notes - National Instruments NI USB-9211</h1>
24
-				<p>NI USB-9211 is the model name for a National Instruments NI 9211 module paired with an NI USB-9161 USB Carrier. National Instruments has many combinations of the NI 9211 module with other devices featuring very similar model names and different software compatability. Please check carefully.</p>
25
-				<p>This hardware is known to work with Microsoft Windows. Typica requires that NI-DAQmx Base 2.2 is installed to use this hardware on Microsoft Windows.</p>
26
-				<p>This hardware is known to work with Mac OS X. Typica requires that NI-DAQmx Base 2.1 is installed to use this hardware on Mac OS X.</p>
27
-				<p>National Instruments claims that this hardware will work with Linux, however it may be difficult to make this work with most Linux distributions. There are minor differences in the way NI-DAQmx Base is loaded in Typica on Windows and Mac OS X and Typica may require minor modification to use this hardware on Linux. Confirmation that this works or a patch to make this work would be appreciated.</p>
28
-			</div>
29
-		</div>
30
-	</body>
31
-</html>

+ 0
- 31
docs/documentation/appendix-a.2.html View File

@@ -1,31 +0,0 @@
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" >Documentation</a>
18
-					<a class="tab" href="screenshots.html" >Screenshots and Videos</a>
19
-					<a href="http://appliedcoffeetechnology.tumblr.com/tagged/Typica" class="tab">Blog</a>
20
-				</div>
21
-			</div>
22
-			<div id="maintext">
23
-				<h1>Appendix A.2: Hardware Compatibility Notes - National Instruments NI USB-9211A</h1>
24
-				<p>NI USB-9211 is the model name for a National Instruments NI 9211 module paired with an NI USB-9162 Hi-Speed USB Carrier. National Instruments has many combinations of the NI 9211 module with other devices featuring very similar model names and different software compatability. Please check carefully.</p>
25
-				<p>This hardware is known to work with Microsoft Windows. Typica can use <em>either</em> NI-DAQmx Base 3.6 <em>or</em> NI DAQmx 9.6.1 to communicate with this hardware on Microsoft Windows. <em>Please have only one of these installed. Installing both will result in failures.</em></p>
26
-				<p>This hardware is known to work with Mac OS X. Typica requires that NI-DAQmx Base 3.6 is installed to use this hardware on Mac OS X.</p>
27
-				<p>National Instruments claims that this hardware will work with Linux, however it may be difficult to make this work with most Linux distributions. There are minor differences in the way NI-DAQmx Base is loaded in Typica on Windows and Mac OS X and Typica may require minor modification to use this hardware on Linux. Confirmation that this works or a patch to make this work would be appreciated.</p>
28
-			</div>
29
-		</div>
30
-	</body>
31
-</html>

+ 0
- 28
docs/documentation/appendix-a.3.html View File

@@ -1,28 +0,0 @@
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" >Documentation</a>
18
-					<a class="tab" href="screenshots.html" >Screenshots and Videos</a>
19
-					<a href="http://appliedcoffeetechnology.tumblr.com/tagged/Typica" class="tab">Blog</a>
20
-				</div>
21
-			</div>
22
-			<div id="maintext">
23
-				<h1>Appendix A.3: Hardware Compatibility Notes - National Instruments NI 9211 paired with NI cDAQ-9171</h1>
24
-				<p>This combination of hardware is only known to work on Microsoft Windows and requires that NI DAQmx is installed. I do not have access to this hardware for testing purposes, but do have several reports that it works.</p>
25
-			</div>
26
-		</div>
27
-	</body>
28
-</html>

+ 0
- 28
docs/documentation/appendix-a.4.html View File

@@ -1,28 +0,0 @@
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" >Documentation</a>
18
-					<a class="tab" href="screenshots.html" >Screenshots and Videos</a>
19
-					<a href="http://appliedcoffeetechnology.tumblr.com/tagged/Typica" class="tab">Blog</a>
20
-				</div>
21
-			</div>
22
-			<div id="maintext">
23
-				<h1>Appendix A.4: Hardware Compatibility Notes - National Instruments NI USB-TC01</h1>
24
-				<p>This hardware only works on Microsoft Windows and requires that NI DAQmx is installed. While I have not personally experienced problems with this hardware, most of the reported issues that were ultimately determined to be due to faulty hardware or poor installation have involved this device.</p>
25
-			</div>
26
-		</div>
27
-	</body>
28
-</html>

+ 0
- 32
docs/documentation/appendix-a.5.html View File

@@ -1,32 +0,0 @@
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" >Documentation</a>
18
-					<a class="tab" href="screenshots.html" >Screenshots and Videos</a>
19
-					<a href="http://appliedcoffeetechnology.tumblr.com/tagged/Typica" class="tab">Blog</a>
20
-				</div>
21
-			</div>
22
-			<div id="maintext">
23
-				<h1>Appendix A.5: Hardware Compatibility Notes - DATAQ DI-145</h1>
24
-				<p>At present this hardware is only supported on Microsoft Windows and requires that the DATAQ SDK is installed. It will likely be supported on other platforms in the future, but purchasing hardware based on possible future compatibility is not recommended. Note that this device does not take thermocouple inputs directly and additional hardware may be required to effectively utilize this hardware. While measurements from this device can be mapped to temperature data, there are several characteristics of this device which make it the least desirable of the supported options for that sort of data. This device is better suited to logging control data of limited range and precision.</p>
25
-				
26
-				<p>Some Diedrich roasters have included hardware appropriate for connecting to this device. An example is shown in the following video.</p>
27
-				
28
-				<iframe width="640" height="360" src="https://www.youtube.com/embed/ZH7Dh5mM8LE" frameborder="0" allowfullscreen></iframe>
29
-			</div>
30
-		</div>
31
-	</body>
32
-</html>

+ 0
- 28
docs/documentation/appendix-a.6.html View File

@@ -1,28 +0,0 @@
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" >Documentation</a>
18
-					<a class="tab" href="screenshots.html" >Screenshots and Videos</a>
19
-					<a href="http://appliedcoffeetechnology.tumblr.com/tagged/Typica" class="tab">Blog</a>
20
-				</div>
21
-			</div>
22
-			<div id="maintext">
23
-				<h1>Appendix A.6: Hardware Compatibility Notes - Modbus RTU Devices</h1>
24
-				<p>While Modbus RTU devices are supported on all platforms, these are usually connected through an RS-485 to USB adapter. Please verify driver support for your adapter with platforms you intend to use. There are also several limitations in Typica's support of Modbus RTU devices. While these limitations are likely to be removed soon with a future version of Typica, at present only one device is supported per bus and only one process value and up to one set value per device is available. This is sufficient for basic logging of temperature data and allows limited control in some roasting system designs, but more complex configurations or devices dealing with non-temperature data monitoring and control are not yet supported.</p>
25
-			</div>
26
-		</div>
27
-	</body>
28
-</html>

+ 0
- 372
docs/documentation/dataentry.html View File

@@ -1,372 +0,0 @@
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
-				<ul>
25
-					<li><a href="#green">Green Coffee Purchases</a></li>
26
-					<li><a href="#roasted">Roasted Coffee Items</a></li>
27
-					<li><a href="#inventory">An Initial Inventory</a></li>
28
-					<li><a href="#profiles">Saving and Using Target Roast Profiles</a></li>
29
-				</ul>
30
-			
31
-				<h1>Initial Data Entry</h1>
32
-				
33
-				<p>Much of the benefit of using Typica comes from its ability
34
-				to track coffee inventories and roast profiles. When using the
35
-				software regularly, data entry is a quick and easy part of the
36
-				relevant workflows, but when setting up the software initially
37
-				there may be a large amount of data to enter.</p>
38
-				
39
-				<p>When requesting information from Typica, the quality of the
40
-				information presented can only be as good as the quality of the
41
-				data it is given to work with. It is generally recommended to
42
-				start with only as much data entry as is needed for Typica to
43
-				present the current state of inventory and to simply be aware
44
-				of the limitations in obtaining historical information. It may
45
-				be tempting to enter older records, but the benefits of doing
46
-				that rarely outweigh the cost of time to enter these older
47
-				records accurately.<p>
48
-				
49
-				<p>Before entering this data into Typica, you should take an
50
-				inventory of your current green coffee supply, locate the
51
-				invoices for coffees you currently have in inventory, and have
52
-				a list of the roasted coffee items that you produce.</p>
53
-				
54
-				<a name="green" />
55
-				<h2>Green Coffee Purchases</h2>
56
-				
57
-				<img src="images/navpurchase.png" />
58
-				
59
-				<p>As you purchase coffee, data will need to be entered in
60
-				Typica to track green coffee inventory. This is done by
61
-				pressing the Purchase Green Coffee button.</p>
62
-				
63
-				<img src="images/coffeepurchase.png" />
64
-				
65
-				<p>At the top of this window you will find information that
66
-				applies to every item on an invoice. Take an invoice that
67
-				contains coffee presently in inventory and enter the invoice
68
-				date in the Date field, the company that sold you the coffee in
69
-				the Vendor field, and the invoice number in the Invoice field.
70
-				Typica only requires the Date field, but having the other
71
-				information may make it easier to find records if they are
72
-				needed later such as for certification reporting.</p>
73
-				
74
-				<p>This top area also has a Add Item button. This window starts
75
-				with a set of fields for entering the details of one coffee
76
-				item. To enter details on more coffees, click the Add Item
77
-				button until there are enough spaces to enter the details of
78
-				all of the coffees on the invoice you are entering.</p>
79
-				
80
-				<p>Next there is an area where information about the coffee is
81
-				entered. There are several fields to note.</p>
82
-				
83
-				<h3>Item</h3>
84
-				<p>This is the name of the green coffee. When you adjust the
85
-				inventory of this coffee or specify its use in roasting, this
86
-				is the text that will appear to identify the coffee.
87
-				<strong>This field is required.</strong></p>
88
-				
89
-				<h3>Reference</h3>
90
-				<p>This is intended to be the ICO number of the coffee or, in
91
-				the case of coffees that do not have that, some other set of
92
-				markings that uniquely identifies the coffee.</p>
93
-				
94
-				<h3>Quantity</h3>
95
-				<p>This is the amount of coffee purchased. It can be in either
96
-				pounds or kilograms. <strong>This field is
97
-				required.</strong></p>
98
-				
99
-				<h3>Unit</h3>
100
-				<p>This field allows you to select if the quantity is expressed
101
-				in pounds or kilograms. Which is selected has no influence on
102
-				how that data can be retrieved later, but it is important that
103
-				the quantity is correct in terms of the unit specified. It is
104
-				easiest to use whatever unit is used on your invoice.</p>
105
-				
106
-				<h3>Cost</h3>
107
-				<p>The cost of the green coffee can be entered in terms of the
108
-				cost per unit or the total cost of the coffee purchased. Which
109
-				is specified in the box next to the cost field. <strong>This
110
-				field is required.</strong></p>
111
-				
112
-				<h3>Origin</h3>
113
-				<p>This field is used by some reports to aggregate information
114
-				based on where the coffee comes from. This is generally the
115
-				name of the country that the coffee was grown in, but you may
116
-				find it useful in some cases to deviate from this. For example,
117
-				some find it useful in the case of coffees from Indonesia to
118
-				specify the name of the island the coffee was grown on rather
119
-				than the country. Whichever you decide, you should enter
120
-				purchase information consistently over time. <strong>This field
121
-				is required.</strong></p>
122
-				
123
-				<h3>Region</h3>
124
-				<p>This field can specify a distinct producing region.</p>
125
-				
126
-				<h3>Producer</h3>
127
-				<p>This field can specify the producer of the coffee.</p>
128
-				
129
-				<h3>Grade</h3>
130
-				<p>This field can specify the grade of the green coffee.</p>
131
-				
132
-				<h3>Milling</h3>
133
-				<p>This field can specify how the coffee was milled.</p>
134
-				
135
-				<h3>Drying</h3>
136
-				<p>This field can specify how the coffee was dried.</p>
137
-				
138
-				<h3>Bags</h3>
139
-				<p>This field specifies the number of bags the green coffee
140
-				comes in. In some facilities you may empty bags of coffee as
141
-				they are roasted. If this is the case, the inventory of that
142
-				coffee can be adjusted to correct the current inventory for
143
-				measurement errors. <strong>This field is
144
-				required.</strong></p>
145
-				
146
-				<h3>Decaffeinated</h3>
147
-				<p>If the coffee is decaffeinated, this check box should be
148
-				checked. <strong>The decaffeination method is a required field
149
-				if the check box is checked.</strong></p>
150
-				
151
-				<h3>Certifications</h3>
152
-				<p>If there are any certifications on the coffee that should be
153
-				tracked, enter these one at a time in the field to the right of
154
-				the Add Certification button. After typing the name of one
155
-				certification, press the button. This will add that
156
-				certification to a list to the left of the button.</p>
157
-				
158
-				<h3>Fees</h3>
159
-				<p>This section describes any fees that apply to the invoice.
160
-				If you have warehousing, palletizing, shipping, or other fees
161
-				associated with this invoice, you can enter the fee description
162
-				and amount in this area. Additional lines in this table will be
163
-				created as you enter data in this area.</p>
164
-				
165
-				<p>Review the information that you've entered, ensuring that it
166
-				is accurate and that all required fields have been filled. Once
167
-				this is done, click the Submit button to save this information
168
-				to the database.</p>
169
-				
170
-				<p>Repeat the steps in this section until you have entered all
171
-				of the invoices required for your current inventory. These same
172
-				steps should be followed as more green coffee is purchased in
173
-				the future.</p>
174
-				
175
-				<a name="roasted" />
176
-				<h2>Roasted Coffee Items</h2>
177
-				
178
-				<img src="images/navroasted.png" />
179
-				
180
-				<p>The coffee roasting process transforms a quantity of one or
181
-				more green coffees into a quantity of a roasted coffee. Roasted
182
-				coffee items are associated with target roast profiles and
183
-				these also maintain an association with the most recent set of
184
-				green coffees used to produce that roasted coffee. Roasted
185
-				coffee items are managed by clicking the Manage Roasted Coffee
186
-				Items button.</p>
187
-				
188
-				<img src="images/manageroasted.png" />
189
-				
190
-				<p>When entering an initial set of roasted coffee items, only
191
-				the top part of this window is needed. Enter the name of the
192
-				roasted coffee item in the New Roasted Coffee field and then
193
-				click the Add New Coffee button. Note that if you produce
194
-				items with different roast profiles, these should be different
195
-				roasted coffee items even if they are produced from the same
196
-				green coffee. Items that are produced through additional
197
-				processing after roasting such as flavored coffees or blends
198
-				that are assembled from multiple roasted coffees need not be
199
-				entered, but the component roasted coffees should be
200
-				entered. As you enter these roasted coffee items they will be
201
-				added to a list under Current Items.</p>
202
-				
203
-				<p>As you roast coffees, you may find that you no longer
204
-				produce a particular roasted coffee. It is generally a good
205
-				idea to remove this item from the current set of roasted coffee
206
-				items so that you cannot accidentally specify that you are
207
-				producing something that you do not presently roast. To do
208
-				this, select the item from the Current Items list and then
209
-				click the Remove Item button. The item will no longer appear
210
-				as an option when entering the details of a batch to roast and
211
-				it will be moved to the Discontinued Items list.</p>
212
-				
213
-				<p>If you later resume the production of a previously
214
-				discontinued roasted coffee item, you can restore the existing
215
-				item rather than create a new one. To do this, select the item
216
-				from the Discontinued Items list and click the Restore Item
217
-				button. This will remove the item from the Discontinued Items
218
-				list and add it to the Current Items list. This will make that
219
-				roasted coffee available to select when roasting coffee.</p>
220
-				
221
-				<p>When you are finished altering the set of roasted coffee
222
-				items, close the window.</p>
223
-				
224
-				<a name="inventory" />
225
-				<h2>An Initial Inventory</h2>
226
-				
227
-				<img src="images/adjustinventory.png" />
228
-				
229
-				<p>You may periodically wish to take an inventory of your green
230
-				coffee supply and update the information in Typica to reflect
231
-				reality. This should at least be done after using the last of a
232
-				green coffee to set the inventory to 0, but if it is possible,
233
-				this can be done after emptying any bag of coffee.</p>
234
-				
235
-				<p>Click the Update Inventory button to bring up the window
236
-				seen above. At the top you will see a list of green coffees
237
-				with an inventory that is not 0. Selecting an item will change
238
-				the text area at the bottom to indicate the name of the green
239
-				coffee item and the current inventory in both pounds and bags
240
-				of coffee.</p>
241
-				
242
-				<p>To adjust the inventory of the currently selected item,
243
-				enter either the number of bags or the number of pounds of
244
-				coffee remaining in inventory, select either bag or lb from the
245
-				box next to this field, and click the Update button. The text
246
-				area at the bottom will change to reflect the change you have
247
-				just made in the inventory.</p>
248
-				
249
-				<p><strong>Note that inventory adjustments take effect
250
-				immediately. Ensure that data on any roasting batches has been
251
-				sent to the database before making inventory adjustments on
252
-				these coffees.</strong></p>
253
-				
254
-				<a name="profiles" />
255
-				<h2>Saving and Using Target Roast Profiles</h2>
256
-				
257
-				<p>Each roasted coffee keeps track of the most recent target
258
-				roast profile if one has been specified for this item. For the
259
-				initial data entry you will not have any target roast profiles
260
-				as these have not yet been entered. The easiest way to enter a
261
-				target roast profile is to roast a batch of coffee to that
262
-				profile and let Typica record that data for you.</p>
263
-				
264
-				<p>For this step you must have already configured Typica for
265
-				your roasting equipment. If you have not done this, please do
266
-				so now.</p>
267
-				
268
-				<p>Select the coffee roaster you will be using and click the
269
-				Roast Coffee button. This will bring up a window showing the
270
-				temperature measurement channels that you have set up for that
271
-				roaster, a timer indicating the duration of the current roast,
272
-				buttons for marking the start and end of the batch, a table
273
-				capable of showing both the target roast profile and your
274
-				current batch data at various levels of detail, and a graph
275
-				that can show the same measurement data. Other things may
276
-				appear as well depending on how you have configured Typica for
277
-				this machine.</p>
278
-				
279
-				<img src="images/newbatchwindow.png" />
280
-				
281
-				<p>From the Batch menu, select New Batch. This will bring up a
282
-				window where you can enter the details for a batch of roasted
283
-				coffee. At the top you will see the name of the coffee roaster
284
-				you are using and you can select the unit that will be applied
285
-				to all weight measurements. You can select grams, kilograms,
286
-				ounces, or pounds.</p>
287
-				
288
-				<p>Next you can select the roasted coffee you will be
289
-				producing. This is the list of current roasted coffee items
290
-				that you created previously. <strong>This field is
291
-				required.</strong></p>
292
-				
293
-				<p>If you have roasted this coffee previously and the green
294
-				coffees that were used are all still available to roast, the
295
-				coffees will automatically be selected in the Green Coffee
296
-				section. The first time a coffee is roasted, that information
297
-				is not available to Typica so you will need to select that
298
-				information manually. Cells in the first column of this table
299
-				will bring up a list showing the currently available green
300
-				coffees. The weight should be entered in the uit specified at
301
-				the top of the window. As you enter information, additional
302
-				rows will be added to accomodate coffees that are blended prior
303
-				to roasting. <strong>Both the green coffee used and the weight
304
-				of each green coffee are required fields.</strong></p>
305
-				
306
-				<p>When you have finished entering information on the green
307
-				coffee, the Green Weight field will be calculated
308
-				automatically. <strong>This field must not be 0 when the
309
-				batch is submitted to the database. Roasting a batch of no
310
-				coffee makes no sense and entering nonsense will adversely
311
-				affect the quality of data you can get out of
312
-				Typica.</strong></p>
313
-				
314
-				<p>If you had a previously saved target roast profile for the
315
-				selected roasted coffee item the Load Profile button will be
316
-				available. If a target roast profile is not available, if you
317
-				would prefer to roast without a target roast profile, or if you
318
-				would prefer to obtain target roast profile data from a
319
-				different source, you will want to click the No Profile button.
320
-				This brings the previous window up and associates the roasting
321
-				data with the batch you have just entered details for. You can
322
-				enter the details of as many batches as you like before
323
-				roasting, but you must press either the Load Profile or No
324
-				Profile button in the window with information about the batch
325
-				you will roast prior to starting each batch.</p>
326
-				
327
-				<p>If you have information from a previous roast displayed,
328
-				start by selecting Clear Log from the Log menu. Once you are
329
-				ready, click the Start Batch button while simultaneously
330
-				starting the roasting process. Typica will record the details
331
-				of your batch. When you have finished roasting the coffee,
332
-				click the Stop Batch button while simultaneously halting the
333
-				roasting process.</p>
334
-				
335
-				<p>When you click the Stop Batch button, the New Batch window
336
-				will return. You should see that it has entered information in
337
-				the Time and Duration fields for you.</p>
338
-				
339
-				<p>You may select New Batch from the Batch menu if you would
340
-				like to start roasting another batch of coffee immediately.
341
-				Once the batch is cooled, weigh the coffee and enter the
342
-				roasted weight. A percent weight loss will automatically be
343
-				calculated.</p>
344
-				
345
-				<p>Assuming you have roasted this coffee to your desired roast
346
-				profile, click the check box next to Approved and the check box
347
-				next to Save log as target profile. The former box should be
348
-				checked for every batch that was roasted correctly, but once a
349
-				target roast profile has been saved, there is no need to check
350
-				the latter on subsequent batches unless there is a desire to
351
-				alter the target roast profile.</p>
352
-				
353
-				<p>If you would like to make a note of any information not in
354
-				the recorded roasting data or elsewhere in the New Batch
355
-				window, that information can be entered in the Annotation
356
-				field.</p>
357
-				
358
-				<p>Review the content of the window and ensure that all of the
359
-				data has been entered appropriately before clicking the Submit
360
-				button.</p>
361
-				
362
-				<p>Congratulations! You have just saved a target roast profile
363
-				for a roasted coffee item. The next time you roast that coffee
364
-				you will be able to see the data from this batch next to the
365
-				data from the current batch. Repeat this process for all of
366
-				your roasted coffee items to conclude this initial data
367
-				entry.</p>
368
-				
369
-			</div>
370
-		</div>
371
-	</body>
372
-</html>

+ 0
- 62
docs/documentation/faq.html View File

@@ -1,62 +0,0 @@
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" >Documentation</a>
18
-                    <a class="tab" href="screenshots.html" >Screenshots and Videos</a>
19
-                    <a href="http://appliedcoffeetechnology.tumblr.com/tagged/Typica" class="tab">Blog</a>
20
-                </div>
21
-            </div>
22
-            <div id="maintext">
23
-                <h1>Tips, Tricks, and Frequently Asked Questions</h1>
24
-
25
-                <h2>What hardware does Typica work with?</h2>
26
-                <p>See the <a href="http://www.randomfield.com/programs/typica/documentation/platforms.html#compatability">Hardware Compatability Table</a> to learn what hardware will work with Typica on which operating systems. If your device is not listed, Typica is not known to work with it. If you'd like to add support for additional hardware, patches are welcome. For new installations, the Phidgets 1048 is generally recommended.</p>
27
-                
28
-                <h2>Does Typica work with my coffee roaster?</h2>
29
-                <p>Almost certainly. If your roaster already has one or more thermocouples installed, it is possible to jump off of that to one of the supported pieces of data acquisition hardware. If you have an RTD, you might need to replace whatever that is connected to with something that can speak Modbus RTU. Home roasting machines are generally more difficult to connect and may require significant modification.</p>
30
-                <p>The below video demonstrates connecting a roaster to a computer using a Diedrich SR-1 and a National Instruments NI USB 9211, but the process is very similar with most other commercial coffee roasters and other data acquisition hardware that takes thermocouple inputs.</p>
31
-                <iframe width="640" height="360" src="https://www.youtube.com/embed/EXPjLgCoUWU" frameborder="0" allowfullscreen></iframe>
32
-                
33
-                <h2>Can multiple instances of Typica connect to the same database?</h2>
34
-                <p>Yes. You'll need to configure PostgreSQL to allow network connections (it does not by default) and if you're using multiple coffee roasters you'll want to make sure these are configured with different IDs in the database. If you are using a software based firewall on the computer running PostgreSQL you will also need to make sure incoming connections are allowed.</p>
35
-                
36
-                <h2>When configuring rate of change calculations, what is the difference between scale time and cache time?</h2>
37
-                <p>A rate of change is logically a fraction where the numerator is how much the value has changed and the denominator is the amount of time that change takes place over. Scale time is the number of seconds used for the denominator of this fraction. If you are already used to thinking about rate of change over a certain amount of time, you can continue to use that. Otherwise, matching what you normally have the table view set to show is recommended. By default, that would be 30 seconds.</p>
38
-                <p>Measurement hardware is not perfect and presents data that is slightly noisy and of limited precision. Rate of change calculations can amplify that noise and make it difficult to use that information during the roast. Typica provides a way to smooth out that noise by presenting the slope of a linear regression of measurements taken in a given amount of time. Cache time is the number of seconds used for this. A smaller value will allow the rate to change more quickly while a larger value will be more resistant to noise. 10 seconds is a good starting point for this setting.</p>
39
-                <p>A good overview of using rate of change calculations in Typica is presented in the following video. The start of the video is an overview of why this is useful. Starting at 2:55 is a demonstration of how this looks in Typica. At 10:07 there's a walkthrough of all of the configuration details for this feature.</p>
40
-                
41
-                <iframe width="640" height="360" src="https://www.youtube.com/embed/km4GuMIxW70" frameborder="0" allowfullscreen></iframe>
42
-                
43
-                <h2>How can I support further development of Typica?</h2>
44
-                <p>Checks payable to Neal Wilson can be sent to</p>
45
-                <p>Neal Wilson<br />
46
-                C/O Wilson's Coffee &amp; Tea<br />
47
-                3306 Washington Ave.<br />
48
-                Racine, WI 53405<br />
49
-                USA</p>
50
-                <p>If you would prefer to use a credit card, it is possible to do this with the blue "$ Support" button on the right side of <a href="https://www.youtube.com/user/N3Roaster">the N3Roaster YouTube channel</a>.</p>
51
-                <p>It is also possible to <a href="mailto:roaster@wilsonscoffee.com">hire me for training at your company</a>.</p>
52
-                
53
-                <h2>Why can't I see the batch timer?</h2>
54
-                <p>There are splitter handles between all of the indicators at the top of the logging window. If you move your cursor to the right of the rightmost visible indicator and click and drag to the left, that should become visible again. Several other elements of this window also have splitter handles that you can use to customize the size of different information displays.</p>
55
-                
56
-                <h2>Can databases other than PostgreSQL be used with Typica?</h2>
57
-                <p>Not currently. I'd like to add SQLite3 support in Typica 2.0 which would make it easier to support additional database managers.</p>
58
-
59
-            </div>
60
-        </div>
61
-    </body>
62
-</html>

+ 0
- 310
docs/documentation/firsttime.html View File

@@ -1,310 +0,0 @@
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
-				<ul>
25
-					<li><a href="#database">Database Connection</a></li>
26
-					<li><a href="#configfile">Open Configuration File</a></li>
27
-					<li><a href="#hardware">Configuring Typica for your Hardware</a></li>
28
-				</ul>
29
-			
30
-				<h1>Running Typica for the First Time</h1>
31
-				
32
-				<p>After downloading Typica and extracting the contents of the .zip (Microsoft Windows) or
33
-				copying the contents of the .dmg (Mac OS X) to a more convenient location, you should have
34
-				a folder that contains three other folders. The <tt>source</tt> folder contains all of
35
-				the source code for Typica which you may use if you want to modify the software. This
36
-				folder also contains a file called <tt>typica.pdf</tt> which has complete documentation
37
-				of how Typica works (not how to use Typica). You do not need to read that to use Typica,
38
-				but you may still find it interesting. The contents of this folder are not required to
39
-				run Typica and may be deleted if you have no use for it. The <tt>configuration</tt> folder
40
-				contains an example configuration for Typica to use. These files can be modified to perform
41
-				extensive customization of Typica or to add or remove reports if you want to change how
42
-				Typica works, however most do not have a need to modify any of these files. Typica requires
43
-				that the contents of this directory exist for proper operation. The <tt>program</tt> folder
44
-				contains the Typica executable and its library dependencies. On Mac OS X this is instead
45
-				all collected in an .app bundle.</p>
46
-				
47
-				<p>Find either Typica.exe (Microsoft Windows) or Typica.app (Mac OS X) and double click
48
-				to open the program.</p>
49
-				
50
-				<img src="images/explorer.png" />
51
-				
52
-				<a name="database" />
53
-				<h2>Database Connection</h2>
54
-				
55
-				<img src="images/dbconnect.png" />
56
-				
57
-				<p>The first time you start Typica, you will be asked for the information needed to
58
-				connect to a database. If you have not installed PostgreSQL, you can click Cancel to
59
-				continue without connecting to a database. Note that doing so will result in Typica
60
-				having a very limited feature set. If you have installed PostgreSQL on the same
61
-				computer as Typica, the host name should be set to <tt>localhost</tt>. If PostgreSQL
62
-				is running on a different computer you will need to specify the IP address of that
63
-				computer.</p>
64
-				
65
-				<p>If you have set up a database for Typica to use, the name of that database
66
-				should be set as the database name, otherwise the PostgreSQL installer creates a
67
-				database named <tt>postgres</tt> which you can use.</p>
68
-				
69
-				<p>Similarly, if you have created a new database
70
-				user role for Typica, the user name and password that you chose for this should be
71
-				entered as the user name and password here. Otherwise, the PostgreSQL installer creates
72
-				a user named <tt>postgres</tt> with the password that you chose during the installation
73
-				process.</p>
74
-				
75
-				<p>Once all of this has been entered, click Connect.</p>
76
-				
77
-				<p>You only need to enter this information the first time you start Typica. It will
78
-				not prompt for this information in the future unless Typica fails to connect to the
79
-				database or unless you select a menu item that instructs Typica to forget the
80
-				connection settings.</p>
81
-				
82
-				<h3>Troubleshooting: What if it Doesn't Work?</h3>
83
-				
84
-				<p>The problem is <em>not</em> with Typica. If you are running PostgreSQL on the same
85
-				computer as you are running Typica, you have most likely typed something incorrectly.
86
-				You can use the SQL Shell (psql) to verify that your login information is correct. If
87
-				you can connect on port 5432, the same information used to connect with psql will also
88
-				be usable with Typica. Another possibility is that PostgreSQL is not currently running.
89
-				If you are running PostgreSQL on a different computer, make sure that the other computer
90
-				is turned on, that PostgreSQL is running, and that it is configured to accept connections
91
-				from the network.</p>
92
-				
93
-				<a name="configfile" />
94
-				<h2>Open Configuration File</h2>
95
-				
96
-				<p>Every time you open Typica, you will be asked to open a configuration file. Typica
97
-				comes with one example configuration file that meets most needs, however you can
98
-				create your own if you have special requirements. This documentation assumes that you
99
-				are using the provided example configuration.</p>
100
-				
101
-				<p>The first time you start Typica or when using a new version of Typica for the first
102
-				time, you may find that this prompt shows files in the wrong directory. Typica will show
103
-				files from the most recently used directory or if there isn't one, a platform dependent
104
-				default.</p>
105
-				
106
-				<img src="images/config1.png" />
107
-				
108
-				<p>This is a normal Open File window which works the same as when you select the Open
109
-				menu item in most programs. A number of controls are available to change to the correct
110
-				directory. You want to be in the <tt>configuration</tt> folder described previously.</p>
111
-				
112
-				<img src="images/config2.png" />
113
-				
114
-				<p>Once you are in the correct directory, select <tt>config.xml</tt> and click Open.</p>
115
-				
116
-				<img src="images/config3.png" />
117
-				
118
-				</p>The next window you see should look like this:</p>
119
-				
120
-				<img src="images/nav.png" />
121
-				
122
-				<h3>Troubleshooting: It Opened Internet Explorer and is showing me gobbledygook.</h3>
123
-				
124
-				<p>If this happens, you were not selecting the configuration file from within Typica.
125
-				Go back to Typica and try again. In particular, note the title bar of the window you
126
-				are in. See the screenshots above where it says "Open Configuration File". If your
127
-				window doesn't say that, you're not in Typica. You may think you are, but you're wrong.</p>
128
-				
129
-				<h3>Troubleshooting: I opened a file and nothing is happening.</h3>
130
-				
131
-				<p>Exit Typica and try again. You most likely selected the wrong file to open. Please
132
-				go back to the description of which file is required, read the instructions, and follow
133
-				them carefully.</p>
134
-				
135
-				<h3>Tip: Bypass the Configuration Prompt</h3>
136
-				
137
-				<p>Typica has a command line option available for specifying which configuration file
138
-				should be used. To do this, use -c and the path to the configuration you want to open.
139
-				This will prevent the configuration prompt from appearing. On Microsoft Windows, you
140
-				can do this by creating a shortcut. In Windows Explorer, go to the directory containing
141
-				Typica.exe. Right click and select "Create shortcut".</p>
142
-				
143
-				<img src="images/shortcut.png" />
144
-				
145
-				<p>Now right click the shortcut and select Properties.</p>
146
-				
147
-				<img src="images/properties.png" />
148
-				
149
-				<p>Find the field labeled Target. At the end of the line after the quotation mark, add
150
-				a space and <tt>-c ../configuration/config.xml</tt> and click OK. The portion of the
151
-				line that reads <tt>../configuration/config.xml</tt> is the path to your desired
152
-				configuration file relative to the directory with the program. You can also use an
153
-				absolute path to the file starting with <tt>C:\</tt> on Microsoft Windows or <tt>/</tt>
154
-				on other platforms.</p>
155
-				
156
-				<h3>Tip: Pin the Shortcut for Convenient Access</h3>
157
-				
158
-				<p>The shortcut created in the previous tip can be moved anywhere for convenient
159
-				access. You can right click that and find options to pin that to the task bar for
160
-				convenient single click access. On Windows 7 you can also pin that to the start menu
161
-				and on Windows 8 you can pin that to the start screen.</p>
162
-				
163
-				<a name="hardware" />
164
-				<h2>Configuring Typica for your Hardware</h2>
165
-				
166
-				<h3>Hardware</h3>
167
-				
168
-				<p>Once you've started Typica and selected your configuration file, you should see
169
-				the main navigation window. It looks like this:</p>
170
-				
171
-				<img src="images/nav.png" />
172
-				
173
-				<p>The first time you use Typica you will not have any coffee roasters configured
174
-				for use. This also applies for people who have used older versions of Typica and are
175
-				now upgrading to version 1.4 or later. To do this, click the Configure Roasters button.
176
-				This will bring up a new window with two panels. In the lower left you will see a
177
-				button labeled +. Click that to add your first coffee roaster.</p>
178
-				
179
-				<p>Now you will see an item in the left panel. You can double click on that to
180
-				rename it if you want. Whatever you name this is what will appear in the list in
181
-				the navigation window. Choose a name that you'll recognize as the particular machine
182
-				you'll be using.</p>
183
-				
184
-				<p>When you click on the roaster in the left panel you will see some details in the
185
-				right panel.</p>
186
-				
187
-				<img src="images/rconfig1.png" />
188
-				
189
-				<p>Next to "Machine ID for database" you should enter a number. This ID number will
190
-				be used to identify this roaster in the database and it will be associated with every
191
-				batch of coffee you roast. If you have used an older version of Typica, you can use
192
-				the same number that you had specified previously to maintain continuity. If you are
193
-				setting up Typica for the first time, just use 1 for your first roaster, 2 for your
194
-				second, and so on.</p>
195
-				
196
-				<p>You will also see three buttons: "Add Device", "Add Annotation Control", and
197
-				"Advanced Features". First we will want to use the Add Device button to specify the
198
-				data acquisition hardware you will use to connect this coffee roaster to your
199
-				computer.</p>
200
-				
201
-				<p>You should see up to three items in a menu when you click "Add Device". Select
202
-				the one matching the hardware that you intend to use. You will find a new item on
203
-				the left matching your selection.</p>
204
-				
205
-				<p>In the case of NI-DAQmx Base or NI-DAQmx, clicking the new item in the left panel
206
-				will change the right panel to display a single button: "Add Device". Click this to
207
-				see a list of supported hardware and click the item that matches the hardware you
208
-				have. In the case of NI-DAQmx, you can select "NI USB 9211A" for any supported USB
209
-				carrier containing a NI 9211 module. Whichever you choose, you will have a new item on
210
-				the left.</p>
211
-				
212
-				<p>If you instead selected "Modbus RTU Device", you will want to connect the hardware
213
-				to your computer before continuing. Once you click the new item in the left panel
214
-				Typica will attempt to detect any serial port on your computer and if your RS-485 to
215
-				USB serial adapter is not connected, it will not be shown. Click the item and you
216
-				will see all of the details for configuring Typica to use your Modbus RTU device.</p>
217
-				
218
-				<img src="images/modbusconfig.png" />
219
-				
220
-				<p>The appropriate settings here depend on settings that must be configured on the
221
-				Modbus RTU device and they depend on which device you have. You will require both
222
-				the operator manual and the communications manual for your device to determine the
223
-				correct settings for your hardware.</p>
224
-				
225
-				<p>If you selected NI DAQmx and then NI USB TC01, you will have an item on the
226
-				left representing that device. Clicking this will show three settings.</p>
227
-				
228
-				<img src="images/tc01config.png" />
229
-				
230
-				<p>The Device ID is how the National Instruments software identifies the device. In
231
-				the case of this hardware, this will be Dev<em>n</em> where <em>n</em> is some number.
232
-				This will most likely be <tt>Dev1</tt> but you can verify this in National Instrument's
233
-				Measurement & Automation Explorer. The Column Name indicates the name of the column
234
-				where measurements from this device will be placed in the table view of your roasting
235
-				data. A short, one word identifier is recommended for this. Note that certain advanced
236
-				features will require knowing a column name. The Thermocouple Type should match the type
237
-				of thermocouple you have in your roaster. If the wrong thermocouple type is specified,
238
-				your measurements will not be correct. Finally, if you double click this item on the
239
-				left, you can rename it. Whatever the item is named on the left is what will be displayed
240
-				on the indicator showing the most recent measurement. This can be a longer descriptive
241
-				name.</p>
242
-				
243
-				<p>In the case of NI 9211 based devices used either through NI DAQmx or NI DAQmx Base,
244
-				clicking the new item on the left will show a Device ID field and an Add Channel button.
245
-				If you are using NI DAQmx Base, this will be Dev<em>n</em> where <em>n</em> is a number
246
-				starting with 1 for the first connected device. If you only have one device, this will
247
-				be <tt>Dev1</tt>. If you are using NI DAQmx, some hardware will follow this convention
248
-				and some will not. You should check for the appropriate device ID in Measurement &
249
-				Automation Explorer. Ensure that you are looking at the item representing the device
250
-				itself and not just the chassis the device is plugged into. Once the Device ID is
251
-				specified, you can click Add Channel to add as many thermocouple channels as you have
252
-				connected to this device. With this hardware it is recommended that you do not connect
253
-				more than three thermocouples to a single device and these should be wired starting
254
-				from TC0.</p>
255
-				
256
-				<p>For each channel, you can double click the item on the left to change the text that
257
-				will appear in the indicator showing the most recent measurement. When you click on
258
-				these you will see on the right settings for Column Name and Thermocouple Type. The
259
-				Column Name will appear at the top of the table view in the column where measurements
260
-				from this channel are placed. A short one word name is recommended. This name should
261
-				be unique across all channels configured for a particular roaster. The thermocouple
262
-				type must match the type of the thermocouple connected on that channel. If it does not,
263
-				your measurements will not be correct.</p>
264
-				
265
-				<h3>Annotation Controls</h3>
266
-				
267
-				<p>If you click the item on the left representing your roaster, one of the available
268
-				buttons is "Add Annotation Control". Clicking this will provide three options:
269
-				"Annotation Button", "Counting Button", and "Numeric Entry". These controls can be
270
-				used to add annotations to your roasting data as you roast. If you don't want to do
271
-				this, you don't need to add any of these controls.</p>
272
-				
273
-				<p>An Annotation Button is used to make note of an event fixed at a particular moment
274
-				in time. If your roaster has a control with a small number of states, you can have a
275
-				different button for each state and when you activate that button it will place a
276
-				note at the most recent measurement. Some use this to note airflow control changes,
277
-				some prefer to note details such as the start of first crack. Clicking the item on the
278
-				left representing your annotation button will show two settings on the right. The
279
-				Button Text is the text that will appear on the button and the Annotation Text is the
280
-				text that will appear in the log when the button is activated. You can have any number
281
-				of these buttons, but it is recommended to keep the number small.</p>
282
-				
283
-				<p>A Counting Button is like an Annotation Button but you can have as part of the
284
-				annotation text a number corresponding to the number of times the button has been
285
-				clicked. This is useful when pulling several samples from a roast for roast profile
286
-				development as you will have a unique identifier for each sample you pull which you
287
-				can reference later when attempting to replicate your desired roast. It is recommended
288
-				that you only have one Counting Button.</p>
289
-				
290
-				<img src="images/countconfig.png" />
291
-				
292
-				<p>A good example of how a Counting Button can be used in profile development is shown in the following video. If you find this approach to coffee roasting interesting, the concepts are extended in the <a href="https://www.youtube.com/playlist?list=PLPTTFznZ65M-lSNokmiP2uByEoTZAg4oI">Roast Profile Development</a> video series.</p>
293
-				
294
-				<iframe width="640" height="360" src="https://www.youtube.com/embed/sct2FWVkmDw" frameborder="0" allowfullscreen></iframe>
295
-				
296
-				<p>Numeric Entry provides a way to provide notes with numeric data that cannot be
297
-				logged automatically. Some roasters have fuel or air flow controls with a large number
298
-				of numerically identified settings. Some people may want to occassionally note the
299
-				reading from a manometer. This is the control to do that. Clicking the item representing
300
-				a Numeric Entry on the left will show several options allowing you to specify how the
301
-				field is identified on the screen, minimum and maximum values, and the number of places
302
-				after the decimal point to allow. All of these must be set to some value. Optionally you
303
-				can also specify prefix text and/or suffix text. The content of these fields will be
304
-				included in the annotation before or after the entered number. This can be used to make
305
-				clear which control adjustment is represented or the unit a measurement reading was
306
-				taken in.</p>
307
-			</div>
308
-		</div>
309
-	</body>
310
-</html>

BIN
docs/documentation/images/adjustinventory.png View File


BIN
docs/documentation/images/coffeepurchase.png View File


BIN
docs/documentation/images/config1.png View File


BIN
docs/documentation/images/config2.png View File


BIN
docs/documentation/images/config3.png View File


BIN
docs/documentation/images/countconfig.png View File


BIN
docs/documentation/images/dbconnect.png View File


BIN
docs/documentation/images/explorer.png View File


BIN
docs/documentation/images/manageroasted.png View File


BIN
docs/documentation/images/modbusconfig.png View File


BIN
docs/documentation/images/nav.png View File


BIN
docs/documentation/images/navpurchase.png View File


BIN
docs/documentation/images/navroasted.png View File


BIN
docs/documentation/images/newbatchwindow.png View File


BIN
docs/documentation/images/properties.png View File


BIN
docs/documentation/images/rconfig1.png View File


BIN
docs/documentation/images/shortcut.png View File


BIN
docs/documentation/images/tc01config.png View File


+ 0
- 57
docs/documentation/part1.html View File

@@ -1,57 +0,0 @@
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 1: Basic Setup and Use</h1>
25
-                            <div class="toc">
26
-				<ul>
27
-					<li><a href="platforms.html">Supported Platforms and Hardware</a></li>
28
-					<li><a href="requiredsoftware.html">Required Software</a></li>
29
-					<li><a>Initial Setup</a></li>
30
-					<ul>
31
-						<li><a href="firsttime.html">Running Typica for the First Time</a></li>
32
-						<ul>
33
-							<li><a href="firsttime.html#database">Database Connection</a></li>
34
-							<li><a href="firsttime.html#configfile">Open Configuration File</a></li>
35
-							<li><a href="firsttime.html#hardware">Configuring Typica for your Hardware</a></li>
36
-						</ul>
37
-						<li><a href="dataentry.html">Initial Data Entry</a></li>
38
-						<ul>
39
-							<li><a href="dataentry.html#green">Green Coffee Purchases</a></li>
40
-							<li><a href="dataentry.html#roasted">Roasted Coffee Items</a></li>
41
-							<li><a href="dataentry.html#inventory">An Initial Inventory</a></li>
42
-							<li><a href="dataentry.html#profiles">Saving and Using Target Roast Profiles</a></li>
43
-						</ul>
44
-					</ul>
45
-					<li><a href="faq.html">Tips, Tricks, and Frequently Asked Questions</a></li>
46
-				</ul>
47
-                            </div>
48
-                            <div class="ntoc">
49
-                                <p>This part of the documentation covers the things you should
50
-				know before starting to use Typica and the basics of getting
51
-				everything set up for use. Some of the topics are covered in
52
-				greater depth in Part 2.</p>
53
-                            </div>
54
-			</div>
55
-		</div>
56
-	</body>
57
-</html>

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

@@ -1,85 +0,0 @@
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 href="http://appliedcoffeetechnology.tumblr.com/tagged/Typica" class="tab">Blog</a>
20
-				</div>
21
-			</div>
22
-			<div id="maintext">
23
-				<h1>Part 2: Comprehensive Feature Documentation</h1>
24
-				<p>This part of the documentation describes the features of
25
-				Typica.</p>
26
-				<ul>
27
-					<li><a href="part2/application.html">Opening the Application</a></li>
28
-					<ul>
29
-						<li><a href="windowreference/databaseconnection.html">Connecting to a database</a></li>
30
-						<li><a href="windowreference/openconfigurationfile">Open Configuration File</a></li>
31
-						<ul>
32
-							<li><a href="part2/argument-c.html">Eliminating the Configuration Prompt</a></li>
33
-						</ul>
34
-						<li><a href="windowreference/navigation.html">Main navigation window</a></li>
35
-					</ul>
36
-					<li><a>Configure Roasters</a></li>
37
-					<li><a href="windowreference/logging.html">The Logging View</a></li>
38
-					<li><a>Purchase Green Coffee</a></li>
39
-					<li><a href="windowreference/manageroasted.html">Manage Roasted Coffee Items</a></li>
40
-					<li><a>Edit Roasting Specification</a></li>
41
-					<li><a href="windowreference/updateinventory.html">Update Inventory</a></li>
42
-					<li><a>Cupping</a></li>
43
-                                        <ul>
44
-                                            <li><a>New Cupping Session</a></li>
45
-                                            <li><a>Join Cupping Session</a></li>
46
-                                            <li><a>Summarize Cupping Session</a></li>
47
-                                        </ul>
48
-                                        <li><a>View Target Roast Profiles</a></li>
49
-					<li><a>Import Target Roast Profiles</a></li>
50
-					<li><a>Enter Green Coffee Sales</a></li>
51
-					<li><a>Reports</a></li>
52
-					<ul>
53
-                                            <li><a>Production Reports</a></li>
54
-                                            <ul>
55
-                                                <li><a>Average Use and Cost by Origin</a></li>
56
-                                                <li><a>Previous Year Production Comparison</a></li>
57
-                                                <li><a>Cost of Green Coffee for Roasted Coffee</a></li>
58
-                                                <li><a>Daily Production Report</a></li>
59
-                                                <li><a>Batch Log</a></li>
60
-                                                <li><a>Previous Year Production Comparison By Month</a></li>
61
-                                                <li><a>Production Summary</a></li>
62
-                                                <li><a>Reminders</a></li>
63
-                                                <li><a>Recent Average Coffee Production</a></li>
64
-                                            </ul>
65
-                                            <li><a>Purchase Reports</a></li>
66
-                                            <ul>
67
-                                                <li><a>Coffee Purchase Previous Years Comparison</a></li>
68
-                                                <li><a>Invoices</a></li>
69
-                                            </ul>
70
-                                            <li><a>Sales Reports</a></li>
71
-                                            <ul>
72
-                                                <li><a>Green Coffee Sales</a></li>
73
-                                            </ul>
74
-                                            <li><a>Inventory Reports</a></li>
75
-                                            <ul>
76
-                                                <li><a>Inventory Change Summary</a></li>
77
-                                                <li><a>Current Inventory and Availability Projection</a></li>
78
-                                                <li><a>Item Transactions</a></li>
79
-                                            </ul>
80
-					</ul>
81
-				</ul>
82
-			</div>
83
-		</div>
84
-	</body>
85
-</html>

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

@@ -1,45 +0,0 @@
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 href="database-connection.html">Database Connection Settings</a></li>
39
-					<li><a href="open-configuration.html">Open Configuration File</a></li>
40
-					<li><a>Choose Your Path</a></li>
41
-				</ul>
42
-			</div>
43
-		</div>
44
-	</body>
45
-</html>

+ 0
- 31
docs/documentation/part2/argument-c.html View File

@@ -1,31 +0,0 @@
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>Eliminating the Configuration Prompt</h1>
25
-				<img src="images/open-configuration.png" />
26
-				<p>It is possible to bypass the above window when starting Typica by providing the information requested as a command line argument: <em>-c path</em> where path is a relative or absolute path to the configuration file. The preferred way to supply this information prior to starting Typica varies depending on what platform you are using.</p>
27
-
28
-			</div>
29
-		</div>
30
-	</body>
31
-</html>

+ 0
- 47
docs/documentation/part2/database-connection.html View File

@@ -1,47 +0,0 @@
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>Database Connection Settings</h1>
25
-				<p>If database connection settings have not been previously configured or if an attempt to connect to the database with the current settings fails, Typica will show the Database Connection Settings window when the program is opened.</p>
26
-				<img src="images/database-settings.png" />
27
-				<p>Typica uses a database managed by PostgreSQL to store records relating to your coffee. It is possible to use a limited subset of functionality without a database, however much of the design of Typica assumes that a database is available.</p>
28
-				<p>This window requests five pieces of information.</p>
29
-				<ul>
30
-					<li>Database driver: Currently, only PostgreSQL is supported.</li>
31
-					<li>Host name: If you are running PostgreSQL and Typica on the same computer, this should be <em>localhost</em> as seen in the above image. It is possible to install PostgreSQL on a different computer on your local network or on the Internet and configure it to accept connections from the computers where you will be using Typica. In that case the host name might be an IP address (example: <em>192.168.1.50</em>) or a domain name (example: <em>typica.example.com</em>).</li>
32
-					<li>Database name: PostgreSQL can manage multiple databases and each one has a name. PostgreSQL installers typically create a database named <em>postgres</em>. Typica can use this, however it is recommended to create a new database for Typica to use.</li>
33
-					<li>User name: PostgreSQL database user names are distinct from system user names. PostgreSQL installers typically create a user called <em>postgres</em>. While Typica can use that user name, it is recommended to create at least one new user. If you create a new user, you will need to ensure that it has the necessary permissions on the database you will be using.</li>
34
-					<li>Password: If you are using the user name <em>postgres</em> created by a PostgreSQL installer, you will have been asked to produce a password during installation. The password you chose will be the password to enter here. If you have created a new user, this will be the password associated with that user.</li>
35
-				</ul>
36
-				<p>Once all of this information has been entered, you can click the "Connect" button. Typica will close this window and attempt to connect to the database using the specified information. If this connection attempt fails, the window will reappear so you can verify the connection information, ensure that the database is accessible, and try again.</p>
37
-				<p>If you do not wish to use a database, you can click the "Cancel" button. Note that if you do not connect to a database, Typica will bring this window up again the next time you start the program.</p>
38
-				<h1>What Happens Next?</h1>
39
-				<p>After Typica has connected to the database or you have pressed "Cancel" Typica will bring up one of two windows.</p>
40
-				<ul>
41
-					<li><a href="open-configuration.html">Open Configuration File</a></li>
42
-					<li><a>Choose Your Path</a></li>
43
-				</ul>
44
-			</div>
45
-		</div>
46
-	</body>
47
-</html>

BIN
docs/documentation/part2/images/database-settings.png View File


BIN
docs/documentation/part2/images/open-configuration.png View File


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


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


+ 0
- 40
docs/documentation/part2/open-configuration.html View File

@@ -1,40 +0,0 @@
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>Open Configuration File</h1>
25
-				<img src="images/open-configuration.png" />
26
-				<p>After Typica has connected to a database or you have decided to not connect to the database, you will be prompted to select a configuration file unless you have opened Typica through a shortcut or command line that specifies the configuration file you would like to use. The configuration file is responsible for setting up nearly all of the graphical interface elements in Typica. An example configuration, <em>config.xml</em> is provided with Typica in the config folder. The rest of the documentation assumes that you are using this configuration and an effort is made to provide an example configuration that most people will not need to customize, however if you would like to change the behavior of Typica, it is often possible to achieve the desired results by editing the files in the config folder and its subfolders.</p>
27
-
28
-				<p>The prompt comes in the form of an Open File window and should look similar to what you see when you select Open from the File menu in most other programs on your computer. When using the example configuration provided with Typica, please ensure that you are using the configuration provided with the version of Typica that you are using and not an older configuration provided with a previous version of the program that you may have used. Also note the the title of the "Open Configuration File" window. If the title of the window is not "Open Configuration File" you might not actually be using Typica, in which case opening the file will result in unexpected behavior as the computer will do as you have instructed instead of as you intended.</p>
29
-				
30
-				<p><a href="argument-c.html">Note that it is possible to bypass this prompt.</a></p>
31
-
32
-				<h1>What Happens Next?</h1>
33
-				<p>After the configuration file has been opened you should see the "Choose Your Path" window. This is the main navigational window for the program which provides access to the major functional areas of the program.<p>
34
-				<ul>
35
-					<li><a>Choose Your Path</a></li>
36
-				</ul>
37
-			</div>
38
-		</div>
39
-	</body>
40
-</html>

+ 0
- 154
docs/documentation/platforms.html View File

@@ -1,154 +0,0 @@
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>Supported Platforms and Hardware</h1>
25
-				<p>This section details the hardware and software that Typica
26
-				has been tested with and what is known to work. Other
27
-				arrangements may work but have not been tested.</p>
28
-				
29
-				<h2>Operating Systems</h2>
30
-				<p>Precompiled builds of Typica are provided for Microsoft
31
-				Windows and Mac OS X. The Microsoft Windows build has been
32
-				tested as working on both Windows 7 and Windows 10. It might
33
-				work on Windows XP, Windows Vista, or Windows 8 but this has not been tested.</p>
34
-				<p>The Mac OS X build has been tested on Mac OS X 10.6 through 10.11. The build is also only for Macs with Intel processors. Note that at the time of this writing National Instruments hardware is known to not work starting with OS X 10.10 or later. If National Instruments starts advertising that a newer version of NI DAQmx Base works with current operating system releases and supported hardware, Typica will probably work with that, but there's nothing that anybody else can do about that other than choosing different hardware.</p>
35
-				<p>Source code is provided which may be used to build Typica
36
-				on Linux, PowerPC based Macs, and possibly other platforms,
37
-				however instructions on doing this are beyond the scope of this
38
-				document.</p>
39
-				
40
-				<a name="hardware" />
41
-				<h2>Data Acquisition Hardware</h2>
42
-				
43
-				<p>On Microsoft Windows and Mac OS X, the National Instruments
44
-				NI 9211 module is supported in either the
45
-				<a href="http://sine.ni.com/nips/cds/view/p/lang/en/nid/13880">NI USB-9161</a>
46
-				or
47
-				<a href="http://sine.ni.com/nips/cds/view/p/lang/en/nid/201881">NI USB-9162</a>
48
-				USB carrier using NI DAQmx Base supporting software which is
49
-				available for download from National Instruments. Note that the
50
-				different USB carriers require different versions of this software.
51
-				Using the 9161 carrier you will need
52
-				<a href="http://joule.ni.com/nidu/cds/view/p/id/428/lang/en">NI-DAQmx Base 2.1 on Mac OS X</a>
53
-				or
54
-				<a href="http://joule.ni.com/nidu/cds/view/p/id/424/lang/en">NI-DAQmx Base 2.2 on Microsoft Windows</a>.
55
-				Using the 9162 carrier, you will need
56
-				<a href="http://joule.ni.com/nidu/cds/view/p/id/3431/lang/en">NI DAQmx Base 3.6 on Mac OS X</a>
57
-				or
58
-				<a href="http://joule.ni.com/nidu/cds/view/p/id/3436/lang/en">NI DAQmx Base 3.6 on Microsoft Windows</a>.
59
-				Please check documentation
60
-				available from National Instruments regarding Linux support if you
61
-				intend to build Typica on Linux.</p>
62
-				<p>On <strong>Microsoft Windows only</strong> the National
63
-				Instruments NI 9211 module can be used with the
64
-				<a href="http://sine.ni.com/nips/cds/view/p/lang/en/nid/201881">NI USB-9162</a>
65
-				USB carrier or the
66
-				<a href="http://sine.ni.com/nips/cds/view/p/lang/en/nid/209887">NI cDAQ-9171</a>.
67
-				The
68
-				<a href="http://sine.ni.com/nips/cds/view/p/lang/en/nid/208177">NI USB-TC01</a>
69
-				is also an option on
70
-				this platform. This has been tested with
71
-				<a href="http://joule.ni.com/nidu/cds/view/p/id/3622/lang/en">NI-DAQmx 9.6.1</a>. A newer hardware revision has been released which no longer works with NI-DAQmx 9.6.1. If you encounter an error related to firmware being too new, try the latest version of NI-DAQmx.
72
-				Note that NI-DAQmx should not be installed at the same time as NI-DAQmx Base 3.6
73
-				however it is fine to have it installed at the same time as NI-DAQmx Base 2.2.</p>
74
-				<p>On all platforms, devices which communicate using the Modbus
75
-				RTU protocol can be used. Currently only one such device is
76
-				supported per bus and measurements must be delivered in scaled
77
-				integer representation. You will need the communications manual
78
-				for whichever device you choose in order to set up Typica. This
79
-				has been tested with the Fuji PXR4 PID controller, but most
80
-				similar devices with Modbus RTU support should also work. Typica
81
-				does not require any supporting software for this hardware,
82
-				however most of these devices use RS-485 for the physical connection
83
-				and you may need an RS-485 to USB adapter and you may need to
84
-				install driver software before this adapter will work correctly.
85
-				Consult the manuals for your hardware for more details.</p>
86
-				
87
-				<p>If you're not sure what hardware will work best for you, there is a video that covers all of the options and what's good or bad about each of those.</p>
88
-				
89
-				<iframe width="640" height="360" src="https://www.youtube.com/embed/CeB1x2yZufY" frameborder="0" allowfullscreen></iframe>
90
-				
91
-				<a name="compatability" />
92
-				<h2>Hardware Compatability Table</h2>
93
-				<p>The table below is a quick reference on what operating systems different hardware supported by Typica can work with. Please click on the device name and read the compatability notes <em>before</em> purchasing hardware with the intention of using it with Typica.</p>
94
-				<table>
95
-					<thead>
96
-						<th />
97
-						<th>Windows</th>
98
-						<th>Mac OS X</th>
99
-						<th>Linux</th>
100
-					</thead>
101
-					<tbody>
102
-						<tr>
103
-							<th><a href="appendix-a.1.html">National Instruments NI USB-9211</a></th>
104
-							<td>yes</td>
105
-							<td>only 10.9 or earlier</td>
106
-							<td>maybe</td>
107
-						</tr>
108
-						<tr>
109
-							<th><a href="appendix-a.2.html">National Instruments NI USB-9211A</a></th>
110
-							<td>yes</td>
111
-							<td>only 10.9 or earlier</td>
112
-							<td>maybe</td>
113
-						</tr>
114
-						<tr>
115
-							<th><a href="appendix-a.3.html">National Instruments NI 9211 paired with NI cDAQ-9171</a></th>
116
-							<td>yes</td>
117
-							<td>no</td>
118
-							<td>no</td>
119
-						</tr>
120
-						<tr>
121
-							<th><a href="appendix-a.4.html">National Instruments NI USB-TC01</a></th>
122
-							<td>yes</td>
123
-							<td>no</td>
124
-							<td>no</td>
125
-						</tr>
126
-						<tr>
127
-							<th><a href="appendix-a.5.html">DATAQ DI-145</a></th>
128
-							<td>yes</td>
129
-							<td>no</td>
130
-							<td>no</td>
131
-						</tr>
132
-						<tr>
133
-							<th><a href="appendix-a.6.html">Modbus RTU Devices</a></th>
134
-							<td>yes</td>
135
-							<td>yes</td>
136
-							<td>yes</td>
137
-						</tr>
138
-						<tr>
139
-                                                    <th>Phidgets 1048</th>
140
-                                                    <td>yes</td>
141
-                                                    <td>yes</td>
142
-                                                    <td>yes</td>
143
-                                                </tr>
144
-					</tbody>
145
-				</table>
146
-				
147
-				<h2>Connecting Hardware</h2>
148
-				<p>If you are using the Phidgets 1048 or National Instruments devices and your coffee roaster already has a thermocouple installed, you might find the following video helpful in connecting your existing thermocouples to your data acquisition hardware. The video uses a Diedrich SR-1 and a National Instruments NI USB-9211, but the same procedure works with a wide range of commercial roasting equipment and other data acquisition devices.</p>
149
-				
150
-				<iframe width="640" height="360" src="https://www.youtube.com/embed/EXPjLgCoUWU" frameborder="0" allowfullscreen></iframe>
151
-			</div>
152
-		</div>
153
-	</body>
154
-</html>

+ 0
- 125
docs/documentation/requiredsoftware.html View File

@@ -1,125 +0,0 @@
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>Required Software</h1>
25
-				<p>Typica can benefit from certain supporting software and some
26
-				hardware requires software for communicating with that hardware.</p>
27
-				
28
-				<h2>PostgreSQL</h2>
29
-				<p>Most of the features of Typica use a PostgreSQL database.
30
-				This is where the data on all of the batches of coffee you
31
-				roast will be saved, where inventory data will be saved, and
32
-				it is the source of all data used in reports. While it is
33
-				possible to use Typica without PostgreSQL, the usable feature
34
-				set will be highly limited.</p>
35
-				
36
-				<p>The easiest way to set this up is to install PostgreSQL on
37
-				the same computer that will be running Typica, however there
38
-				are some advantages to running the database on a different
39
-				machine on the network. That requires some additional work to
40
-				set up PostgreSQL to accept connections from other computers on
41
-				your network, but this allows multiple computers to run Typica
42
-				and access the same data.</p>
43
-				
44
-				<p>PostgreSQL can be obtained from
45
-				<a href="http://www.postgresql.org">www.postgresql.org</a>.
46
-				There you can
47
-				<a href="http://www.postgresql.org/download/">download</a> the
48
-				appropriate binary package for the platform you intend to run
49
-				the database on. Typica requires version 9.3 or later, however the people behind PostgreSQL have a very good history of making new versions better than the old one so the newest stable release is recommended for new installations. When installing PostgreSQL, please make note of
50
-				the password that you choose for the postgres user as you will
51
-				need this information later.</p>
52
-				
53
-				<p>If you do want to set up PostgreSQL for use over a network,
54
-				you may find
55
-				<a href="http://www.postgresql.org/docs/9.2/static/auth-pg-hba-conf.html">
56
-				this section</a> of the documentation helpful.
57
-				<a href="http://appliedcoffeetechnology.tumblr.com/post/14056767756">
58
-				This blog post</a> may also be useful.</p>
59
-				
60
-				<p>Once you are finished installing and setting up PostgreSQL,
61
-				you may want to restart your computer and verify that the PostgreSQL
62
-				starts on boot.</p>
63
-				
64
-				<h3>Optional: Setting up a Database and User Role</h3>
65
-				
66
-				<p>The PostgreSQL installer will set up a user role called
67
-				<tt>postgres</tt> and a database called <tt>postgres</tt>. The
68
-				<tt>postgres</tt> user has full access to all features of the
69
-				database and Typica does not require that. If you are using
70
-				PostgreSQL for other purposes you may also want to give Typica
71
-				its own database to avoid potential conflicts with other
72
-				applications. Typica will use whatever database and user you
73
-				specify the first time you start the program. Details on how to
74
-				do this are in the
75
-				<a href="http://www.postgresql.org/docs/9.2/static/index.html">
76
-				PostgreSQL documentation</a>.
77
-				
78
-				<p>The following two videos might be helpful. One provides a walkthrough of installing PostgreSQL on either Mac OS X or Windows. The other covers upgrading from an older version of PostgreSQL to a newer one.</p>
79
-				
80
-				<iframe width="640" height="360" src="https://www.youtube.com/embed/tO4A4vaSen8" frameborder="0" allowfullscreen></iframe>
81
-				
82
-				<iframe width="640" height="360" src="https://www.youtube.com/embed/qGVb3J5y3nw" frameborder="0" allowfullscreen></iframe>
83
-				
84
-				<h2>Hardware Communications Software</h2>
85
-				
86
-				<p>The software that you need to communicate with your data
87
-				acquisition hardware depends on what hardware you intend to use.</p>
88
-				
89
-				<h3>Phidgets 1048</h3>
90
-				
91
-				<p>The Phidgets 1048 requires the <a href="http://www.phidgets.com/docs/Operating_System_Support">drivers and libraries download available from the manufacturer</a>. This is tested as working with Typica on Mac OS X, Windows, and Linux.</p>
92
-				
93
-				<h3>Software for Modbus RTU device support</h3>
94
-				
95
-				<p>No additional software is strictly required for devices that
96
-				communicate using the Modbus RTU protocol. Most of these devices
97
-				are connected with RS-485, which is not a standard you are likely
98
-				to find built into your computer so you will most likely need
99
-				an adapter that allows you to connect the bus to your computer
100
-				through a USB connection. Your computer should see this adapter
101
-				as an ordinary serial port, however you may need to install
102
-				driver software for the adapter you choose. Ensure that the
103
-				adapter is supported on whatever platform you intend to use.</p>
104
-				
105
-				<h3>NI DAQmx Devices - Microsoft Windows Only</h3>
106
-				
107
-				<p>Certain hardware from National Instruments requires
108
-				NI-DAQmx. Typica has been tested with version 9.6.1, however newer hardware revisions of some supported hardware requires a newer version. See
109
-				<a href="platforms.html#hardware">Supported Platforms and Hardware</a>
110
-				for more details.</p>
111
-				
112
-				<h3>NI DAQmx Base Devices</h3>
113
-				
114
-				<p>Certain hardware from National Instruments requires NI-DAQmx Base.
115
-				The version you will need depends on the hardware you have. See
116
-				<a href="platforms.html#hardware">Supported Platforms and Hardware</a>
117
-				for more details.</p>
118
-				
119
-				<h2>Typica</h2>
120
-				
121
-				<p>You will also need to download Typica to be able to use Typica.</p>
122
-			</div>
123
-		</div>
124
-	</body>
125
-</html>

+ 0
- 79
docs/documentation/windowreference/databaseconnection.html View File

@@ -1,79 +0,0 @@
1
-<html>
2
-    <head>
3
-        <title>Typica - Connecting to a database</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" >Documentation</a>
18
-                    <a class="tab" href="../../screenshots.html" >Screenshots and Videos</a>
19
-                    <a href="http://appliedcoffeetechnology.tumblr.com/tagged/Typica" class="tab">Blog</a>
20
-                </div>
21
-            </div>
22
-            <div id="maintext">
23
-                <h1>Connecting to a database</h1>
24
-                <p>When opening Typica, if you have not previously connected to
25
-                a database, you will be prompted for information needed to
26
-                connect to that database.</p>
27
-
28
-                <img src="databaseconnection.png"/>
29
-                
30
-                <p>If you do not want to connect to a database, you can click
31
-                the Cancel button, but doing so means that most of the features
32
-                of Typica will not work. Clicking the Connect button will cause
33
-                Typica to attempt to connect to the database with the
34
-                information provided in the fields. An error message will be
35
-                presented if that connection attempt fails.</p>
36
-                
37
-                <p>After either successfully connecting to a database or
38
-                cancelling, you will be prompted to
39
-                <a href="openconfigurationfile.html">open a configuration
40
-                file.</a></p>
41
-                
42
-                <h2>Field descriptions</h2>
43
-                
44
-                <h3>Database driver</h3>
45
-                <p>Currently the only database supported is PostgreSQL.</p>
46
-                
47
-                <h3>Host name</h3>
48
-                <p>This identifies the computer the database is installed on.
49
-                If the database is on the same computer as Typica, this can be
50
-                <tt>localhost</tt> otherwise it will most likely be an IP
51
-                address for another computer on your network.</p>
52
-                
53
-                <h3>Port number</h3>
54
-                <p>PostgreSQL normally communicates on port 5432 but if you
55
-                have PostgreSQL configured to communicate over a different port
56
-                this field should be changed to match.</p>
57
-                
58
-                <h3>Database name</h3>
59
-                <p>During installation, the PostgreSQL installer creates a
60
-                database called <tt>postgres</tt>. If you've created a new
61
-                database for use with Typica, its name should be used.</p>
62
-                
63
-                <h3>User name</h3>
64
-                <p>During installation, the PostgreSQL installer creates a
65
-                database user called <tt>postgres</tt>. If you don't want to
66
-                create separate users, this account can be used. Typica keeps
67
-                track of which database user performed many data entry tasks so
68
-                it is recommended to create new users for everybody who will be
69
-                using Typica.</p>
70
-                
71
-                <h3>Password</h3>
72
-                <p>This is the password previously set for the database user.
73
-                If you are using the <tt>postgres</tt> user, this was set
74
-                during PostgreSQL installation.</p>
75
-
76
-            </div>
77
-        </div>
78
-    </body>
79
-</html>

BIN
docs/documentation/windowreference/databaseconnection.png View File


BIN
docs/documentation/windowreference/databasemenu.png View File


BIN
docs/documentation/windowreference/inventoryreports.png View File


BIN
docs/documentation/windowreference/inventorytransaction.png View File


+ 0
- 206
docs/documentation/windowreference/logging.html View File

@@ -1,206 +0,0 @@
1
-<html>
2
-    <head>
3
-        <title>Typica - The Logging View</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" >Documentation</a>
18
-                    <a class="tab" href="../../screenshots.html" >Screenshots and Videos</a>
19
-                    <a href="http://appliedcoffeetechnology.tumblr.com/tagged/Typica" class="tab">Blog</a>
20
-                </div>
21
-            </div>
22
-            <div id="maintext">
23
-                <h1>The Logging View</h1>
24
-                <p>The appearance of the logging view depends on how the selected
25
-                roaster was configured, but there are a few main areas where
26
-                different interface items are located.</p>
27
-
28
-                <img src="logging.png"/>
29
-                
30
-                <p>The window title will change to reflect a loaded target roast
31
-                profile and can provide the name of the coffee being roasted.</p>
32
-
33
-                <p>The menu bar provides access to a number of operations such
34
-                as saving or loading data on disk, entering new batch information,
35
-                clearing recorded data, changing how data is displayed, and more.
36
-                Note that on a Mac the menu bar will be at the top of the screen
37
-                and not within the window as is normal on that platform.</p>
38
-
39
-                <p>Continuing down the window is the indicator panel. This is
40
-                where current temperature indicators, rate of change information,
41
-                and timers will be displayed. The number, type, and order of
42
-                indicators depends on the roaster configuration. There are
43
-                splitter handles between each indicator which can be used to
44
-                control the width of each indicator. The last indicator should
45
-                always be the batch timer. If you don't see this, there should
46
-                be a splitter handle to the right of the last visible indicator
47
-                which can be dragged left to reveal additional indicators. A
48
-                splitter handle at the bottom can be used to control the height
49
-                of all indicators.</p>
50
-
51
-                <p>Next is a row of buttons. At minimum this will include buttons
52
-                for starting and stopping the batch, but a number of other
53
-                controls for inserting notes in the log can also be configured
54
-                to appear here. Under these buttons is another splitter handle
55
-                that can be used to control the height of to table and graph
56
-                below.</p>
57
-
58
-                <p>Below this and on the left is a table view showing times,
59
-                temperatures, and notes for both a target profile if one is
60
-                loaded and the current batch if one is being recorded.</p>
61
-
62
-                <p>To the right of the table view is a graph showing both
63
-                loaded target profiles, if any, and current batch data.</p>
64
-
65
-                <h2>Buttons</h2>
66
-
67
-                <h3>Start Batch</h3>
68
-                <p>This button starts recording roasting data. If the New Batch
69
-                or New Sample Batch windows were used, the roasting data can be
70
-                associated with a batch in the database. Clicking this will
71
-                also start the batch timer from 00:00, start any other timers
72
-                that have been configured to start from the start of the batch,
73
-                and create any annotations that have been configured for entry
74
-                at the start of the batch if any.</p>
75
-
76
-                <h3>Stop Batch</h3>
77
-                <p>This button stops the batch timer, stops recording roasting
78
-                data, and if the New Batch or New Sample Batch windows were
79
-                used, the window with data associated with the finished batch
80
-                will be raised.</p>
81
-
82
-                <h3>Additional Buttons</h3>
83
-                <p>Additional buttons and controls will appear if these have
84
-                been configured.</p>
85
-
86
-                <h2>The File Menu</h2>
87
-
88
-                <img src="loggingfile.png" />
89
-
90
-                <h3>Open...</h3>
91
-                <p>This can be used to load roasting data previously saved to
92
-                disk. This is mainly useful when receiving roasting data that
93
-                has been shared from another roaster. In normal use it is much
94
-                better to use information saved to the database instead of
95
-                managing files manually.</p>
96
-
97
-                <h3>Save...</h3>
98
-                <p>This can be used to save roasting data to disk. This is
99
-                mainly useful to share roasting data with another person using
100
-                Typica. For other uses it is much better to use the New Batch
101
-                and New Sample Batch windows to have roasting data saved to the
102
-                database.</p>
103
-
104
-                <h3>Print...</h3>
105
-                <p>This can be used to print roasting data. The print window
106
-                will appear, allowing the information printed to be
107
-                customized.</p>
108
-
109
-                <h3>Export CSV...</h3>
110
-                <p>This can be used to export roasting data as a CSV file which
111
-                can be opened in all popular spreadsheet applications or used
112
-                with a wide variety of other tools. If this is something that
113
-                you frequently require, it may be a good idea to reach out to
114
-                the author with your use case and see if there is a way to do
115
-                what you want within Typica or if Typica should be extended to
116
-                support your use case.</p>
117
-
118
-                <h3>Export XHTML+SVG</h3>
119
-                <p>This can be used to produce the same information that can be
120
-                printed, but produces that as an XHTML+SVG document.</p>
121
-
122
-                <h3>Quit</h3>
123
-                <p>On some platforms this might be called Exit and on the Mac
124
-                this will be moved under the Typica menu. It is used to quit
125
-                Typica.</p>
126
-                
127
-                <h2>The Batch Menu</h2>
128
-                
129
-                <img src="loggingbatch.png" />
130
-                
131
-                <h3>New Batch...</h3>
132
-                <p>This is the preferred way to enter the details of a
133
-                production roast such that recorded roasting data can be
134
-                associated with a batch and green coffee inventory can be
135
-                adjusted. Selecting this will open the New Batch window.</p>
136
-                
137
-                <h3>New Sample Batch...</h3>
138
-                <p>When roasting a green coffee not in inventory such as
139
-                pre-purchase samples, you can use this menu item to open the
140
-                New Sample Batch window and associate the roasting data with
141
-                additional information about the coffee.</p>
142
-                
143
-                <h3>Load Additional Profiles...</h3>
144
-                <p>If you do not have a target roast profile for the roasted
145
-                coffee item you are producing but have a batch that you would
146
-                like to have available for reference previously saved in the
147
-                database, you can use this menu item to load that information
148
-                as a target roast profile.</p>
149
-                
150
-                <h2>The Log Menu</h2>
151
-                
152
-                <img src="logginglog.png" />
153
-                
154
-                <h3>Display Celsius</h3>
155
-                <p>This menu item can be used to change displayed temperature
156
-                measurements to Celsius.</p>
157
-                
158
-                <h3>Display Fahrenheit</h3>
159
-                <p>This menu item can be used to change displayed temperature
160
-                measurements to Fahrenheit.</p>
161
-                
162
-                <h3>New Sample Parameters</h3>
163
-                <p>If a Counting Button has been configured, this menu item
164
-                will be available to change the annotation text or reset the
165
-                number used in annotations when that button is activated.</p>
166
-                
167
-                <h3>Clear Log</h3>
168
-                <p>This menu item removes all information currently visible in
169
-                the table and graph views.</p>
170
-                
171
-                <h3>Millisecond View</h3>
172
-                <h3>1 Second View</h3>
173
-                <h3>5 Second View</h3>
174
-                <h3>10 Second View</h3>
175
-                <h3>15 Second View</h3>
176
-                <h3>30 Second View</h3>
177
-                <h3>1 Minute View</h3>
178
-                
179
-                <p>These items affect the table view. The millisecond view will
180
-                show every measurement in the table while the other views will
181
-                limit the entries shown to one per indicated interval with the
182
-                exception of times associated with an annotation which will
183
-                always be shown regardless of the selected view.</p>
184
-                
185
-                <h3>Manual Entry</h3>
186
-                <p>This can be used for entering roasting data collected when
187
-                not connected to a roaster. The utility of this feature is
188
-                somewhat limited and generally not worth using.</p>
189
-                
190
-                <h2> The Graph Menu</h2>
191
-                
192
-                <img src="logginggraph.png" />
193
-                
194
-                <h3>Reset Translation</h3>
195
-                <p>If the roaster in use has been configured to use roast
196
-                profile translation, this item can be used to reset any
197
-                currently applied translation transformation in the graph. The
198
-                following video contains more information about the roast
199
-                profile translation feature and why you might want to use it.</p>
200
-                
201
-                <iframe width="640" height="360" src="https://www.youtube.com/embed/hS0SfzypyFQ" frameborder="0" allowfullscreen></iframe>
202
-                
203
-            </div>
204
-        </div>
205
-    </body>
206
-</html>

BIN
docs/documentation/windowreference/logging.png View File


BIN
docs/documentation/windowreference/loggingbatch.png View File


BIN
docs/documentation/windowreference/loggingfile.png View File


BIN
docs/documentation/windowreference/logginggraph.png View File


BIN
docs/documentation/windowreference/logginglog.png View File


BIN
docs/documentation/windowreference/losstransaction.png View File


+ 0
- 56
docs/documentation/windowreference/manageroasted.html View File

@@ -1,56 +0,0 @@
1
-<html>
2
-    <head>
3
-        <title>Typica - Manage Roasted Coffee Items</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" >Documentation</a>
18
-                    <a class="tab" href="../../screenshots.html" >Screenshots and Videos</a>
19
-                    <a href="http://appliedcoffeetechnology.tumblr.com/tagged/Typica" class="tab">Blog</a>
20
-                </div>
21
-            </div>
22
-            <div id="maintext">
23
-                <h1>Manage Roasted Coffee Items</h1>
24
-                <img src="manageroasted.png" />
25
-
26
-                <p>When using the New Batch window to roast coffee, there is a
27
-                control to select which roasted coffee item you would like to
28
-                roast. Manage Roasted Coffee Items allows you to control which
29
-                items will appear in that list.</p>
30
-                
31
-                <h2>Field descriptions</h2>
32
-                
33
-                <h3>New Roasted Coffee</h3>
34
-                <p>If you want a completely new roasted coffee item, you can
35
-                type the name of the item in this field, click Add New Coffee,
36
-                and this will create a new roasted coffee item and add it to
37
-                the Current Items list.</p>
38
-                
39
-                <h3>Current Items</h3>
40
-                <p>This is a list of all of the items that will appear in the
41
-                New Batch window. If you discontinue a roasted coffee item and
42
-                would like that to no longer appear as an option in the New
43
-                Batch window you can select the item and click Remove Item to
44
-                move that item to the Discontinued Items list.</p>
45
-                
46
-                <h3>Discontinued Items</h3>
47
-                <p>This is a list of roasted coffee items which are not in the
48
-                Current Items list. If you have previously discontinued an item
49
-                and would like to bring that back as an option in the New Batch
50
-                window, you can select the item from this list and click Restore
51
-                Item.</p>
52
-
53
-            </div>
54
-        </div>
55
-    </body>
56
-</html>

BIN
docs/documentation/windowreference/manageroasted.png View File


+ 0
- 156
docs/documentation/windowreference/navigation.html View File

@@ -1,156 +0,0 @@
1
-<html>
2
-    <head>
3
-        <title>Typica - Choose Your Path</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" >Documentation</a>
18
-                    <a class="tab" href="../../screenshots.html" >Screenshots and Videos</a>
19
-                    <a href="http://appliedcoffeetechnology.tumblr.com/tagged/Typica" class="tab">Blog</a>
20
-                </div>
21
-            </div>
22
-            <div id="maintext">
23
-                <h1>Main navigation window</h1>
24
-                <p>Most of the functionality in Typica is available through the
25
-                main navigation window.</p>
26
-
27
-                <img src="navigation.png"/>
28
-                
29
-                <h2>Buttons</h2>
30
-                
31
-                <h3>Configure Roasters</h3>
32
-                
33
-                <p>Typica can communicate with different pieces of data
34
-                acquisition hardware which must be configured before use.
35
-                Various features related to recording roasting data can be
36
-                set in the configuration
37
-                window.
38
-                
39
-                <h3>Roast Coffee</h3>
40
-                
41
-                <p>Once at least one coffee roaster has been configured, it
42
-                will be available from the selector next to the Roast Coffee
43
-                button. When you want to roast coffee, select the machine
44
-                you'll be using and click the Roast Coffee button. This will
45
-                take you to <a href="logging.html">the logging view.</a></p>
46
-                
47
-                <h3>Purchase Green Coffee</h3>
48
-                
49
-                <p>Typica tracks green coffee inventory. This button allows
50
-                you to enter the details of green coffee purchases.</p>
51
-                
52
-                <h3><a href="manageroasted.html">Manage Roasted Coffee Items</a></h3>
53
-                
54
-                <p>When entering the details of a new production batch, you
55
-                will want to select a roasted coffee item. This is connected
56
-                to the green coffee(s) used, a target roast profile and
57
-                roasting specification if set. This button allows you to create
58
-                new roasted coffee items, discontinue items so that they will
59
-                not show up in lists, and bring back old items.</p>
60
-                
61
-                <h3>Edit Roasting Specification</h3>
62
-                
63
-                <p>Expected percent weight loss and other information can be
64
-                presented when roasting coffee for use in determining if a
65
-                batch matches its product specification.</p>
66
-                
67
-                <h3><a href="updateinventory.html">Update Inventory</a></h3>
68
-                
69
-                <p>Inventory and loss transactions can be used to adjust
70
-                green coffee inventory.</p>
71
-                
72
-                <h3>New Cupping Session</h3>
73
-                <h3>Join Cupping Session</h3>
74
-                <h3>Summarize Cupping Session</h3>
75
-                
76
-                <p>Typica includes a set of cupping features. Some people use
77
-                this, but the author does not recommend it. Something much
78
-                better will be available in the future.</p>
79
-                
80
-                <h3>View Target Roast Profiles</h3>
81
-                
82
-                <p>Any data ever saved as a target roast profile for roasted
83
-                coffee items can be seen here.</p>
84
-                
85
-                <h3>Import Target Roast Profiles</h3>
86
-                
87
-                <p>It is possible to save batch data to disk instead of or in
88
-                addition to saving that to the database. These files can be
89
-                shared with other people using Typica. If you want to set data
90
-                from one of these files as a target roast profile for a given
91
-                roasted coffee item, this is where you do that.
92
-                
93
-                <h3>Enter Green Coffee Sales</h3>
94
-                
95
-                <p>If you sell green coffee, the inventory can be adjusted to
96
-                reflect that here.</p>
97
-                
98
-                <h2>Reports Menu</h2>
99
-                
100
-                <img src="reportsmenu.png" />
101
-                
102
-                <h3>Production</h3>
103
-                
104
-                <p>Production reports present information related to coffee
105
-                roasting activity.</p>
106
-                
107
-                <img src="productionreports.png" />
108
-                
109
-                <h3>Average Use and Cost by Origin</h3>
110
-                <h3>Previous Year Production Comparison</h3>
111
-                <h3>Cost of Green Coffee for Roasted Coffee</h3>
112
-                <h3>Daily Production Report (Detailed)</h3>
113
-                <h3>Batch Log</h3>
114
-                <h3>Previous Year Production Comparison By Month</h3>
115
-                <h3>Production Summary</h3>
116
-                <h3>Reminders</h3>
117
-                <h3>Recent Average Coffee Production</h3>
118
-                
119
-                <h3>Purchase</h3>
120
-                
121
-                <p>Purchase reports present information related to green coffee
122
-                purchases.</p>
123
-                
124
-                <img src="purchasereports.png" />
125
-                
126
-                <h3>Coffee Purchase Previous Years Comparison</h3>
127
-                <h3>Invoices</h3>
128
-                
129
-                <h3>Sales</h3>
130
-                
131
-                <p>Sales reports present information related to sales.</p>
132
-                
133
-                <img src="salesreport.png" />
134
-                
135
-                <h3>Green Coffee Sales</h3>
136
-                
137
-                <h3>Inventory</h3>
138
-                
139
-                <p>Inventory reports present information on inventory.</p>
140
-                
141
-                <img src="inventoryreports.png" />
142
-                
143
-                <h3>Inventory Change Summary</h3>
144
-                <h3>Current Inventory and Availability Projection</h3>
145
-                <h3>Item Transactions</h3>
146
-                
147
-                <h2>Database Menu</h2>
148
-                <h3>Forget Connection Details</h3>
149
-                <p>This menu item can be used to force Typica to prompt for
150
-                database connection information the next time Typica is
151
-                opened.</p>
152
-                
153
-            </div>
154
-        </div>
155
-    </body>
156
-</html>

BIN
docs/documentation/windowreference/navigation.png View File


+ 0
- 38
docs/documentation/windowreference/openconfigurationfile.html View File

@@ -1,38 +0,0 @@
1
-<html>
2
-    <head>
3
-        <title>Typica - Open Configuration File</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" >Documentation</a>
18
-                    <a class="tab" href="../../screenshots.html" >Screenshots and Videos</a>
19
-                    <a href="http://appliedcoffeetechnology.tumblr.com/tagged/Typica" class="tab">Blog</a>
20
-                </div>
21
-            </div>
22
-            <div id="maintext">
23
-                <h1>Open Configuration File</h1>
24
-                <p>Most of Typica's appearance and functionality is controlled
25
-                by a set of configuration files. This documentation covers an
26
-                example configuration included with Typica. When prompted to
27
-                open a configuration file, select the config.xml file included
28
-                with Typica. When switching to a new version of Typica, it is
29
-                important to use the configuration file included with the new
30
-                version and not the old one. Opening that file will open the
31
-                <a href="navigation.html">main navigation window.</a></p>
32
-
33
-                <img src="openconfigurationfile.png"/>
34
-                
35
-            </div>
36
-        </div>
37
-    </body>
38
-</html>

BIN
docs/documentation/windowreference/openconfigurationfile.png View File


BIN
docs/documentation/windowreference/productionreports.png View File


BIN
docs/documentation/windowreference/purchasereports.png View File


BIN
docs/documentation/windowreference/reportsmenu.png View File


BIN
docs/documentation/windowreference/salesreport.png View File


+ 0
- 43
docs/documentation/windowreference/updateinventory.html View File

@@ -1,43 +0,0 @@
1
-<html>
2
-    <head>
3
-        <title>Typica - Update Inventory</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" >Documentation</a>
18
-                    <a class="tab" href="../../screenshots.html" >Screenshots and Videos</a>
19
-                    <a href="http://appliedcoffeetechnology.tumblr.com/tagged/Typica" class="tab">Blog</a>
20
-                </div>
21
-            </div>
22
-            <div id="maintext">
23
-                <h1>Update Inventory</h1>
24
-
25
-                <img src="inventorytransaction.png" />
26
-                
27
-                <p>The Update Inventory window allows the creation of two
28
-                different transaction types. An inentory transaction replaces
29
-                the amount of a specified green coffee in inventory with a
30
-                new value. This is mainly useful after roasting the last batch
31
-                from a bag of green coffee to set the inventory to a whole
32
-                number of bags.</p>
33
-
34
-                <img src="losstransaction.png" />
35
-
36
-                <p>A loss transaction subtracts the specified amount of a green
37
-                coffee from inventory and allows you to indicate a reason for
38
-                that loss.</p>
39
-
40
-            </div>
41
-        </div>
42
-    </body>
43
-</html>

+ 0
- 18
docs/logo.svg View File

@@ -1,18 +0,0 @@
1
-<?xml version="1.0" standalone="yes"?>
2
-<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN" "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">
3
-<svg xmlns="http://www.w3.org/2000/svg" version="1.1" viewbox="0 0 512 512" width="512px" height="512px">
4
-	<title>Typica application icon</title>
5
-	<defs>
6
-		<radialGradient id="orangeradial" gradientUnits="userSpaceOnUse" cx="288" cy="288" r="320" fx="320" fy="320" spreadMethod="pad">
7
-			<stop offset="0%" stop-color="orangered" />
8
-			<stop offset="100%" stop-color="white" />
9
-		</radialGradient>
10
-		<radialGradient id="flame" gradientUnits="userSpaceOnUse" cx="192" cy="320" r="224" fx="224" fy="352" spreadmethod="pad">
11
-			<stop offset="65%" stop-color="royalblue" />
12
-			<stop offset="100%" stop-color="aliceblue" />
13
-		</radialGradient>
14
-	</defs>
15
-	<path d="M416 32 L416 480 L32 480 L32 480 L32 96 A64 64 0 0 1 96 32 Z" stroke="orangered" stroke-width="1" fill="url(#orangeradial)" />
16
-	<path d="M32 384 L160 128 L480 288 L384 480 L32 480 Z" stroke="orangered" stroke-width="1" fill="aliceblue" />
17
-	<path d="M64 352 C64 448 352 448 352 352 Q352 320 288 256 C224 192 224 160 288 96 C192 96 64 288 64 352" stroke="royalblue" fill="url(#flame)" stroke-width="1" />
18
-</svg>

BIN
docs/logo96.png View File


+ 0
- 92
docs/style.css View File

@@ -1,92 +0,0 @@
1
-.active {
2
-	background-attachment: scroll;
3
-	background-clip: border-box;
4
-	background-color: rgb(255,255,255);
5
-	background-image: none;
6
-	background-origin: padding-box;
7
-	border-bottom-color: rgb(0,0,0);
8
-	border-bottom-style: none;
9
-	border-bottom-width: 0px;
10
-	border-left-color: rgb(107,144,218);
11
-	border-left-style: solid;
12
-	border-left-width: 1px;
13
-	border-right-color: rgb(107,144,218);
14
-	border-right-width: 1px;
15
-	border-right-style: solid;
16
-	border-top-color: rgb(107,144,218);
17
-	border-top-width: 2px;
18
-	border-top-style: solid;
19
-	color: rgb(0,0,0);
20
-	margin-left: 0px;
21
-	margin-right: 5px;
22
-	margin-top: 0px;
23
-	margin-bottom: -1px;
24
-	padding-bottom: 6px;
25
-	padding-left: 9px;
26
-	padding-right: 9px;
27
-	padding-top: 5px;
28
-	text-decoration: none;
29
-	white-space: nowrap;
30
-}
31
-.tab {
32
-	color: rgb(0,0,204);
33
-	margin-bottom: 6px;
34
-	margin-left:  10px;
35
-	margin-right: 15px;
36
-	margin-top: 5px;
37
-	padding-top: 5px;
38
-	white-space: nowrap;
39
-	text-decoration: none;
40
-}
41
-#menu {
42
-	background-color: rgb(235,239,249);
43
-	border-bottom-color: rgb(107,144,218);
44
-	border-bottom-style: solid;
45
-	border-bottom-width: 1px;
46
-	padding-bottom: 5px;
47
-	padding-left: 5px;
48
-	padding-right: 10px;
49
-	padding-top: 5px;
50
-	white-space: nowrap;
51
-	background-clip: border-box;
52
-}
53
-body {
54
-	background-color: rgb(235,239,249);
55
-}
56
-#page {
57
-	background-color: rgb(255,255,255);
58
-}
59
-h1 {
60
-	font-size: 24px;
61
-}
62
-#topbanner {
63
-	background-color: rgb(235,239,249);
64
-	height: 96px;
65
-	margin-bottom: 2px;
66
-}
67
-#topbanner img {
68
-	float: left;
69
-}
70
-#topbanner h1 {
71
-	padding-top: 20px;
72
-	padding-bottom: 0px;
73
-	margin-bottom: 0px;
74
-}
75
-h2 {
76
-	font-size: 20px;
77
-	padding-top: 0px;
78
-	padding-bottom: 0px;
79
-	margin-top: 0px;
80
-}
81
-#topmatter {
82
-	background-color: rgb(235,239,249);
83
-}
84
-#maintext {
85
-	margin-left: 10px;
86
-	margin-right: 10px;
87
-	padding-bottom: 10px;
88
-}
89
-li {
90
-	list-style-type: none;
91
-}
92
-

+ 0
- 8
web/build View File

@@ -1,8 +0,0 @@
1
-#!/bin/bash
2
-
3
-cp -r src/resources/* output/
4
-
5
-for f in src/pages/*.m4; do
6
-m4 src/template.m4 "$f" | sed '/^$/d' > output/"`basename -s .m4 "$f"`.html";
7
-done;
8
-

+ 0
- 57
web/output/download-mac-latest.html View File

@@ -1,57 +0,0 @@
1
-<html><head>
2
-	<title>Typica - Data for Coffee Roasters</title>
3
-	<link rel="stylesheet" type="text/css" href="style.css">
4
-	</head><body><div id="page"><div id="topmatter">
5
-	<div id="topbanner">
6
-	<img src="logo96.png" height="96px" width="96px" alt="Typica logo" />
7
-	<h1>Typica</h1><h2>Data for Coffee Roasters</h2></div>
8
-	<div id="menu">
9
-	<a class="tab " href="index.html">Typica</a>
10
-	<a class="tab " href="downloads.html">Downloads</a>
11
-	<a class="tab " href="documentation.html">Documentation</a>
12
-	<a class="tab " href="media.html">Photos and Videos</a>
13
-	<a class="tab" href="http://appliedcoffeetechnology.tumblr.com/tagged/Typica">Blog</a>
14
-	</div>
15
-	</div>
16
-	<div id="maintext">
17
-<h1>Thank you for downloading Typica.</h1>
18
-<p>Your download from:</p>
19
-<p><a href="http://www.randomfield.com/programs/typica/1.7/Typica-1.7.dmg">http://www.randomfield.com/programs/typica/1.7/Typica-1.7.dmg</a></p>
20
-<p>should begin automatically. If it does not,
21
-please click the above link.</p>
22
-<h2>Please Help Support Ongoing Development</h2>
23
-<p>While Typica is free and will continue to be made freely
24
-available complete with all source code, there are still costs
25
-associated with ongoing development and keeping the software
26
-available. Some of the costs include:
27
-	<ul>
28
-		<li>Obtaining and maintaining hardware appropriate for
29
-		building and testing new releases</li>
30
-		<li>Building and maintaining test rigs for various
31
-		types of data acquisition hardware</li>
32
-		<li>Maintaining the ability to test on new operating
33
-		system releases</li>
34
-		<li>Hosting service</li>
35
-	</ul>
36
-There is also a huge commitment of time in developing, testing,
37
-and supporting this.</p>
38
-<p>While Typica is for many uses a mature and reliable program,
39
-there are still a number of areas where the program can be
40
-improved and additional areas where I think it makes a lot of
41
-sense to extend the program. The limited funding for this work
42
-does slow progress. If you're finding this software to be useful
43
-in your business, if you've had a good support experience, or if
44
-you'd like to help me continue to develop this software, please
45
-consider providing some financial support. Checks can be sent to:
46
-<p>Neal Wilson<br />
47
-c/o Wilson's Coffee &amp; Tea<br />
48
-3306 Washington Ave.<br />
49
-Racine, WI 53405<br />
50
-USA</p>
51
-<p>or you can visit my <a href="http://youtube.com/users/N3Roaster">YouTube
52
-channel</a> and click the blue Support button on the right.</p>
53
-<p>Another great way to help Typica right now is to reach out
54
-to your professional colleagues and let them know that you're
55
-using Typica and what you like about it.</p>
56
-<iframe width="1" height="1" frameborder="0" src="http://www.randomfield.com/programs/typica/1.7/Typica-1.7.dmg"></iframe>
57
-</div></div></body></html>

+ 0
- 57
web/output/download-windows-latest.html View File

@@ -1,57 +0,0 @@
1
-<html><head>
2
-	<title>Typica - Data for Coffee Roasters</title>
3
-	<link rel="stylesheet" type="text/css" href="style.css">
4
-	</head><body><div id="page"><div id="topmatter">
5
-	<div id="topbanner">
6
-	<img src="logo96.png" height="96px" width="96px" alt="Typica logo" />
7
-	<h1>Typica</h1><h2>Data for Coffee Roasters</h2></div>
8
-	<div id="menu">
9
-	<a class="tab " href="index.html">Typica</a>
10
-	<a class="tab " href="downloads.html">Downloads</a>
11
-	<a class="tab " href="documentation.html">Documentation</a>
12
-	<a class="tab " href="media.html">Photos and Videos</a>
13
-	<a class="tab" href="http://appliedcoffeetechnology.tumblr.com/tagged/Typica">Blog</a>
14
-	</div>
15
-	</div>
16
-	<div id="maintext">
17
-<h1>Thank you for downloading Typica.</h1>
18
-<p>Your download from:</p>
19
-<p><a href="http://www.randomfield.com/programs/typica/1.7/Typica-1.7.zip">http://www.randomfield.com/programs/typica/1.7/Typica-1.7.zip</a></p>
20
-<p>should begin automatically. If it does not,
21
-please click the above link.</p>
22
-<h2>Please Help Support Ongoing Development</h2>
23
-<p>While Typica is free and will continue to be made freely
24
-available complete with all source code, there are still costs
25
-associated with ongoing development and keeping the software
26
-available. Some of the costs include:
27
-	<ul>
28
-		<li>Obtaining and maintaining hardware appropriate for
29
-		building and testing new releases</li>
30
-		<li>Building and maintaining test rigs for various
31
-		types of data acquisition hardware</li>
32
-		<li>Maintaining the ability to test on new operating
33
-		system releases</li>
34
-		<li>Hosting service</li>
35
-	</ul>
36
-There is also a huge commitment of time in developing, testing,
37
-and supporting this.</p>
38
-<p>While Typica is for many uses a mature and reliable program,
39
-there are still a number of areas where the program can be
40
-improved and additional areas where I think it makes a lot of
41
-sense to extend the program. The limited funding for this work
42
-does slow progress. If you're finding this software to be useful
43
-in your business, if you've had a good support experience, or if
44
-you'd like to help me continue to develop this software, please
45
-consider providing some financial support. Checks can be sent to:
46
-<p>Neal Wilson<br />
47
-c/o Wilson's Coffee &amp; Tea<br />
48
-3306 Washington Ave.<br />
49
-Racine, WI 53405<br />
50
-USA</p>
51
-<p>or you can visit my <a href="http://youtube.com/users/N3Roaster">YouTube
52
-channel</a> and click the blue Support button on the right.</p>
53
-<p>Another great way to help Typica right now is to reach out
54
-to your professional colleagues and let them know that you're
55
-using Typica and what you like about it.</p>
56
-<iframe width="1" height="1" frameborder="0" src="http://www.randomfield.com/programs/typica/1.7/Typica-1.7.zip"></iframe>
57
-</div></div></body></html>

+ 0
- 23
web/output/downloads.html View File

@@ -1,23 +0,0 @@
1
-<html><head>
2
-	<title>Typica - Data for Coffee Roasters</title>
3
-	<link rel="stylesheet" type="text/css" href="style.css">
4
-	</head><body><div id="page"><div id="topmatter">
5
-	<div id="topbanner">
6
-	<img src="logo96.png" height="96px" width="96px" alt="Typica logo" />
7
-	<h1>Typica</h1><h2>Data for Coffee Roasters</h2></div>
8
-	<div id="menu">
9
-	<a class="tab " href="index.html">Typica</a>
10
-	<a class="tab active">Downloads</a>
11
-	<a class="tab " href="documentation.html">Documentation</a>
12
-	<a class="tab " href="media.html">Photos and Videos</a>
13
-	<a class="tab" href="http://appliedcoffeetechnology.tumblr.com/tagged/Typica">Blog</a>
14
-	</div>
15
-	</div>
16
-	<div id="maintext">
17
-<p>The latest release of Typica is version 1.7, released January 24, 2016.
18
-This is available for Microsoft Windows, and Intel/Mac OS X.</p>
19
-<p><a href="download-mac-latest.html">Typica 1.7 for Intel/Mac OS X</a></p>
20
-<p><a href="download-windows-latest.html">Typica 1.7 for Microsoft Windows</a></p>
21
-<p>The latest source code can always be found on
22
-<a href="https://github.com/N3Roaster/typica">GitHub</a>.</p>
23
-</div></div></body></html>

+ 0
- 64
web/output/index.html View File

@@ -1,64 +0,0 @@
1
-<html><head>
2
-	<title>Typica - Data for Coffee Roasters</title>
3
-	<link rel="stylesheet" type="text/css" href="style.css">
4
-	</head><body><div id="page"><div id="topmatter">
5
-	<div id="topbanner">
6
-	<img src="logo96.png" height="96px" width="96px" alt="Typica logo" />
7
-	<h1>Typica</h1><h2>Data for Coffee Roasters</h2></div>
8
-	<div id="menu">
9
-	<a class="tab active">Typica</a>
10
-	<a class="tab " href="downloads.html">Downloads</a>
11
-	<a class="tab " href="documentation.html">Documentation</a>
12
-	<a class="tab " href="media.html">Photos and Videos</a>
13
-	<a class="tab" href="http://appliedcoffeetechnology.tumblr.com/tagged/Typica">Blog</a>
14
-	</div>
15
-	</div>
16
-	<div id="maintext">
17
-<p>Typica is a cross-platform application for coffee roasters
18
-with features for recording your roasts, tracking green coffee
19
-inventory, product development, improving production consistency,
20
-and more.</p>
21
-<p>The program is free open source software available under the
22
-MIT license.</p>
23
-<h1>Typica 1.7 Now Available</h1>
24
-<iframe width="640" height="360" src="https://www.youtube.com/embed/U7xTefVLRfk" frameborder="0" allowfullscreen></iframe>
25
-<p>The latest release of Typica includes several new features
26
-such as support for more detailed roast specifications, ability
27
-to set reminders based on production, a new batch log with search
28
-and filter features, and more. This also marks the first release
29
-that includes a translation of the program to another language.
30
-People using a computer with German locale settings will see that.</p>
31
-<p>The following video goes over some of the most useful changes
32
-that were introduced in Typica 1.7 and how to use those.</p>
33
-<iframe width="640" height="360" src="https://www.youtube.com/embed/na6_ny0PaIA" frameborder="0" allowfullscreen></iframe>
34
-<h1>Data Acquisition</h1>
35
-<p>Every batch of coffee you roast with Typica can be recorded for
36
-future reference. A practically unlimited number of target roast
37
-profiles can be created for reference against future roasts. Log
38
-annotations capture events of interest and aid in profile design.
39
-Compatable with several different data acquisition devices.</p>
40
-<h1>Inventory Tracking</h1>
41
-<p>Keep track of your green coffee inventory automatically as you
42
-roast it. Reports provide the data you need to see your production
43
-trends and plan your green coffee purchases.</p>
44
-<h1>Your Data Your Way</h1>
45
-<p>Typica stores its data in a PostgreSQL database. The database
46
-can be set up on the computer running Typica or on another computer
47
-on the network. You keep full control of your data and never need
48
-to pay another company for continued access to your data. The use
49
-of PostgreSQL provides additional ways to gain insight from your
50
-data including integration with all major spreadsheet applications
51
-through the PostgreSQL ODBC or JDBC drivers.</p>
52
-<h1>Total Customizability</h1>
53
-<p>Typica provides a versatile configuration system which can be
54
-used to extend or modify Typica for better integration with your
55
-work flows. If this is inadequate for your customization needs, the
56
-fully documented C++ source code is also freely available. An
57
-example configuration is provided which aims to provide something
58
-that most will not need to modify, but the option is always there
59
-if you need it.</p>
60
-<h1>Never Miss a Release</h1>
61
-<p>Sign up for the <a href="https://tinyletter.com/Typica">Typica
62
-News mailing list</a> to get email when a new version of Typica
63
-is available.</p>
64
-</div></div></body></html>

+ 0
- 18
web/output/logo.svg View File

@@ -1,18 +0,0 @@
1
-<?xml version="1.0" standalone="yes"?>
2
-<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN" "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">
3
-<svg xmlns="http://www.w3.org/2000/svg" version="1.1" viewbox="0 0 512 512" width="512px" height="512px">
4
-	<title>Typica application icon</title>
5
-	<defs>
6
-		<radialGradient id="orangeradial" gradientUnits="userSpaceOnUse" cx="288" cy="288" r="320" fx="320" fy="320" spreadMethod="pad">
7
-			<stop offset="0%" stop-color="orangered" />
8
-			<stop offset="100%" stop-color="white" />
9
-		</radialGradient>
10
-		<radialGradient id="flame" gradientUnits="userSpaceOnUse" cx="192" cy="320" r="224" fx="224" fy="352" spreadmethod="pad">
11
-			<stop offset="65%" stop-color="royalblue" />
12
-			<stop offset="100%" stop-color="aliceblue" />
13
-		</radialGradient>
14
-	</defs>
15
-	<path d="M416 32 L416 480 L32 480 L32 480 L32 96 A64 64 0 0 1 96 32 Z" stroke="orangered" stroke-width="1" fill="url(#orangeradial)" />
16
-	<path d="M32 384 L160 128 L480 288 L384 480 L32 480 Z" stroke="orangered" stroke-width="1" fill="aliceblue" />
17
-	<path d="M64 352 C64 448 352 448 352 352 Q352 320 288 256 C224 192 224 160 288 96 C192 96 64 288 64 352" stroke="royalblue" fill="url(#flame)" stroke-width="1" />
18
-</svg>

BIN
web/output/logo96.png View File


+ 0
- 89
web/output/media.html View File

@@ -1,89 +0,0 @@
1
-<html><head>
2
-	<title>Typica - Data for Coffee Roasters</title>
3
-	<link rel="stylesheet" type="text/css" href="style.css">
4
-	</head><body><div id="page"><div id="topmatter">
5
-	<div id="topbanner">
6
-	<img src="logo96.png" height="96px" width="96px" alt="Typica logo" />
7
-	<h1>Typica</h1><h2>Data for Coffee Roasters</h2></div>
8
-	<div id="menu">
9
-	<a class="tab " href="index.html">Typica</a>
10
-	<a class="tab " href="downloads.html">Downloads</a>
11
-	<a class="tab " href="documentation.html">Documentation</a>
12
-	<a class="tab active">Photos and Videos</a>
13
-	<a class="tab" href="http://appliedcoffeetechnology.tumblr.com/tagged/Typica">Blog</a>
14
-	</div>
15
-	</div>
16
-	<div id="maintext">
17
-<div class="screenshot_item">
18
-	<div class="item">
19
-		<img src="photos/resized/tumblr_mklwvnP9141qfwu90o1_1280.jpg" />
20
-	</div>
21
-	<div class="description">
22
-		<p>I have a YM-10 Ambex hooked into a NI-9211A feeding to an old
23
-		Mac. Works great for me!"</p>
24
-		<p class="credit">Frank</p>
25
-	</div>
26
-</div>
27
-<div class="screenshot_item">
28
-	<div class="item">
29
-		<img src="photos/resized/C-20121115-00003.jpg" />
30
-	</div>
31
-	<div class="description">
32
-		<p>Behmor 1600 with Typica. Here is a shot from a side project that was requested by a home roaster customer. A few modifications allowed a 6 inch J thermocouple to be inserted into the drum.</p>
33
-		<p class="credit">Photo by Mario Champignon, T.A.N. Coffee</p>
34
-	</div>
35
-</div>
36
-<div class="screenshot_item">
37
-	<div class="item">
38
-		<img src="photos/resized/WP_20130303_003.jpg" />
39
-	</div>
40
-	<div class="description">
41
-		<p>Sunny Sunday in Stafford, UK - roasting some blend matches on a 1 Kg Toper sample roaster with the NI USB TC01, listening to Dire Straits on Spotify. Took all of 3 minutes to connect up the thermocouple and away it went. Admire the modular nature of the programming behind it, allowing for customization for different roasters. Have put PostgreSQL on a central server and will be connecting up main roaster so I can spline and convert to large roaster profile. Epic.</p>
42
-	</div>
43
-</div>
44
-<div class="screenshot_item">
45
-	<div class="item">
46
-		<img src="photos/resized/2012-11-09_11.00.22.jpg" />
47
-	</div>
48
-	<div class="description">
49
-		<p>Some work spaces do not have adequate space for a computer that can easily be used at the roaster. A touch screen mounted near the front of this Diedrich IR-1 allows Typica to be used with less table space at the machine than a laptop computer would require.</p>
50
-		<p class="credit">Photo by Neal Wilson, Wilson's Coffee &amp; Tea</p>
51
-	</div>
52
-</div>
53
-<div class="screenshot_item">
54
-	<div class="item">
55
-		<iframe width="560" height="315" src="http://www.youtube.com/embed/EXPjLgCoUWU" frameborder="0" allowfullscreen></iframe>
56
-	</div>
57
-	<div class="description">
58
-		<p>Video demonstration of connecting a coffee roaster to data acquisition hardware for use with Typica.<p>
59
-		<p class="credit">Video by Neal Wilson, Wilson's Coffee &amp; Tea</p>
60
-	</div>
61
-</div>
62
-<div class="screenshot_item">
63
-	<div class="item">
64
-		<iframe width="560" height="315" src="http://www.youtube.com/embed/sct2FWVkmDw" frameborder="0" allowfullscreen></iframe>
65
-	</div>
66
-	<div class="description">
67
-		<p>Video demonstration of one way to use Typica to assist in developing a roast profile for a coffee.</p>
68
-		<p class="credit">Video by Neal Wilson, Wilson's Coffee &amp; Tea</p>
69
-	</div>
70
-</div>
71
-<div class="screenshot_item">
72
-	<div class="item">
73
-		<iframe width="560" height="315" src="http://www.youtube.com/embed/hS0SfzypyFQ" frameborder="0" allowfullscreen></iframe>
74
-	</div>
75
-	<div class="description">
76
-		<p>Video explanation of the reasoning behind Typica's roast profile translation feature.</p>
77
-		<p class="credit">Video by Neal Wilson, Wilson's Coffee &amp; Tea</p>
78
-	</div>
79
-</div>
80
-<div class="screenshot_item">
81
-	<div class="item">
82
-		<iframe width="560" height="315" src="http://www.youtube.com/embed/fS6eSKL8tlA" frameborder="0" allowfullscreen></iframe>
83
-	</div>
84
-	<div class="description">
85
-		<p>A fixed measurement offset is a common feature in data acquisition software, but I have never encountered a coffee roaster where measurement error followed so simple a pattern. This video covers the use of Typica's linear spline interpolated series feature to simplify matching roast profiles on different machines where the difference in measured values between the machines varies in a non-linear manner throughout the range of roasting temperatures. Includes instructions on collecting calibration data and setting up Typica to produce an appropriate calibrated data series.</p>
86
-		<p class="credit">Video by Neal Wilson, Wilson's Coffee &amp; Tea</p>
87
-	</div>
88
-</div>
89
-</div></div></body></html>

BIN
web/output/photos/original/2012-11-09_11.00.22.jpg View File


BIN
web/output/photos/original/C-20121115-00003.jpg View File


BIN
web/output/photos/original/WP_20130303_003.jpg View File


BIN
web/output/photos/original/tumblr_mklwvnP9141qfwu90o1_1280.jpg View File


BIN
web/output/photos/resized/2012-11-09_11.00.22.jpg View File


BIN
web/output/photos/resized/C-20121115-00003.jpg View File


BIN
web/output/photos/resized/WP_20130303_003.jpg View File


BIN
web/output/photos/resized/tumblr_mklwvnP9141qfwu90o1_1280.jpg View File


BIN
web/output/release164tc.png View File


+ 0
- 110
web/output/style.css View File

@@ -1,110 +0,0 @@
1
-.active {
2
-	background-attachment: scroll;
3
-	background-clip: border-box;
4
-	background-color: rgb(255,255,255);
5
-	background-image: none;
6
-	background-origin: padding-box;
7
-	border-bottom-color: rgb(0,0,0);
8
-	border-bottom-style: none;
9
-	border-bottom-width: 0px;
10
-	border-left-color: rgb(107,144,218);
11
-	border-left-style: solid;
12
-	border-left-width: 1px;
13
-	border-right-color: rgb(107,144,218);
14
-	border-right-width: 1px;
15
-	border-right-style: solid;
16
-	border-top-color: rgb(107,144,218);
17
-	border-top-width: 2px;
18
-	border-top-style: solid;
19
-	color: rgb(0,0,0);
20
-	margin-left: 0px;
21
-	margin-right: 5px;
22
-	margin-top: 0px;
23
-	margin-bottom: -1px;
24
-	padding-bottom: 6px;
25
-	padding-left: 9px;
26
-	padding-right: 9px;
27
-	padding-top: 5px;
28
-	text-decoration: none;
29
-	white-space: nowrap;
30
-}
31
-.tab {
32
-	color: rgb(0,0,204);
33
-	margin-bottom: 6px;
34
-	margin-left:  10px;
35
-	margin-right: 15px;
36
-	margin-top: 5px;
37
-	padding-top: 5px;
38
-	white-space: nowrap;
39
-	text-decoration: none;
40
-}
41
-#menu {
42
-	background-color: rgb(235,239,249);
43
-	border-bottom-color: rgb(107,144,218);
44
-	border-bottom-style: solid;
45
-	border-bottom-width: 1px;
46
-	padding-bottom: 5px;
47
-	padding-left: 5px;
48
-	padding-right: 10px;
49
-	padding-top: 5px;
50
-	white-space: nowrap;
51
-	background-clip: border-box;
52
-}
53
-body {
54
-	background-color: rgb(235,239,249);
55
-}
56
-#page {
57
-	background-color: rgb(255,255,255);
58
-}
59
-h1 {
60
-	font-size: 24px;
61
-}
62
-#topbanner {
63
-	background-color: rgb(235,239,249);
64
-	height: 96px;
65
-	margin-bottom: 2px;
66
-}
67
-#topbanner img {
68
-	float: left;
69
-}
70
-#topbanner h1 {
71
-	padding-top: 20px;
72
-	padding-bottom: 0px;
73
-	margin-bottom: 0px;
74
-}
75
-h2 {
76
-	font-size: 20px;
77
-	padding-top: 0px;
78
-	padding-bottom: 0px;
79
-	margin-top: 0px;
80
-}
81
-#topmatter {
82
-	background-color: rgb(235,239,249);
83
-}
84
-#maintext {
85
-	margin-left: 10px;
86
-	margin-right: 10px;
87
-	padding-bottom: 10px;
88
-}
89
-li {
90
-	list-style-type: none;
91
-}
92
-.screenshot_item {
93
-	display: table;
94
-	#position: relative;
95
-	overflow: hidden;
96
-}
97
-.screenshot_item .item {
98
-	float: left;
99
-	padding: 5px;
100
-	margin: 5px;
101
-}
102
-.screenshot_item .description {
103
-	#position: absolute;
104
-	#top: 50%;
105
-	display: table-cell;
106
-	vertical-align: middle;
107
-}
108
-.credit {
109
-	font-style: italic;
110
-}

+ 0
- 5
web/src/pages/download-mac-latest.m4 View File

@@ -1,5 +0,0 @@
1
-__PageStart
2
-
3
-__DownloadPage(`http://www.randomfield.com/programs/typica/1.7/Typica-1.7.dmg')
4
-
5
-__PageEnd

+ 0
- 5
web/src/pages/download-windows-latest.m4 View File

@@ -1,5 +0,0 @@
1
-__PageStart
2
-
3
-__DownloadPage(`http://www.randomfield.com/programs/typica/1.7/Typica-1.7.zip')
4
-
5
-__PageEnd

+ 0
- 14
web/src/pages/downloads.m4 View File

@@ -1,14 +0,0 @@
1
-define(`__PageType', `Downloads')
2
-
3
-__PageStart
4
-
5
-<p>The latest release of Typica is version 1.7, released January 24, 2016.
6
-This is available for Microsoft Windows, and Intel/Mac OS X.</p>
7
-
8
-<p><a href="download-mac-latest.html">Typica 1.7 for Intel/Mac OS X</a></p>
9
-<p><a href="download-windows-latest.html">Typica 1.7 for Microsoft Windows</a></p>
10
-
11
-<p>The latest source code can always be found on
12
-<a href="https://github.com/N3Roaster/typica">GitHub</a>.</p>
13
-
14
-__PageEnd

+ 0
- 46
web/src/pages/fragments/downloadfragment.m4 View File

@@ -1,46 +0,0 @@
1
-<h1>Thank you for downloading Typica.</h1>
2
-<p>Your download from:</p>
3
-<p><a href="__DownloadUrl">__DownloadUrl</a></p>
4
-<p>should begin automatically. If it does not,
5
-please click the above link.</p>
6
-<h2>Please Help Support Ongoing Development</h2>
7
-
8
-<p>While Typica is free and will continue to be made freely
9
-available complete with all source code, there are still costs
10
-associated with ongoing development and keeping the software
11
-available. Some of the costs include:
12
-	<ul>
13
-		<li>Obtaining and maintaining hardware appropriate for
14
-		building and testing new releases</li>
15
-		<li>Building and maintaining test rigs for various
16
-		types of data acquisition hardware</li>
17
-		<li>Maintaining the ability to test on new operating
18
-		system releases</li>
19
-		<li>Hosting service</li>
20
-	</ul>
21
-There is also a huge commitment of time in developing, testing,
22
-and supporting this.</p>
23
-
24
-<p>While Typica is for many uses a mature and reliable program,
25
-there are still a number of areas where the program can be
26
-improved and additional areas where I think it makes a lot of
27
-sense to extend the program. The limited funding for this work
28
-does slow progress. If you're finding this software to be useful
29
-in your business, if you've had a good support experience, or if
30
-you'd like to help me continue to develop this software, please
31
-consider providing some financial support. Checks can be sent to:
32
-
33
-<p>Neal Wilson<br />
34
-c/o Wilson's Coffee &amp; Tea<br />
35
-3306 Washington Ave.<br />
36
-Racine, WI 53405<br />
37
-USA</p>
38
-
39
-<p>or you can visit my <a href="http://youtube.com/users/N3Roaster">YouTube
40
-channel</a> and click the blue Support button on the right.</p>
41
-
42
-<p>Another great way to help Typica right now is to reach out
43
-to your professional colleagues and let them know that you're
44
-using Typica and what you like about it.</p>
45
-
46
-<iframe width="1" height="1" frameborder="0" src="__DownloadUrl"></iframe>

+ 0
- 60
web/src/pages/index.m4 View File

@@ -1,60 +0,0 @@
1
-define(`__PageType', `Main')
2
-
3
-__PageStart
4
-
5
-<p>Typica is a cross-platform application for coffee roasters
6
-with features for recording your roasts, tracking green coffee
7
-inventory, product development, improving production consistency,
8
-and more.</p>
9
-<p>The program is free open source software available under the
10
-MIT license.</p>
11
-
12
-<h1>Typica 1.7 Now Available</h1>
13
-
14
-<iframe width="640" height="360" src="https://www.youtube.com/embed/U7xTefVLRfk" frameborder="0" allowfullscreen></iframe>
15
-
16
-<p>The latest release of Typica includes several new features
17
-such as support for more detailed roast specifications, ability
18
-to set reminders based on production, a new batch log with search
19
-and filter features, and more. This also marks the first release
20
-that includes a translation of the program to another language.
21
-People using a computer with German locale settings will see that.</p>
22
-
23
-<p>The following video goes over some of the most useful changes
24
-that were introduced in Typica 1.7 and how to use those.</p>
25
-
26
-<iframe width="640" height="360" src="https://www.youtube.com/embed/na6_ny0PaIA" frameborder="0" allowfullscreen></iframe>
27
-
28
-<h1>Data Acquisition</h1>
29
-<p>Every batch of coffee you roast with Typica can be recorded for
30
-future reference. A practically unlimited number of target roast
31
-profiles can be created for reference against future roasts. Log
32
-annotations capture events of interest and aid in profile design.
33
-Compatable with several different data acquisition devices.</p>
34
-<h1>Inventory Tracking</h1>
35
-<p>Keep track of your green coffee inventory automatically as you
36
-roast it. Reports provide the data you need to see your production
37
-trends and plan your green coffee purchases.</p>
38
-<h1>Your Data Your Way</h1>
39
-<p>Typica stores its data in a PostgreSQL database. The database
40
-can be set up on the computer running Typica or on another computer
41
-on the network. You keep full control of your data and never need
42
-to pay another company for continued access to your data. The use
43
-of PostgreSQL provides additional ways to gain insight from your
44
-data including integration with all major spreadsheet applications
45
-through the PostgreSQL ODBC or JDBC drivers.</p>
46
-<h1>Total Customizability</h1>
47
-<p>Typica provides a versatile configuration system which can be
48
-used to extend or modify Typica for better integration with your
49
-work flows. If this is inadequate for your customization needs, the
50
-fully documented C++ source code is also freely available. An
51
-example configuration is provided which aims to provide something
52
-that most will not need to modify, but the option is always there
53
-if you need it.</p>
54
-
55
-<h1>Never Miss a Release</h1>
56
-<p>Sign up for the <a href="https://tinyletter.com/Typica">Typica
57
-News mailing list</a> to get email when a new version of Typica
58
-is available.</p>
59
-
60
-__PageEnd

+ 0
- 78
web/src/pages/media.m4 View File

@@ -1,78 +0,0 @@
1
-define(`__PageType', `Media')
2
-
3
-__PageStart
4
-
5
-<div class="screenshot_item">
6
-	<div class="item">
7
-		<img src="photos/resized/tumblr_mklwvnP9141qfwu90o1_1280.jpg" />
8
-	</div>
9
-	<div class="description">
10
-		<p>I have a YM-10 Ambex hooked into a NI-9211A feeding to an old
11
-		Mac. Works great for me!"</p>
12
-		<p class="credit">Frank</p>
13
-	</div>
14
-</div>
15
-<div class="screenshot_item">
16
-	<div class="item">
17
-		<img src="photos/resized/C-20121115-00003.jpg" />
18
-	</div>
19
-	<div class="description">
20
-		<p>Behmor 1600 with Typica. Here is a shot from a side project that was requested by a home roaster customer. A few modifications allowed a 6 inch J thermocouple to be inserted into the drum.</p>
21
-		<p class="credit">Photo by Mario Champignon, T.A.N. Coffee</p>
22
-	</div>
23
-</div>
24
-<div class="screenshot_item">
25
-	<div class="item">
26
-		<img src="photos/resized/WP_20130303_003.jpg" />
27
-	</div>
28
-	<div class="description">
29
-		<p>Sunny Sunday in Stafford, UK - roasting some blend matches on a 1 Kg Toper sample roaster with the NI USB TC01, listening to Dire Straits on Spotify. Took all of 3 minutes to connect up the thermocouple and away it went. Admire the modular nature of the programming behind it, allowing for customization for different roasters. Have put PostgreSQL on a central server and will be connecting up main roaster so I can spline and convert to large roaster profile. Epic.</p>
30
-	</div>
31
-</div>
32
-<div class="screenshot_item">
33
-	<div class="item">
34
-		<img src="photos/resized/2012-11-09_11.00.22.jpg" />
35
-	</div>
36
-	<div class="description">
37
-		<p>Some work spaces do not have adequate space for a computer that can easily be used at the roaster. A touch screen mounted near the front of this Diedrich IR-1 allows Typica to be used with less table space at the machine than a laptop computer would require.</p>
38
-		<p class="credit">Photo by Neal Wilson, Wilson's Coffee &amp; Tea</p>
39
-	</div>
40
-</div>
41
-<div class="screenshot_item">
42
-	<div class="item">
43
-		<iframe width="560" height="315" src="http://www.youtube.com/embed/EXPjLgCoUWU" frameborder="0" allowfullscreen></iframe>
44
-	</div>
45
-	<div class="description">
46
-		<p>Video demonstration of connecting a coffee roaster to data acquisition hardware for use with Typica.<p>
47
-		<p class="credit">Video by Neal Wilson, Wilson's Coffee &amp; Tea</p>
48
-	</div>
49
-</div>
50
-<div class="screenshot_item">
51
-	<div class="item">
52
-		<iframe width="560" height="315" src="http://www.youtube.com/embed/sct2FWVkmDw" frameborder="0" allowfullscreen></iframe>
53
-	</div>
54
-	<div class="description">
55
-		<p>Video demonstration of one way to use Typica to assist in developing a roast profile for a coffee.</p>
56
-		<p class="credit">Video by Neal Wilson, Wilson's Coffee &amp; Tea</p>
57
-	</div>
58
-</div>
59
-<div class="screenshot_item">
60
-	<div class="item">
61
-		<iframe width="560" height="315" src="http://www.youtube.com/embed/hS0SfzypyFQ" frameborder="0" allowfullscreen></iframe>
62
-	</div>
63
-	<div class="description">
64
-		<p>Video explanation of the reasoning behind Typica's roast profile translation feature.</p>
65
-		<p class="credit">Video by Neal Wilson, Wilson's Coffee &amp; Tea</p>
66
-	</div>
67
-</div>
68
-<div class="screenshot_item">
69
-	<div class="item">
70
-		<iframe width="560" height="315" src="http://www.youtube.com/embed/fS6eSKL8tlA" frameborder="0" allowfullscreen></iframe>
71
-	</div>
72
-	<div class="description">
73
-		<p>A fixed measurement offset is a common feature in data acquisition software, but I have never encountered a coffee roaster where measurement error followed so simple a pattern. This video covers the use of Typica's linear spline interpolated series feature to simplify matching roast profiles on different machines where the difference in measured values between the machines varies in a non-linear manner throughout the range of roasting temperatures. Includes instructions on collecting calibration data and setting up Typica to produce an appropriate calibrated data series.</p>
74
-		<p class="credit">Video by Neal Wilson, Wilson's Coffee &amp; Tea</p>
75
-	</div>
76
-</div>
77
-
78
-__PageEnd

+ 0
- 18
web/src/resources/logo.svg View File

@@ -1,18 +0,0 @@
1
-<?xml version="1.0" standalone="yes"?>
2
-<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN" "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">
3
-<svg xmlns="http://www.w3.org/2000/svg" version="1.1" viewbox="0 0 512 512" width="512px" height="512px">
4
-	<title>Typica application icon</title>
5
-	<defs>
6
-		<radialGradient id="orangeradial" gradientUnits="userSpaceOnUse" cx="288" cy="288" r="320" fx="320" fy="320" spreadMethod="pad">
7
-			<stop offset="0%" stop-color="orangered" />
8
-			<stop offset="100%" stop-color="white" />
9
-		</radialGradient>
10
-		<radialGradient id="flame" gradientUnits="userSpaceOnUse" cx="192" cy="320" r="224" fx="224" fy="352" spreadmethod="pad">
11
-			<stop offset="65%" stop-color="royalblue" />
12
-			<stop offset="100%" stop-color="aliceblue" />
13
-		</radialGradient>
14
-	</defs>
15
-	<path d="M416 32 L416 480 L32 480 L32 480 L32 96 A64 64 0 0 1 96 32 Z" stroke="orangered" stroke-width="1" fill="url(#orangeradial)" />
16
-	<path d="M32 384 L160 128 L480 288 L384 480 L32 480 Z" stroke="orangered" stroke-width="1" fill="aliceblue" />
17
-	<path d="M64 352 C64 448 352 448 352 352 Q352 320 288 256 C224 192 224 160 288 96 C192 96 64 288 64 352" stroke="royalblue" fill="url(#flame)" stroke-width="1" />
18
-</svg>

BIN
web/src/resources/logo96.png View File


BIN
web/src/resources/photos/original/2012-11-09_11.00.22.jpg View File


BIN
web/src/resources/photos/original/C-20121115-00003.jpg View File


BIN
web/src/resources/photos/original/WP_20130303_003.jpg View File


BIN
web/src/resources/photos/original/tumblr_mklwvnP9141qfwu90o1_1280.jpg View File


BIN
web/src/resources/photos/resized/2012-11-09_11.00.22.jpg View File


BIN
web/src/resources/photos/resized/C-20121115-00003.jpg View File


BIN
web/src/resources/photos/resized/WP_20130303_003.jpg View File


+ 0
- 0
web/src/resources/photos/resized/tumblr_mklwvnP9141qfwu90o1_1280.jpg View File


Some files were not shown because too many files changed in this diff

Loading…
Cancel
Save