projects / web/konrad/smoke.git / commitdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw | patch (parent: 3af883c)
some minor enhancements in docu;
authorkonrad <konrad@6e3c4bff-ac9f-4ac1-96c5-d2ea494d3e33>
Tue, 1 Mar 2011 07:56:56 +0000 (07:56 +0000)
committerkonrad <konrad@6e3c4bff-ac9f-4ac1-96c5-d2ea494d3e33>
Tue, 1 Mar 2011 07:56:56 +0000 (07:56 +0000)
add basic structure for client docu

git-svn-id: https://silmor.de/svn/softmagic/smoke/trunk@742 6e3c4bff-ac9f-4ac1-96c5-d2ea494d3e33

doc/client/concepts.html [new file with mode: 0644] patch | blob
doc/client/config.html [new file with mode: 0644] patch | blob
doc/client/index.html [new file with mode: 0644] patch | blob
doc/index.html patch | blob | history
doc/server.html patch | blob | history
doc/web/index.html [new file with mode: 0644] patch | blob

diff --git a/doc/client/concepts.html b/doc/client/concepts.html
new file mode 100644 (file)
index 0000000..071c85d
--- /dev/null
+++ b/doc/client/concepts.html
@@ -0,0 +1,16 @@
+<html>
+<title>Magic Smoke Concepts Documentation</title>
+</head>
+<body>
+<h1>Magic Smoke Concepts Documentation</h1>
+
+<ol>
+<li>Architecture (Server, Browser, Client)
+<li>Events
+<li>Orders and Tickets
+<li>Printing
+<li>Users, Hosts, Profiles
+<li>Scripting
+</ol>
+
+</html>
\ No newline at end of file
diff --git a/doc/client/config.html b/doc/client/config.html
new file mode 100644 (file)
index 0000000..b208845
--- /dev/null
+++ b/doc/client/config.html
@@ -0,0 +1,7 @@
+<html>
+<title>Magic Smoke Client Configuration</title>
+</head>
+<body>
+<h1>Magic Smoke Client Configuration</h1>
+
+</html>
\ No newline at end of file
diff --git a/doc/client/index.html b/doc/client/index.html
new file mode 100644 (file)
index 0000000..0278413
--- /dev/null
+++ b/doc/client/index.html
@@ -0,0 +1,19 @@
+<html>
+<title>Magic Smoke Client Documentation</title>
+</head>
+<body>
+<h1>Magic Smoke Client Documentation</h1>
+<img src="../logo.png" alt="logo" valign="left" align="top"/><p/>
+
+This section of the documentation describes how to use the dedicated Magic Smoke client.
+
+<ol>
+<li><a href="concepts.html">Concepts</a>
+<li><a href="config.html">Configuration</a>
+<li>Creating Events and Inventory
+<li>Selling and Shipping
+<li>User Administration
+<li>Scripting
+</ol>
+
+</html>
\ No newline at end of file
diff --git a/doc/index.html b/doc/index.html
index d834e09..cdfd11a 100644 (file)
--- a/doc/index.html
+++ b/doc/index.html
@@ -45,11 +45,9 @@ This software comes with no warranty at all. You use it at your own risk.
 
 <h2>Using Magic Smoke</h2>
 
-to be written:
-
 <ul>
-<li>Using the Web-Interface</li>
-<li>Using the Client Program</li>
+<li>Using the <a href="web/index.html">Web-Interface</a></li>
+<li>Using the <a href="client/index.html">Client</a> Program</li>
 </ul>
 
 <h2>Building/Installing Magic Smoke</h2>
diff --git a/doc/server.html b/doc/server.html
index 485d98e..205bfc2 100644 (file)
--- a/doc/server.html
+++ b/doc/server.html
@@ -142,6 +142,8 @@ Click the create database button.
 
 Create an initial administrator user using the form at the bottom of the page.<p>
 
+Open the client and create a host key for it - upload this host key using the admin form and allow the initial administrator to use any host.<p>
+
 Done.
 
 <h3>Upgrade from MagicSmoke 1.0</h3>
@@ -156,6 +158,8 @@ The upgrade may take some time - you should make sure that PHP scripts do not ab
 
 Simply enter "upgrade" into the input line and click the button.<p>
 
+Make sure you have an administrator user that can log in. You will have to either export the host key of your old client and import it in the new client or create a new key and import it with the admin form.<p>
+
 The format of customers in the database has changed significantly. The upgrade process tries to guess what part of customer names and customer address belong to which detail. This heuristic may fail in some cases, you should go through your customer list and correct any mistakes afterwards.<p>
 
 When you are done comment out the $olddb configuration to avoid initializing it for every call of a script.<p>
diff --git a/doc/web/index.html b/doc/web/index.html
new file mode 100644 (file)
index 0000000..055f7c2
--- /dev/null
+++ b/doc/web/index.html
@@ -0,0 +1,19 @@
+<html>
+<title>Magic Smoke Web Interface Documentation</title>
+</head>
+<body>
+<h1>Magic Smoke Web Interface Documentation</h1>
+<img src="../logo.png" alt="logo" valign="left" align="top"/><p/>
+
+<ol>
+<li>Buying Tickets
+<li>Buying Vouchers
+<li>Buying Merchandize
+<li>The Cart
+<li>Checking Out
+<li>Payment and Delivery
+<li>Customer Settings
+</ol>
+
+
+</html>
\ No newline at end of file
Unnamed repository; edit this file 'description' to name the repository.