Pārlūkot izejas kodu

Documentation for database connection settings window.

Neal Wilson 10 gadus atpakaļ
vecāks
revīzija
45fceacebd

+ 3
- 3
docs/documentation/part2.html Parādīt failu

@@ -27,9 +27,9 @@
27 27
 				<ul>
28 28
 					<li><a href="part2/application.html">Opening the Application</a></li>
29 29
 					<ul>
30
-						<li>Database Connection Settings</a></li>
31
-						<li>Open Configuration File</a></li>
32
-						<li>Choose Your Path</a></li>
30
+						<li><a href="part2/database-connection.html">Database Connection Settings</a></li>
31
+						<li><a>Open Configuration File</a></li>
32
+						<li><a>Choose Your Path</a></li>
33 33
 					</ul>
34 34
 					<li><a>Configure Roasters</a></li>
35 35
 					<li><a>Roast Coffee</a></li>

+ 1
- 1
docs/documentation/part2/application.html Parādīt failu

@@ -35,7 +35,7 @@ are using.
35 35
 				<h1>What Happens Next?</h1>
36 36
 				<p>When Typica starts, it will bring up one of three windows.<p>
37 37
 				<ul>
38
-					<li><a>Database Connection Settings</a></li>
38
+					<li><a href="database-connection.html">Database Connection Settings</a></li>
39 39
 					<li><a>Open Configuration File</a></li>
40 40
 					<li><a>Choose Your Path</a></li>
41 41
 				</ul>

+ 47
- 0
docs/documentation/part2/database-connection.html Parādīt failu

@@ -0,0 +1,47 @@
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>Open Configuration File</a></li>
42
+					<li><a>Choose Your Path</a></li>
43
+				</ul>
44
+			</div>
45
+		</div>
46
+	</body>
47
+</html>

Binārs
docs/documentation/part2/images/database-settings.png Parādīt failu


Notiek ielāde…
Atcelt
Saglabāt