On Wed, Dec 17, 2014 at 03:13:32PM +0100, Markus Armbruster wrote:
"Kevin O'Connor" kevin@koconnor.net writes:
On Wed, Dec 17, 2014 at 01:01:59PM +0100, Gerd Hoffmann wrote:
I'm not sure if doing this is a good idea. It would be nice to have the documents in version control, and it would be good to allow patches to simultaneously update the code and documentation. However, modifying wiki syntax from an editor isn't that easy.
I don't see editing wiki syntax in $editor as a problem.
The really long lines are annoying to work with. git-send-email even complains about lines over 998 characters long.
A sufficiently powerful editor (Emacs: visual-line-mode) should make it somewhat less annoying. Alternatively, edit *only* in an editor, and avoid long lines.
It's the mediawiki syntax that drives the long lines - certain features, like lists, can't have newlines in them or they end the list. Normal paragraphs can actually have newlines in them, but if you put a newline in the middle of some syntax (like a link) then it wont interpet that syntax. This makes a normal editor's auto line wrap feature unusable.
Finally, there is the difficulty in "previewing" changes to see what it will ultimately look like.
It's all possible to handle, but annoying.
But what is the plan for the wiki then? Discontinue? Switch to read-only and update from git? Two-way sync between wiki+git?
Update the wiki from git. Right now, only I have write access to the wiki anyway (as no one has requested a wiki account). A solution other than a wiki is also possible, but that wasn't something I was thinking of, at least in the short term.
Should two-way become desirable, a Wiki backed by git and included as a submodule could be practical.
-Kevin