Topics

User Functions

Events

There are no upcoming events

What's New

Stories last 2 weeks

No new stories

Comments last 2 weeks

No new comments

Trackbacks last 2 weeks

No new trackback comments

Links last 2 weeks

No recent new links

NEW FILES last 14 days

No new files

Welcome to Geeklog Wednesday, April 23 2014 @ 09:56 PM EDT

Geeklog Documentation

Geeklog
  • Wednesday, June 30 2004 @ 01:54 PM EDT
  • Contributed by:
  • Views:
    6,154
Talk, Talk, Talk!

Thats about all the Geeklog Documentation efforts have resulted in so far. After reading amckay's Beginner's Guide to Programming Geeklog, I was prodded to do something about it. So I set up a wiki for Geeklog Documentation. I have almost finished adding the Plugin Developer's Guide and have fleshed out an outline. I have other scattered documentation I will add and plan on incorporating the current Geeklog Documentation into the wiki. That, however, is far from adequate. So now I am asking for your help completing it.

You can find the wiki at http://www.pigstye.net/wiki and soon you can reach it at http://wiki.geeklog.net. Go there, sign up and you can immediately start adding/editing stuff. The wiki is MediaWiki which has capability to upload and use graphics. Have at it. I installed the wiki and added most of the Plugin Guide in about an hour, its not hard.

Plugin developers and programmers -- log on to the Wiki and create a page about your plugin and point to where you can download it, where to find support, etc.

Besides people like myself who looks at things from a programmers point of view, we need users and administrators to fill in the holes. So come on, quit gripping about the docs and do something about it. If you have trouble finding the answer to something, add it to the wiki when you do.

Oh and by the way, don't think that my outline and postings are the last word, add to it, rearrange it, whatever. If you find a mistake change it, if you have an addition or note add it. If it would be usefull to someone else, by all means it should be there. Lets make this great.

By the way, if english is not your native language and you want documentation in your native language, you are more than welcome to add it. If you want to do this, contact me and I will give you some guidelines and expanded privilages so that you can moderate your language version.

The following comments are owned by whomever posted them. This site is not responsible for what they say.

  • Geeklog Documentation
  • Authored by:Robin on Thursday, July 01 2004 @ 05:21 AM EDT
That's the spirit!! I've just signed in and hope to contribute to the community soon.

---
www.geeklog.now.pl
  • Geeklog Documentation
  • Authored by:amckay on Thursday, July 01 2004 @ 08:40 AM EDT
OK, my Beginner's Guide is in as well. I'll try to get a page in for my plugins as soon as I can.

I was thinking we should eventually have a page for each and every GL function maybe? That way people can comment on their use of it and so on, kinda like the PHP online manual.
  • Geeklog Documentation
  • Authored by:tomw on Thursday, July 01 2004 @ 09:42 AM EDT
Thanks to both for your contributions. Lets have more, at first most of the work will be cut and paste and a little reformat -- anyone can do that.
  • Geeklog Documentation
  • Authored by:Robin on Thursday, July 01 2004 @ 10:33 AM EDT
In the process of getting familiar with wiki-wiki thing I've updated the available languages.

---
www.geeklog.now.pl
  • Geeklog Documentation
  • Authored by:destr0yr on Thursday, July 01 2004 @ 12:44 PM EDT
can the wiki support more (x)html such as span, style, acronym, etc?

---
-- destr0yr - "People like you are the reason people like me need medication."
  • Geeklog Documentation
  • Authored by:tomw on Thursday, July 01 2004 @ 01:47 PM EDT
Like most wikis it tries to keep away from the use of direct html codes for security reasons. There are codes and constructs to do just about anything you want however. If you havn't seen it here is mediawiki's documentation.

Thanks for the contributions you have already made.

TomW

  • Geeklog Documentation - Filing question
  • Authored by:netbuster on Tuesday, July 06 2004 @ 02:45 AM EDT
I was excited to learn about this Wiki project and decided to add some personal experiences, as i just refreshed my memory by recent upgrade to 1.3.9
But, I started typing all little things I noticed and realized, doc page becomes clogged too much
I added one note here for obvious thing which happens with me always and under all hostings, and then thought one more note about checking permissions, under installation steps, there is an advise for check.php script. It is currently running not correctly, so first my move was to write it, like this
NOTE: As of 1.3.9sr1 version, running check.php will help you to identify whether permissions are set correctly only till you get an error regarding SQL. Once SQL related error occurs, download error.log and read the error. It will mean that permissions for logs/ folder are set and geeklog writes to it. But errors regarding SQL are not for you to worry at that point, omit it for now and go to the step 4

