| Author |
 Topic  |
|
|
ajhvdb
Junior Member
Netherlands
392 Posts |
 Posted - 30 August 2002 : 19:53:56
|
We are using Snitz Forums to store examples of VB/VBA/ASP/HTML code.
As members started asking questions about quotes, comma's, etc. 2 months ago I started looking for
a colorizer or highlighter inside Snitz. Got a bit carried away and, after a lot of rewrites, now I've written my first Mod.
In this Mod I also want to include a template other Mod writers can use to create a nice ReadMe.html file.
I have looked at many of the available Mods and gathered all the text from the "ReadMe.txt" files and created from this a template with all relevant information.
This template is in No way me saying "this is the way to do it".
English is not my native language so some help with spelling, etc would be great. Do not look at those '#:, this will become clear later.
After 3.4.02 is out I will release this Mod with any remarks/request you make.
This template can be used to publish your Mod.
Replace/Delete/Modify the text between () and delete the symbols () too.
In the installation part you can pick an installation method.
Title:
(Title of your mod)
By:
- Author: (Your name) (MemberName)
- Original by:
- HomePage:
- Contributors:
- Modified by:
- Download:
- Demo: (http://www.yourdomain.com/forum/) (Look at the included screenshots files.)
Please read everything before proceeding!!
Compatibility:
Snitz Forums (v3.4.02)
Version History:
(v1.00), (1 Januari 2002)
This is the first release of this Mod.
It is tested only by myself so expect minor bugs.
(With every minor update add .01 to your version number and insert at the top: Version number, Date and a little Description about/why the update)
Ease of Installation (1 - Hard - 10 Easy): (1)
Description:
(Type in a short description what your Mod does)
Installation:
1.
First of all make a backup of your current forum files and current database.
The archive file should contain the following structure:
Folder: Additional Files
These new/updated MOD files need to be copied to your main forum directory
Before you do this, follow the steps below or in other ReadMe file(s)
Icons or images can be placed into your own images directory or into the main forum directory
Folder: Altered Files
Do NOT copy these files over your existing forum files
They are only provided as a guide or to compare with your existing forum files
A good compare utility is "Beyond Compare" at www.scootersoftware.com
2.
(Only files will alter, not your Database.)
Copy the following file(s) into the main forum directory:
(dbs_mod.asp)
Setup the Database:
Login to your forum as Admin
Click on "Admin Options"
Click on "MOD Setup"
Choose "(This Mods Title)" from the dropdown box
Click on "Update"
3.
(--Mod Install Method 1--)
Note:
The line numbers provided below are from the original forum file.
A line number is only an indication where to look. Please Compare the code.
Apply the following changes:
'#:#
----------------------------
'#: File -> (filename1.asp)
----------------------------
------------------------------------------
'#: Around line #67 find this code:
------------------------------------------
'code
'code
'code
'code
'code
----------------------
'#: Change it to this:
----------------------
'#:67
'newcode
'newcode
'newcode
'newcode
'newcode
'#:#
'#:#
----------------------------
'#: File -> (filename2.asp)
----------------------------
-------------------------------------
'#: Around line #87 find this:
-------------------------------------
'code
'code
'code
'code
'code
---------------------------------------------------
'#:86 Above this, on line #86 insert the following:
---------------------------------------------------
'newcode
'newcode
'newcode
-------------------------------
'#: It will now look like this:
-------------------------------
'#:86
'newcode
'newcode
'newcode
'code
'code
'code
'code
'code
'#:#
'#:#
(--Mod Install Method 2--)
Compare every file in the "Altered Files" folder with your correspondingly named forum file.
Find a piece of code marked like this:
- ### (Title of your mod) Begin ###
- ### (title of your mod) End ###
or find a single line of code marked like this:
- ### (Title of your mod) ###
Add or modify this marked code in your file:
Repeat this process for every marked code you can find
Do NOT copy a piece of code with a different marker name
Include the surrounding symbols
The following additions or modifications must be made:
(filename1.asp)
- (1) Line (addition) (modification)
- (1) Additional code block
(filename2.asp)
- (1) Line (addition) (modification)
- (1) Additional code block
4.
That's it!
Login to your forum as Admin
Click on "Admin Options"
Click on "(This Mods Config/Setup/Feature/Options)" page
Tested on:
Server: (Windows NT4/IIS4) (Windows 2000/IIS5)
Database: (MS Access) (MSSql) (MySql)
Client: (IE) (NS) (Opera)
Known issues:
(What does the user need to know)
(Do you already know of things that can go wrong with this Mod)
Requirements:
(What is required to use this Mod)
Possible improvements:
(What can be done to enhance this Mod)
Good luck with this Mod and please, do not email me, post all bugs and requests at:
http://forum.snitz.com/forum/topic.asp?TOPIC_ID=(0) "MOD_Add-On_Forum_(W/Code)"
Support questions at:
http://forum.snitz.com/forum/forum.asp?FORUM_ID=94 "Help:_MOD_Implementation".
However, before you start a new topic, please do a search in that forum to make sure there isn't already one.
If there isn't, be sure to include the name of this MOD in the subject title, and give a descriptive message of what isn't working.
Installation of this MOD on other Snitz Forum versions (see: Compatibility) can result in unexpected behaviour and is therefore not recommended and completely at your own risk.
Terms of use and distribution:
This is a modification made available for Snitz Forums. http://forum.snitz.com
It is released under the same terms (General Public License) as Snitz Forums as required by the terms of the GPL.
I like this idea, but I'll make this topic sticky while we have some discussion on it. It can be moved to a more appropriate forum later. - Dave M. |
Edited by - davemaxwell on 30 August 2002 22:23:36 |
|
|
burthold
Junior Member
USA
426 Posts |
Posted - 31 August 2002 : 00:33:57
|
Woah? This looks like an informal talk on some kind of mod documentation standard!  ,
Well, I think it looks good. I don't know if I would include pre-modded files of any sort that are part of the forum base code. No matter what you put in the readme people WILL copy them over and complain that your mod blew their forum up.
Ease of installation is subjective I think we need to pin down what constitutes hard vs easy in terms of 1 to 10. To me 1 would be one or two lines of code to insert and not other code modification. Also, database updates must be considered with this.
Database setup is also subjective. The DBS format files are weak and only support a very limited number of commands.
Everything else looks pretty good and is also what I inlcude in my readme files.
Good work!
Wes |
 |
|
|
RichardKinser
Snitz Forums Admin
USA
16655 Posts |
Posted - 31 August 2002 : 02:32:27
|
quote:
Originally posted by burthold
Database setup is also subjective. The DBS format files are weak and only support a very limited number of commands.
What other commands would be needed for use with this forum? I have never found a case where what I needed wasn't already covered. |
|
|
|
burthold
Junior Member
USA
426 Posts |
Posted - 31 August 2002 : 03:20:48
|
Ok, weak and very limited is not an accurate thing to say. The last time I used it I couldn't find a datetime type. My biggest problem is the limited number of datatypes I know it supports the four most used but, I like the option to use the right data type for the app I'm working on. I also had to do some mod work on the old admin MOD setup even after using the one HuwR corrected for MySQL. My experiences even under 3.3.x hasn't been stellar. I also have seen problems with it under 3.4 with multiple DB create calls. So, I prefer to write my own setup script for the database side. Thats why I say database setup is subjective.
Wes |
|
|
|
ajhvdb
Junior Member
Netherlands
392 Posts |
Posted - 01 September 2002 : 19:15:04
|
quote:
Ease of installation is subjective I think we need to pin down what constitutes hard vs easy in terms of 1 to 10. To me 1 would be one or two lines of code to insert and not other code modification.
I think "Ease of installation" is just an indication or something like "don't even bother to install this without a little asp knowledge", "read the installation steps carefully" or "up and running in 2 seconds".
When they read on they will understand if it's tough or not.
|
|
|
|
Roland
Advanced Member
Netherlands
9335 Posts |
Posted - 12 September 2002 : 15:41:45
|
I'd suggest someone makes an HTML template for MOD readme files.
If all code changes have to be put in a .TXT file it quickly becomes messy and quite hard to follow. HTML allows you color-code certain things, and you can use text areas for large chunks of code that have to be copies and pasted.
Nathan has made some really good readme files in HTML format, and I tried to make a decent readme file for the Account Locked Email MOD I released fairly recently. Compare the time it takes to make a plain text readme file and an HTML readme file, and the difference won't be big but the advantages will be. |
|
|
|
ajhvdb
Junior Member
Netherlands
392 Posts |
Posted - 12 September 2002 : 16:28:49
|
quote:
Originally posted by FrutZle
I'd suggest someone makes an HTML template for MOD readme files.
But that's what this mod does frutzle. You can use this template (which is nothing more then a forum message) to create a readme html.
If you don't want to the template and do it yourself, you can throw away the template but you can still insert a piece of code click on submit and it is colorized for use in your own readme html.
Look here:
http://forum.snitz.com/forum/topic.asp?TOPIC_ID=34181 |
|
|
| |
Topic |
|
Topic Locked
