First pass at documentation... - Posted (5281 Views)
New Member
Sabre Cat
Posts: 55
55
This is just the table of contents. Let me know what ya'll think... First pass. I'll probably go back and add more depth next time.
A) Administration FAQ/How To
A.2) Set up
A.2.2) Installing the Database
A.2.3) Does your server support it? A.2.4) How to I decide what e-mail system to use? A.2.5) Changing the Administrative Password

A.3) Customization (Setting up Look, Feel, and Features)

A.3.1) Main Forum Configuration
A.3.1.1) Forum's Title
A.3.1.2) Forum's Copyright
A.3.1.3) Title Image Location
A.3.1.4) Home URL
A.3.1.5) Forum URL
A.3.1.6) Version info
A.3.1.7) Authorization Type
A.3.1.8) Set Cookie To
A.3.1.9) Use Graphics as Buttons
A.3.1.10) Use Graphic for "Powered By" link

A.3.2) Feature Configuration
A.3.2.1) Restrict Moderators to moving their own topics
A.3.2.2) IP Logging
A.3.2.3) Private Forums
A.3.2.4) Show Moderators
A.3.2.5) Allow Forum Code
A.3.2.6) Images in Posts
A.3.2.7) Allow HTML
A.3.2.8) Secure Admin Mode
A.3.2.9) Non-Cookie Mode
A.3.2.10) Edited By on Date
A.3.2.11) Hot Topics
A.3.2.12) Icons
A.3.2.13) Detailed Statistics
A.3.2.14) Show Quick Paging
A.3.2.15) Show Prev / Next Topic
A.3.2.16) Items per page
A.3.2.17) Pagenumbers per row

A.3.3) Member Details Configuration
A.3.3.1) Fullname
A.3.3.2) Picture
A.3.3.3) Recent Topics
A.3.3.4) Sex (male/female)
A.3.3.5) Age
A.3.3.6) City
A.3.3.7) State
A.3.3.8) Country
A.3.3.9) ICQ
A.3.3.10) YAHOO
A.3.3.11) AIM
A.3.3.12) Occupation
A.3.3.13) Homepages
A.3.3.14) Favorite Links
A.3.3.15) Marital Status
A.3.3.16) Bio
A.3.3.17) Hobbies
A.3.3.18) Last News
A.3.3.19) Quote

A.3.4) Ranking Configuration
A.3.4.1) Description (It's basically self-explainitory)

A.3.5) Server Date/Time Configuration
A.3.5.1) Time Display
A.3.5.2) Time Adjustment
A.3.5.3) Date Display

A.3.6) Email Server Configuration
A.3.6.1) Email Mode
A.3.6.1.1) ASPMail
A.3.6.1.2) ASPEMail
A.3.6.1.3) ASPQMail
A.3.6.1.4) CDONTS
A.3.6.1.5) Chili!Mail
A.3.6.1.6) GeoCel
A.3.6.1.7) IISMail
A.3.6.1.8) JMail
A.3.6.1.9) SMTP
A.3.6.2) Email Server Address
A.3.6.3) Administrator Email Address
A.3.6.4) Require Unique Email
A.3.6.5) Require Logon for sending Mail

A.3.7) Font/Table Color Code Configuration
A.3.7.1) Font/Table Color Code Configuration
A.3.7.1.1) Font Face Type
A.3.7.1.2) Default Font Size
A.3.7.1.3) Header Font Size
A.3.7.1.4) Footer Font Size
A.3.7.1.5) Base Background Color
A.3.7.1.6) Default Font Color
A.3.7.1.7) Link Color
A.3.7.1.8) Link Decoration
A.3.7.1.9) Visited Link Color
A.3.7.1.10) Visited Link Decoration
A.3.7.1.11) Active Link Color
A.3.7.1.12) Hover Link Color
A.3.7.1.13) Hover Link Decoration
A.3.7.1.14) Header Background Color
A.3.7.1.15) Header Font Color
A.3.7.1.16) Category Background Color
A.3.7.1.17) Category Font Color
A.3.7.1.18) First Cell Color
A.3.7.1.19) First Alternating Cell Color
A.3.7.1.20) Second Alternating Cell Color
A.3.7.1.21) In Forum Font Color
A.3.7.1.22) In Forum Link Color
A.3.7.1.23) Table Border Color
A.3.7.1.24) Pop-Up Table Color
A.3.7.1.25) Pop-Up Table Border Color
A.3.7.1.26) New Font Color

A.3.7.2) Table Size Configuration
A.3.7.1.1) Topic Left Column Width
A.3.7.1.2) Topic NOWRAP Left
A.3.7.1.3) Topic Right Column Width
A.3.7.1.4) Topic NOWRAP Righ

A.3.8) Bad Word Feature Configuration
A.3.8.1) Description (Self explainitory)

<
 Sort direction, for dates DESC means newest first  
 Page size 
Posted
Starting Member
mbiolsi
Posts: 40
40
To get the idea tank rolling again, check out this site to see what they have for docs...
http://www.infopop.com/support/ubbthreads/docs.html

Mike

<
Posted
Help Moderator
Nathan
Posts: 7664
7664
quote:
Also, I think you ca write it in whatever you want, but if you keep it in a format like WORD, which most people have and can use, you have a better chance of getting it off the ground. Word's TOC and formatting features will allow for things to get done quickly once the text has been created. It can then be ported to whatever format/platform you desire. Besides... some people actually LIKE reading printed pages bigsmile

Dont even consider doing it in word. You must use some format that can be easily crossreferenced and can display on neraly every system with software that is both free and well distributed. HTML is the solution of chioce.
 Nathan Bales - Romans 15:13
---------------------------------
Snitz Exchange | Mod Resource
<
Posted
Retired Admin
gor
Posts: 5511
5511
quote:
Dont even consider doing it in word. You must use some format that can be easily crossreferenced and can display on neraly every system with software that is both free and well distributed. HTML is the solution of chioce.

Actually it isn't, but it is closer, better is to use XML and something like i.e. Docbook. See this topic for example.
Pierre Join a Snitz Mailinglist<
Posted
Help Moderator
Nathan
Posts: 7664
7664
I am familor with XML . . but I cant for the life of me figgure out what that Docbook software does. Or is it even software?
 Nathan Bales - Romans 15:13
---------------------------------
Snitz Exchange | Mod Resource
<
Posted
Retired Admin
gor
Posts: 5511
5511
quote:
I am familor with XML . . but I cant for the life of me figgure out what that Docbook software does. Or is it even software?

I started a new topic for it, see here.


Pierre Join a Snitz Mailinglist<
Posted
Development Team Member
Davio
Posts: 12217
12217
Talk about information overload. That's a lot of info to read up. Good stuff Gor. Your howto was quite helpful in setting up the software. smile
I am more than willing to help in writing the docs. It's about time we did one.
- David<
Posted
Help Moderator
Nathan
Posts: 7664
7664
I can help as well. But reading that info It takes in XML and outputs htm doc pdf and other formats right?
 Nathan Bales - Romans 15:13
---------------------------------
Snitz Exchange | Mod Resource

Edited by - Nathan on 02 February 2002 11:31:04<
Posted
Retired Admin
gor
Posts: 5511
5511
quote:
I can help as well. But reading that info It takes in XML and outputs htm doc pdf and other formats right?

Right.

Ok, lets do this. Give me a couple of hours and I'll get back to you.
Pierre Join a Snitz Mailinglist<
Posted
Retired Admin
gor
Posts: 5511
5511
See: http://forum.snitz.com/forum/topic.asp?TOPIC_ID=22205

Pierre Join a Snitz Mailinglist<