Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

What is a good wiki software for programming tutorials? [closed]

Tags:

wiki-engine

I've noticed that there are awvully few programming tutorials in my native language (Latvian). And one of the best ones seems to have gone permanently offline recently. As such I'm ever more inclined to start writing my own programming tutorial.

Since I'm no writer and free time is scarce, I thought of making this a wiki-thing. This way other interested enthusiasts (I already know a few) could also join in easily.

The question is - which wiki software out there is best suited for such a task? I've a few key features in mind that would be nice to have, I'll list them here:

  • Full Unicode support, since Latvian has some nonstandard characters in it;
  • Revision control;
  • Access control (with anonymous access supported);
  • Code syntax coloring, preferably extensible so that tutorials for different programming languages can be made;
  • Automatic TOC generation from all the pages would be nice (but can be done by hand too);
  • Support for diagrams and mathematical formulas would be nice (but can also be done with picture uploads);
  • The ability to provide a "printable" version for pages would be nice, not to mention a possibility to compile the whole thing in a downloadable e-book.

The server that I have has Linux on it, so preferably no ASP/ASP.NET - but that can be arranged too if really needed.

Added: Well, it seems that there are really just two good candidates - DokuWiki and MediaWiki. Both have the great feature of already having a Latvian localization. I'd go for MediaWiki, as it seems to have at least one major advantage - versioning of attachments. (Plus undoubtedly the best tested wiki system in the world) However I'm afraid if it isn't a bit too over-feature-ful for such a small project. Any comments on this?

like image 703
Vilx- Avatar asked Mar 10 '09 13:03

Vilx-


People also ask

What is the best free wiki tool?

1. Slite. Slite is the wiki tool for thousands of growing companies around the world, and of course, it's our #1. With a clean and clutter-free interface, and features built specifically for remote communication, Slite is the best place to share knowledge with your team.

What is the one of the best among wiki platform where you can create your wiki for free?

MediaWiki is a completely free wiki engine that powers some of the largest wikis in the world, including Wikipedia. It can be used as both, a private wiki and a public one.

Are wikis open-source?

MediaWiki is a free and open-source wiki software package written in PHP. It serves as the platform for Wikipedia and the other Wikimedia projects. MediaWiki is used for projects run by the Wikimedia Foundation, which operates Wikipedia.


3 Answers

The king kong of wiki software is MediaWiki. It supports all the features you specify, including:

  • Unicode (Mediawiki is used by Wikipedia, across hundreds of different countries and languages)
  • Revision control (including rollback, viewing differences between revisions, etc.)
  • Access control (different user levels, anonymous read/write, etc.)
  • Syntax highlighting via an extension
  • TOC generation if you have more than 3 headings in your page
  • Diagrams and formulas via LaTex markup
  • Print CSS style, print page option

In addition the software is run on Linux across Wikipedia I believe, so it has been fully tested on the Linux platform. It's not too difficult to install, but perhaps has the risk of having too many features.

like image 166
rjh Avatar answered Oct 29 '22 01:10

rjh


DokuWiki meets many of your requirements.

  • Unicode
  • Revision History
  • anonymous and authenticated access
  • Syntax Highlighting for many languages, via Geshi
  • automatic TOC
  • diagrams and formulas (via plugins)
  • PHP, so it runs anywhere

It was originally intended as a code documentation wiki. I'm not sure about automatically compiling the entire thing into an e-book. However, plugins are pretty easy to write.

EDIT - there are plugins for generating PDF and other document formats from your pages, so one possibility would be to piece things together using a web crawler.

like image 36
allclaws Avatar answered Oct 29 '22 01:10

allclaws


Sounds like the ideal job for Dokuwiki.

Update: If you are asking yourself (or us) whether Mediawiki isn't a bit too big for your project, maybe you should simply consider the other factors involved.

  • Dokuwiki should run on almost any kind of hardware. I've rarely seen an install that doesn't feel fast and well-performing. It's hard to say the same about Mediawiki.
  • Installing Dokuwiki is a breeze. You should be up and running within 30 minutes.
  • Support. I have no idea how this is with Mediawiki, but the people on the dokuwiki mailing list are very helpful and friendly.

PS: Me biased? Tremendously so!

like image 37
innaM Avatar answered Oct 29 '22 02:10

innaM