File: DOCUMENTATION

package info (click to toggle)
libroxen-roxpoll-doc 1.3-3
  • links: PTS
  • area: main
  • in suites: woody
  • size: 132 kB
  • sloc: makefile: 38
file content (92 lines) | stat: -rw-r--r-- 3,587 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
--------------------------------------------------------------------------
ROXPOLL MANUAL
--------------------------------------------------------------------------

Roxpoll is supposed to be easy to maintain. However, I include this
manual in the hope that it might be of some help. 

---------------------------------------------------------------------------
INSTALLATION
---------------------------------------------------------------------------
To install the package, unzip and de-tar it to a place in your file
system.

You will get:
 - A pike file (roxpoll.pike)
 - A bunch of GIF's and HTML files.
 - Some README kind of files.

The HTML files are:
admin.html     history.html   mainpage.html  
results.html   suggest.html

The GIF files are:
logo.gif         vote_left.gif    vote_middle.gif  
vote_right.gif

Make a roxpoll/ directory in the web servers filesystem (so it can be
accessed through a web interface) and move the GIF's and HTML files
there.  (For example http://my.webserver.xx/roxpoll/)

Edit the HTML file's to suit your needs (background colours,
"mainpage.html" definitions, etc)

Move the roxpoll.pike to your Roxen server module directory, or add it
to the module path in the server configuration screen.

Add the roxpoll.pike module.

Configure it:
 - The "Full URL to Roxpoll's base directory on the web server" 
   must be set. For example, this could be http://my.webserver.xx/roxpoll/
 - Then, set the "Full search path for data files".
   This is where Roxpoll saves all its datafiles and logs. For
   example; /home/celeborn/roxpoll_data/
 - Look at the other options and change anything if you feel for it.

Now. Things should be ready to start working with.  Access the roxpoll
mainpage.html using a web browser. You will get a roxpoll box telling
you that there is "No running poll!".

Fine, tap the "suggest" button and create a test-poll on the
new poll suggestion form that follows.

.--------------------------------------------------------------------------
ADMINISTRATION & WEIGHTS
---------------------------------------------------------------------------
To administrate Roxpoll, you access
http://my.webserver.xx/roxpoll/admin.html 
This screen should be pretty self explaining.

All votes have an ID, and a weight. By default, all suggested
polls have a weight of zero (0)

Only polls with a weight ABOVE zero is rolled out to the public by the
scheduler. So, if you are here for the first time you might get a
warning about "no polls right now that has a weight above zero!"

Polls with a weight BELOW zero are zapped (no undo) when
you press save on that screen.

Finally, the scheduler ranks the polls by their weights: A new poll
question is automatically moved in once the vote time has passed. The
suggested poll with the heighest weight (above zero) is then
selected.If severalquestions share the same weight, one is chosen out
of random.

If you tap the button "Roll in the highest ranked suggestion and 
activate it right away", the current poll (if any) is closed and
the next in the schedule is rolled in and activated.

You can also edit the weights of the suggested polls. Don't forget
to press the save button after editing these.

You may change the setting "By default, run the polls for XX
days". This is how many days a poll will run; by default. Old polls
and already suggested polls are not affected, only brand new polls
that are added use this setting.

Finally, if you want to edit some HTML for the roxpoll itself, you can
peek at the roxpoll source code, especially at the prehtml() and
posthtml() functions!