Not logged in. · Lost password · Register
Forum: General Help and Support Features and Functionality RSS
Use wiki for doc?
Avatar
csmba #1
Member since Apr 2007 · 2 posts
Group memberships: Members
Show profile · Link to this post
Subject: Use wiki for doc?
Hi.

I am considering using a wiki system for several months now. My idea is to use it in the company so that people can record troubleshooting cases. So when they use our product and have a problem, then find a solution, they can wiki it and by that slowly creating a great knowledge base of Q&A.

My problem: I cannot find a way to have the "live" wiki running inside the company, and then having an easy way of taking it offline as a document or static html site. Why would I need that?
Well, when I send an engineer to a remote site, I want him to have this entire Q&A on his laptop, and I cannot assume internet connection. Or, to send it to my customers so it sits on their server.
"Export to word doc" would be great, but also a way to "one click" export it into a laptop or zip file that can be then used on a remote site.

any idea how doKuWiki supports this?

thanks
Avatar
tobiaseigen #2
Member since Feb 2007 · 21 posts
Group memberships: Members
Show profile · Link to this post
Hi -

You've got a bunch of options:

- Install web servers and dokuwiki on the laptops. You can copy the contents of the data dir to the laptop from time to time, or provide it as a zipfile download for your techs to then copy over to their laptops.
- Use a web crawler like httrack
- Use includes to generate largish downloadable/printable versions of your wiki

Probably more options available - these occur to me off the top of my head. We at Kabissa have started experimenting with the last option at http://www.kabissa.org/wiki/ttgo/start - you can browse the wiki online or download whole chapters to print out and read offline later. Eventually we will be using the wiki contents to create printed and bound versions of the manual. 

Cheers.

Tobias
Tobias Eigen

Kabissa - Space for Change in Africa
http://www.kabissa.org
Avatar
csmba #3
Member since Apr 2007 · 2 posts
Group memberships: Members
Show profile · Link to this post
Thanks Tobias.

The 3rd options sounds the best, but unfurtunatly is the one I understood less. What do you mean by "includes" and "largish"? is this a dokuwiki term(s)? Sorry, I didn't do a full research of dokuwiki yet.

BTW, any advantages for dokuwiki over TWiki? ( I did a small test of TWiki, bit found it complex for users and configuration).
Avatar
tobiaseigen #4
Member since Feb 2007 · 21 posts
Group memberships: Members
Show profile · Link to this post
Hi there -

Here's an example of what I'm talking about - not anything too fancy.

At http://www.kabissa.org/wiki/ttgo/chapter_1/start you can start reading chapter 1 of our Time To Get Online training manual - it's broken up into wiki pages organized into namespaces.

And here, at http://www.kabissa.org/wiki/ttgo/chapter_1/1.7 you can download the whole chapter all at once - all the preceding pages for the chapter 1 namespace have been combined into one big file - so you only have to edit them once but you can download them all to print out at the same time.

The contents of the whole chapter page just contains a bunch of includes and looks like this:

~~NOTOC~~
====== Entire Chapter 1 ======

{{page>ttgo:chapter_1:start&nofooter}}
====== ======
{{page>ttgo:chapter_1:1.1&nofooter}}
====== ======
{{page>ttgo:chapter_1:1.2&nofooter}}
====== ======
{{page>ttgo:chapter_1:1.3&nofooter}}
====== ======
{{page>ttgo:chapter_1:1.4&nofooter}}
====== ======
{{page>ttgo:chapter_1:1.5&nofooter}}
====== ======
{{page>ttgo:chapter_1:1.6&nofooter}}

The includes code is possible because of the include plugin which you can get here: http://wiki.splitbrain.org/plugin:include

I can't speak to TWiki at all... I've never used it.

Cheers,

Tobias
Tobias Eigen

Kabissa - Space for Change in Africa
http://www.kabissa.org
Avatar
pchan #5
Member since Apr 2007 · 111 posts · Location: Lille, France
Group memberships: Members
Show profile · Link to this post
Subject: dokuWiki to Compiled HTML
Maybe this would be useful for you:

http://rules-of-thumb.com/downloads

proposes a Delphi code to produce a CHM help file from a DokuWiki site.
I haven't tried it myself, but it could help you to produce snapshots of your Knowledge
for use on the field.

Report back!
Avatar
waltergr #6
Member since Jun 2007 · 39 posts
Group memberships: Members
Show profile · Link to this post
In reply to post #2
Tobias, your wiki is beautiful!  Could you describe your setup, e.g. what plugins or themes you are using? 

(In particular, how did you get it to look so Wikipedia-like?  How did you get a Discussion tab for every page?  What do you use to generate the Chapter Contents and forward and back buttons?  What do you use to get the contents treeview in the left column?)

Thanks,

Walter
My e-mail address: waltergr@aol.com
Avatar
ach (Administrator) #7
Member since May 2006 · 1910 posts · Location: Folkestone, UK
Group memberships: Administrators, Members, Super Mods, Wiki Managers
Show profile · Link to this post
how did you get it to look so Wikipedia-like?  How did you get a Discussion tab for every page?

That is answered easily by its template (aka theme): Monobook (http://wiki.splitbrain.org/wiki:tpl:templates#monobook -> http://tatewake.com/wiki/projects:monobook_for_dokuwiki)

What do you use to generate the Chapter Contents and forward and back buttons?  What do you use to get the contents treeview in the left column?

Plugins: See http://www.kabissa.org/wiki/syntax#syntax_plugins
A hint: On every DokuWiki installation you can see what plugins it uses by looking at the very bottom of the wiki:syntax page (as long as that page is not removed, of course).
Avatar
pchan #8
Member since Apr 2007 · 111 posts · Location: Lille, France
Group memberships: Members
Show profile · Link to this post
In reply to post #5
I've just tried the CHM generator. It doesn't finish generating pages (CPU gets used to 100%).
It's a bad idea after all, CHM files don't run PHP code.
Avatar
tobiaseigen #9
Member since Feb 2007 · 21 posts
Group memberships: Members
Show profile · Link to this post
Hi Walter -

I've been wanting to discuss this in more detail but haven't had the time.. thanks for the encouraging feedback.

As discussed, yes, the monobook template provides most of the functionality you're asking about. It has been slightly modified - look at the monobook project page for details on the work I did to it. The other big piece, the navigation menu, is provided by the indexmenu plugin, here:

http://wiki.splitbrain.org/plugin:indexmenu

I just placed the indexmenu code in the navigation page included in the monobook template.. it automatically generates the navigation based on the namespaces and pages within them. The files are displayed in alphabetical order.

The left/right navigation, embarassingly enough, is custom links created manually via dokuwiki. Various solutions have been offered but I have not had the time to implement them properly.. so doing custom links was easiest, even though it has been a hassle for each version of the manual (we now have english, french, arabic).

Cheers,

Tobias
Tobias Eigen

Kabissa - Space for Change in Africa
http://www.kabissa.org
Close Smaller – Larger + Reply to this post:
Verification code: VeriCode Please enter the word from the image into the text field below. (Type the letters only, lower case is okay.)
Smileys: :-) ;-) :-D :-p :blush: :cool: :rolleyes: :huh: :-/ <_< :-( :'( :#: :scared: 8-( :nuts: :-O
Special characters:
Go to forum
Imprint
This board is powered by the Unclassified NewsBoard software, 20150713-dev, © 2003-2015 by Yves Goergen
Current time: 2019-05-26, 17:32:18 (UTC +02:00)