Tutorial: Building a Wiki

Login or register to post comments
1 reply [Last post]
Offline
Joined: 01/09/2008

Hi all,

Over the weekend, I have tried to write a tutorial on how to use QCubed to build a Wiki.
You can see the tutorial at:

Part 1: http://qwiki.qcodocoder.com/wiki.php?page=Wiki%20Tutorial%20Chapter%201
Part 2: http://qwiki.qcodocoder.com/wiki.php?page=Wiki%20Tutorial%20Chapter%202
Part 3: http://qwiki.qcodocoder.com/wiki.php?page=Wiki%20Tutorial%20Chapter%203

The beauty of this tutorial: it is made available through the Wiki it was written in :)

Please let me know comments/feedback/suggestions through this forum topic.
I'm specifically looking for someone who would like to follow the tutorial and build the wiki from scratch to catch those little glitches in the code.

Also, what would be the next feature that you would like to see added to the wiki? That will be Part 4 ...

Kristof

Rob
Offline
Joined: 12/02/2008

Hi kmeirlaen, (This comment widget is repeating part of the first line in the preview. Is that a feature or a bug? EDIT: It doesn't do it when I edit the submitted comment. Quite strange.)

I started reading your tutorial and decided I should post my thoughts as I go along. First let me say that, while I've been programming for 30 years, I'm totally new to QCubed and PHP so I think that makes me uniquely qualified to look really ignorant. So some of my comments may not be appropriate is this tutorial isn't intended for a total beginner.

THE INTRODUCTION
My pet peeve about tutorials is the lack of an introduction. It's really helpful to have an outline of what we're trying to achieve and how we're going to get there. Your introduction did say you assume we have QCubed installed.

You also said that we're going to create a basic wiki. It is implied that we know what a wiki is and how they operate. I think that's a pretty save assumption but still you might suggest that if the reader doesn't understand some of the wiki terminology (such as "WikiWord") then they should look it up.

Does QCubed install with a default database? If not then you might mention which one you are using if it matters to this tutorial. I haven't installed QCubed yet so I don't know the answer to this.

Here's my out line for an introduction:

  1. Define our database table
  2. Write code to generate the table
  3. Run this code through the code generation process
  4. Create the wiki page in PHP
  5. Create the wiki template in PHP
  6. Create the rendering code to format the page
  7. Create the CSS to layout the page
  8. Add page navigation
  9. Add Ajax
  10. Testing
  11. Fixing some issues

CONCLUSION
Thanks for a very useful introduction to QCubed. Even though I don't have the details, I think I have a much better overview of how it works and what it can do. I've got to stop now and do some paying work. I hope my comments are useful.

Peace,

Rob:-]