Page 1 of 1

Documentation

Posted: Sun Dec 21, 2008 5:22 pm
by codetwists
I see the on-line documentation and I see the book, which seems to be only available in German, which I neither speak nor read. Does anyone know of any other documentation that's a bit more complete? For instance, I've been searching all morning for information on static pages and can't find anything except problem and bug fixes in the Forum. The on-line listing has a one line description, but that really doesn't tell me much. I'd really like to see a comprehensive description of the plug-in, how to use it, what it does, etc.

Thanks,

Myron

Re: Documentation

Posted: Sun Dec 21, 2008 6:03 pm
by garvinhicking
Hi!

Usually, serendipity strifes to be self-explanatory - I think it does a good job in many areas where documentation is not really needed. Where this fails, this forum has some questions and of course the s9y.org online docus you have already found.

The community definitely needs volunteering people who write and contribute more documentation, as sadly there are currently no precise plans to translate the book to english. I can give s9y.org wiki accounts to any one who'd like to contribute (it can't be world-writable because we do not have the manpower to check every anonymous entry and kill spam).
I'd really like to see a comprehensive description of the plug-in, how to use it, what it does, etc.
I fully agree. The s9y core has already preparations for that. When a plugins ships with a Documentation_en.html file, this can be displayed from within Serendipity.

Best regards,
Garvin

Posted: Sun Dec 21, 2008 10:54 pm
by Don Chambers
Static pages are both easy to use, and complex all at the same time, thanks mostly to the newly added custom fields.

It might be easier to ask what you want to do.

@ Garvin - maybe we need to get an outline of desired documentation, create these headings in the wiki as NEEDED: Topic, then those with experience could begin to write those missing sections.

Posted: Mon Dec 22, 2008 1:07 am
by garvinhicking
Hi Don!

I think that's a good idea. Maybe we can start a thread to gather those headings...

Regards,
Garvin