This project is obsolete.
The new name of this project is
BeckCMS.
This BeckWiki page is here for historical reference only.
Started Sunday, February 1, 2004.
Warning: It is a long way from a good idea to a final product. Until I post the first release here this is just a good idea. !<-- :)
Latest news on BeckWiki development.
Download BeckWiki! Warning: This is bata software!
About BeckWiki.
Not being satisfied with any wiki engine I have thus far installed or attempted to install and wanting to learn PHP, I have decided to create my own wiki system powered by PHP.
Features and design goals of BeckWiki will be the following:
Supper simple and easy to learn, but powerful enough to be useful.
No support for CamelCase links, I consider this a design flaw.
Small size, and low file count. The aim is about 10 files for the whole system not including wiki pages, and about 50-150kb unzipped. Is this too small?
Uniform wiki tags, this is key to remembering everything.
Pages can only be permanently deleted by admin.
All old pages are accessible via page history.
Release Schedule:
Prevue release: November 25, 2004! done!
Get it here!
First release: Q4 2004 or Q1 2005!. ~50% done
Second release: When it's done.
Third release: When it's done.
Schedule last updated Nov. 22, 2004
BeckWiki Features: MOST OF THIS STUFF HASN'T BEEN IMPLEMENTED YET.
Flat file database:
All wiki pages and data will be stored in the "data" sub directory as ordinary files. Scheduled for first release.
MySQL database. All wiki pages and data stored in a MySQL database. Not currently scheduled for release, but it may eventually be a goal. However, this feature may add unnecessary complexity.
DROPPED FOR NOW
Page locks.
The administrator can add multiple passwords to each page. Pages that do not have any passwords associated with them can be edited by anyone. If a page does have a password, it will show the name, if any, associated with that password in the page history when the page is edited. Scheduled for third or latter release.
Wiki index.
I think both recent changes and wiki index can be served by the same page. This page will show a list of all pages in the wiki, the date and time each page was last edited, the date and time it was created, the page size and the last person to modify the page, if it is a locked page. The index can be sorted by date created, date modified, name or size. Scheduled for third or latter release.
Page history.
Each page will have a page history. The page history will include every edit ever made to that page. The list will be organized from most recent page to oldest page. You can view an old version of the page or restore an old version to the current version. When a page is restored, the current version is saved to the page history. Scheduled for second or third release.
Page difference.
Select two pages in the page history and it will show you a third version of the two pages with all additions highlighted in blue and all deletions highlighted in red. This is very useful to spot small changes in a large document. Scheduled for third or latter release.
Edit page.
It wouldn't be a wiki without the ability to edit any page from any browser, would it. The edit page will load the wiki text of a page into a text box where you can edit the page. At the bottom of the box will be a "ok" button and a "cancel" button. When someone clicks the "Edit page" link the page will be locked until that person either clicks the "ok" or "cancel" buttons. The lock can be forced off if necessary. Edit page scheduled for first release, Page lock scheduled for third or latter release.
Is it even reasonable to think all of this will fit into 10 files and 150 kilobytes?
11-Nov-2004:
YES! it is. Right now it is about 7KB and 2 files to upload and then 5 files and 1 directory after running the install script. The file count will stay about the same for the first release, although I expect the total install size to go up to about 20kb or so. However nothing is set in stone.
BeckWiki Tags:
WARNING: THESE TAGS WILL LIKELY CHANGE A LOT BEFORE VER 1.0..
I have revised the wiki tag system again. You can find the old stuff
here.
All tags will be enclosed in square brackets -
!
Not all of these tags will be implemented in the first release, only the ones required for basic functionality.
To display a BeckWiki tag instead of it being processed, put a forward slash in front of it.
!!- -- This will output "!
-"
!- -- This will output the horizontal line as normal.
!Wiki_Link - Simple wiki link. All square bracketed text that is not recognized as a wiki tag will be recognized as a wiki link. You can use a wiki tag as a wiki link if you write it as an advanced wiki link as shown below. Text will be displayed as typed but the actual page (file) name will convert spaces to underscores and drop all non number/alpha charters.
Examples:
!Wiki_Page is a wiki link pointing to the page "Wiki_Page"
!wiki is not a valid wiki link because it uses a reserved wiki tag and will be processed as such.
!Displayed Text - Advanced wiki link. Same as above but text after the first space will be displayed instead of the wiki link. Done!
!wiki -- Turn wiki processing on.
Wiki processing on by default. Turning it off will stop processing of all wiki tags until the next !
wiki tag. You can also use !
on and wiki !
off.
! -- html tags.
For security reasons, only html tags defined in the configuration file will be allowed. Wiki tags will not be processed while in html mode. All html goes inside the !
html wiki tag. Done!
!url -- External link. Scheduled for second or third release. The url should be put inside the square brackets along with tag separated by a single space. If you put another space after the actual link, all text after it will be displayed instead of the url.
Example !
thebeck.com -- !
thebeck.com click here to visit thebeck.com
!wiki_link -- Inserts the text of another wiki page. Scheduled for second or third release - May drop.
!image_name -- Images are handled by BeckWiki a lot like wiki pages are. To make a new image just add the image tags and name the image in the "image name" part of the tag. After you save the page the image will be displayed if you used the name of an image that already exists. Otherwise it will be displayed as a link. You click on the link or the image and it will take you to the page that manages that image. On this page you can upload a new image or revert to an old one. The "image name" part of the tag is required because BeckWiki uses it as the image's wiki link. I thought of this all on my own. :) Unfortunately this is going to be too much for the first release. Scheduled for third or later release.
!file_name -- Files are handled kind of like images. When you click on the file link you will be taken to a page where you can download the file, upload new version of the file and see past versions of the file. The "file_name" does not have to be the same as the file you are going to upload, it is used as the name of the wiki page the link will point to. This definitely won't be in the first release either. Scheduled for third or later release.
!file_name displayed text -- You can link to a file in this format if you want to use show text on page different from the file name. Scheduled for third or later release.
!email@address -- Email link. Scheduled for third release.
!left -- Align text, images etc. left. Scheduled for first or second release.
!center -- Align text, images etc. center. Scheduled for first or second release.
!right -- Align text, images etc. right. Scheduled for first or second release.
!* -- Bullet list. Done!
!2, !3 -- Second, third level bullet list. Note the space between the asterisk and the number is required. Done!
!# -- Numbered list. Done!
!2, !3 -- Second, third level numbered list. Again, space between pound and number is required. Done!
!b -- Bold type until next !
b tag or end of line, whichever comes first. Done!
!i -- Italic type until next !
i tag or end of line, whichever comes first. Done!
!u -- Underline type until next !
u tag or end of line, whichever comes first. Done!
!m -- Mono space type until next !
m tag. Done!
!n -- Horizontal line, n is an optional parameter for the thickness. Done!
!h -- Header, all text until end of line will become header. Done!
!FFFFFF -- Change text color to the specified RRGGBB hex value. Scheduled for third release.
!n -- Text size.
!text -- Comment. Text is visible only in editor. Scheduled for third release.
!edit or !displayed text -- Inserts a link to edit the current page.
!history or !displayed text -- Inserts a link to show the current page history.
!index or !displayed text -- inserts a link to the special wiki index page.
As you can see this list of wiki tags is quite extensive. Because I want to keep this wiki engine as small and simple as possible, it may not be practical to implement all of the above tags.