summary | shortlog | log | commit | commitdiff | tree
raw | patch | inline | side by side (parent: 61242e4)
raw | patch | inline | side by side (parent: 61242e4)
author | richard <richard@57a73879-2fb5-44c3-a270-3262357dd7e2> | |
Fri, 5 Oct 2001 07:42:46 +0000 (07:42 +0000) | ||
committer | richard <richard@57a73879-2fb5-44c3-a270-3262357dd7e2> | |
Fri, 5 Oct 2001 07:42:46 +0000 (07:42 +0000) |
git-svn-id: http://svn.roundup-tracker.org/svnroot/roundup/trunk@274 57a73879-2fb5-44c3-a270-3262357dd7e2
README.txt | patch | blob | history | |
doc/index.html | patch | blob | history |
diff --git a/README.txt b/README.txt
index eae2bf5c1d2d297d8e0ec636864edcdc0de22035..02f18a99420987cbd357ac3986e091302cee89d4 100644 (file)
--- a/README.txt
+++ b/README.txt
3. Usage
========
-The system is designed to accessed through the command-line, e-mail or web
-interface. Roundup has some useful doucmentation in its docstrings, so
-"pydoc roundup" will give useful information.
-
-3.1 Command-line
-----------------
-The command-line tool is called "roundup-admin" and is used for most low-level
-database manipulations such as:
- . creating a database instance
- . redefining the list of products ("create" and "retire" commands)
- . adding users manually, or setting their passwords ("create" and "set")
- . other stuff - run it with no arguments to get a better description of
- what it does.
-
-
-3.2 E-mail
-----------
-See the docstring at the start of the roundup/mailgw.py source file.
-Use "pydoc roundup.mailgw".
-
-
-3.3 Web
--------
-Hopefully, this interface is pretty self-explanatory...
-
-Index views may be modified by the following arguments:
- :sort - sort by prop name, optionally preceeded with '-'
- to give descending or nothing for ascending sorting.
- :group - group by prop name, optionally preceeded with '-' or
- to sort in descending or nothing for ascending order.
- :filter - selects which props should be displayed in the filter
- section. Default is all.
- :columns - selects the columns that should be displayed.
- Default is all.
- propname - selects the values the node properties given by propname
- must have (very basic search/filter).
-
+See the index.html file in the "doc" directory.
3. Design
diff --git a/doc/index.html b/doc/index.html
index 53788e0779132c6302515c957fc69f6455082e1c..f13d2f315273f8106597e2036182131a899581f1 100644 (file)
--- a/doc/index.html
+++ b/doc/index.html
command-line.
<h2><a name="web">Web Interface</a></h2>
-T.B.D.
+Index views may be modified by the following arguments:
+<pre>
+ :sort - sort by prop name, optionally preceeded with '-'
+ to give descending or nothing for ascending sorting.
+ :group - group by prop name, optionally preceeded with '-' or
+ to sort in descending or nothing for ascending order.
+ :filter - selects which props should be displayed in the filter
+ section. Default is all.
+ :columns - selects the columns that should be displayed.
+ Default is all.
+ propname - selects the values the node properties given by propname
+ must have (very basic search/filter).
+</pre>
+
+<strong>Not sure what to put in here...</strong>
<h2><a name="mail">E-Mail Gateway</a></h2>
<p> </p>
<hr>
-$Id: index.html,v 1.8 2001-10-05 02:44:06 richard Exp $
+$Id: index.html,v 1.9 2001-10-05 07:42:46 richard Exp $
<p> </p>
</body></html>