But then I removed it from there, since I started thinking that at the same spot I have to describe how to correct errors, which error is good and which is not, what to do etc. It may become a 2 page story just describing a current work of one script, while it may all change in the next version
So, having said all of this, my questions are:
1. Should we have a version related errors file or how wiki doc will change if 1.3.10 will be released and function differently
2. If someone spots a bug or an error, is Documentation is a write space for describing it and if yes, what spot? Should it be under Problems? May be version differencies? I remember from previous installations, there are numerious little but important changes from version to version and automatic updates not always catch them
3. Not related, but ... What about security? I registered my account and even without proving an email I was logged on immediately to edit stuff. What if someone will delete or add advertisement entries all over the place?
  • Geeklog Documentation - Filing question
  • Authored by:Dirk on Tuesday, July 06 2004 @ 03:25 AM EDT
What if someone will delete or add advertisement entries all over the place?

That's a problem all Wikis face. But since the Wiki tracks all the changes, spam and vandalism are easy to undo.

bye, Dirk

  • Geeklog Documentation - Filing question
  • Authored by:tomw on Tuesday, July 06 2004 @ 10:08 AM EDT
I will try to answer your questions, but not here. the wiki has a built in provision for discussing such issues and that would be a better place to do this. That way all the discussion will be easily accessible to all. Each page has a discuss this option. Here you can bring up questions about page layout, etc and others can see this discussion if they have similiar questions. So for my answers I would direct you here.

Thank you for your contributions and to the others who have been adding things. If you havn't been by to look come look, its starting to take shape.

tomw

  • Geeklog Documentation - Filing question
  • Authored by:Robin on Tuesday, July 06 2004 @ 10:14 AM EDT
Tom something ain't right with the link you provided. Did you mean this link

---
www.geeklog.now.pl

  • Geeklog Documentation - Filing question
  • Authored by:tomw on Tuesday, July 06 2004 @ 10:23 AM EDT
Yep, first mistake today.
  • Geeklog Documentation - Filing question
  • Authored by:netbuster on Friday, July 09 2004 @ 02:23 AM EDT
I went as suggested to wiki pages, but I think I am still not used to its interface. Made a short gotcha add there for a test and now think how people will find it, it doesn't appear anywhere, where is a chance someone will look for it

On the other hand, I still don't think clogging main page with installation by little notes with version differencies will appropriate

Is there a way at least to show "talk" comments added to the bottom of the main page, like comments in geeklog, or, may be have significant ones as sub-pages, under the main page?
  • Geeklog Documentation - Filing question
  • Authored by:Robin on Friday, July 09 2004 @ 05:34 AM EDT
netbuster, check this out. Hope that helps.

---
www.geeklog.now.pl

  • Geeklog Documentation
  • Authored by:wfzimmerman on Thursday, July 08 2004 @ 07:46 PM EDT
When this gets a little further along, I would be happy to publish a copy of the GL documentation as a book and make it available to the community at wholesale. I already have a batch of ISBNs and can publish via Print-Quantity-Needed technology from Lightning Source for around $300 out of pocket.
  • Geeklog Documentation Update
  • Authored by:tomw on Thursday, July 08 2004 @ 09:35 PM EDT
The Geeklog Documentation Project is coming along nicely.
  • So far we have 35 registered users.
  • 12 users have made contributions.
  • There are about 80 pages so far.
  • 481 edits so far.
  • 2646 Page views.
Of course that is nowhere near complete, but at this point it is starting to get useful.

If you havn't made a contribution, please stop by. We are in most need of basic howtos, user and admin instructions.

TomW

  • Geeklog Documentation
  • Authored by:Anonymous on Monday, July 12 2004 @ 04:08 PM EDT
Will someone make a link to this Wiki in the Resources Section?

---
tokyoahead.com
  • Geeklog Documentation
  • Authored by:Dirk on Monday, July 12 2004 @ 05:05 PM EDT
Erm, how about Wiki Docs? It's been there for a while already ...

bye, Dirk