Solved

Documentation Software

Posted on 2004-09-11
13
1,032 Views
Last Modified: 2011-10-03
Hello,

I am looking for some really easy to install and use documentation software for the web using PHP. I want to add help docs to an application, but would like to be able to just add simple titles and content and have it indexed automatically for our users. I have checked out Sourceforge and Hotscripts without much luck.

Has anyone had experience with documentation / knowledge base software?

I would ideally prefer links to software you have actually used and recommend, since I have searched around plenty and found nothing that jumps out at me.

Many thanks,

Bodog.
0
Comment
Question by:cracky
  • 4
  • 2
  • 2
  • +4
13 Comments
 
LVL 26

Expert Comment

by:ushastry
Comment Utility
0
 
LVL 14

Author Comment

by:cracky
Comment Utility
Thanks uhastry, but I am looking for end user help documentation, not coding documentation. Both phpdoc and PHPDocumentor are used for programmers to parse PHP comments as class / method descriptions etc. The documentation I require is for end users.
0
 
LVL 18

Expert Comment

by:armoghan
Comment Utility
I think the problem is not related to PHP directly
Why dont you try HTMLhelp from microsoft to create static Help pages
and attach it with Php application
0
 
LVL 14

Author Comment

by:cracky
Comment Utility
armoghan > I think the problem is not related to PHP directly

In fact, it is.

I am looking for a PHP documentation feature / software that I can use to create help docs or a knowledge base with a minimum of effort. I want to be able to add / edit / remove help topics dynamically without having to export a static set of pages. Besides, I have successfully worked the last year without touching a single Microsoft product and I intend to keep it that way. It's like junk food, once you wean yourself off it, you don't even feel like it anymore.
0
 
LVL 18

Expert Comment

by:armoghan
Comment Utility
you can use a content management system for this purpose
0
 
LVL 48

Assisted Solution

by:hernst42
hernst42 earned 100 total points
Comment Utility
Have you looked at http://www.hotscripts.com/PHP/Scripts_and_Programs/FAQ_and_Knowledgebase/index.html There are a lot of scripts in PHP listed one might b able to do what you want.
0
What Is Threat Intelligence?

Threat intelligence is often discussed, but rarely understood. Starting with a precise definition, along with clear business goals, is essential.

 
LVL 9

Accepted Solution

by:
techtonik earned 400 total points
Comment Utility
If you know how to write in DocBook, you can use PHP documentation build system. =)
In short:
 - your documentation sources are in XML format (DocBook elements and rules);
 - you can validate your document for structure errors;
 - you use templates to convert XML into something readable (i.e. HTML or text);
 - templates are in XSL language;
 - templates can be common DocBook templates or your custom modified DocBook.

Learning curve:
 - learn about XML;
 - learn about DTD (Document Type Definition) - standard for particular XML content;
 - understand validation toolchain: XML + DTD = error log
 - understand transformations toolchain: XML + XSL = HTML or whatever..
 - (optional) understand XSL language.
 - read some tutorial on DocBook to really put it together =)
   http://www.google.com/search?q=docbook+tutorial&sourceid=opera&num=0&ie=utf-8&oe=utf-8
   http://wiki.docbook.org/topic/DocBookTutorials

Drawbacks:
 - DocBook is rather big standard, though it isn't complex.

You can fetch example from PHP CVS:
http://cvs.php.net/livedocs/
Page of interest:
http://wiki.phpdoc.info/LiveDocs
0
 
LVL 14

Author Comment

by:cracky
Comment Utility
I have read a little about DocBook and forgot about it entirely. Looks like a good solution for a scalable help system. Exactly what I need.

Thanks also to hernst for finding me some scripts I missed.

techtonik, could you possibly show me some examples of DocBook documentation systems with a more graphical representation? Of course, since it uses XSLT, presenting DocBook in a prettier way isn't hard. I couldn't see anyone presenting in anything but the most basic HTML. It would be great if you could point me to some well-presented documentation examples.

Cheers.
0
 
LVL 9

Expert Comment

by:techtonik
Comment Utility
All PHP documentation is rendered from DocBook sources (with some minor tweaks), but unfortunately with DSSSL (non-XSL) template toolchain. FreeBSD handbook is also an example of DSSSL output http://www.freebsd.org/doc/en_US.ISO8859-1/books/fdp-primer/.

As for XSL examples - you can look at xCHM edition, which has been made with XSL. http://cvs.php.net/phpdoc/htmlhelp. The reason why DSSSL is used instead of XSL is mostly of historical reasons. XSL tools for a long time were not enough polished to produce usable output, so during this time there were a lot of tweaks made to DSSSL templates. So one have to do a lot with XSL to make output the same. Needless to say, that many just followed "If it ain't broke, don't fix it" principle.

So, there are not too much ready to use examples, because XSL toolchain is rather young, but not because it is very hard to customise DocBook. Starting point here is DocBook XSL stylesheets and basic HTML is a base function of them. After you've generated your first HTML files - you can customise DocBook templates, insert CSS styles and other stuff in output. Good resource about customising is here: (http://www.dpawson.co.uk/docbook/styling/custom.html) and, of course, http://wiki.docbook.org/topic/DocBookXslStylesheets.

Hope you are not dissapointed. =)  XSL is the future of DocBook and is actively developed. The recent version of XSL DocBook templates released just some days ago and is available on http://sourceforge.net/projects/docbook/
0
 
LVL 14

Author Comment

by:cracky
Comment Utility
Thanks techtonik. Exactly what I wanted.

Cheers.
0
 
LVL 8

Expert Comment

by:AJAY CHADHA
Comment Utility
Have you had a look at PHPKB knowledgebase software from http://www.knowledgebase-script.com
0
 

Expert Comment

by:achitaley
Comment Utility
Hello,

We use mediawiki for our documentation. We have installed mediawiki with FCKEditor extension for easier input (WYSIWYG) and used the Page Names to link up the Help Page with the context form.

Through this, we get a good Collaborative Document Maintenance Platform and also, a linked Help Documentation.
0
 
LVL 8

Expert Comment

by:AJAY CHADHA
Comment Utility
PHPKB uses InnovaEditor which makes the WYSIWYG editing compatible on all browsers such as Google Chrome, Safari, Internet Explorer, Firefox etc. plus it is backed by 12 months of free private technical support.
0

Featured Post

How to run any project with ease

Manage projects of all sizes how you want. Great for personal to-do lists, project milestones, team priorities and launch plans.
- Combine task lists, docs, spreadsheets, and chat in one
- View and edit from mobile/offline
- Cut down on emails

Join & Write a Comment

Suggested Solutions

This article will explain how to display the first page of your Microsoft Word documents (e.g. .doc, .docx, etc...) as images in a web page programatically. I have scoured the web on a way to do this unsuccessfully. The goal is to produce something …
Since pre-biblical times, humans have sought ways to keep secrets, and share the secrets selectively.  This article explores the ways PHP can be used to hide and encrypt information.
Learn how to match and substitute tagged data using PHP regular expressions. Demonstrated on Windows 7, but also applies to other operating systems. Demonstrated technique applies to PHP (all versions) and Firefox, but very similar techniques will w…
The viewer will learn how to count occurrences of each item in an array.

771 members asked questions and received personalized solutions in the past 7 days.

Join the community of 500,000 technology professionals and ask your questions.

Join & Ask a Question

Need Help in Real-Time?

Connect with top rated Experts

16 Experts available now in Live!

Get 1:1 Help Now