doc/bugs/Filenames_with_colons_cause_problems_for_Windows_users.mdwn

   1 (Note: feel free to say "not a bug" or offer a workaround rather than changing ikiwiki.)
   2
   3 As reported by a Windows user trying ikiwiki: because Windows doesn't support filenames with colons, he couldn't check out the ikiwiki svn repository.  More generally, ikiwiki doesn't encode colons in filenames for wiki pages, but to support Windows users perhaps it should.
   4
   5 Windows does not support filenames containing any of these characters: `/ \ * : ? " < > |`
   6
   7 > I take it this is a problem when checking out a wiki in windows, not when
   8 > browsing to urls that have colons in them from windows? --[[Joey]]
   9
  10 >> Correct.  You can't directly check out a wiki's repository from Windows if it includes filenames with those characters; you will get errors on those filenames.
  11
  12 >>> Ok, first, if a windows user fails to check out ikiwiki's own svn^Wgit
  13 >>> repo on windows due to the colons, that seems to be a bug in svn^Wgit
  14 >>> on windows -- those programs should deal with colons in filenames being
  15 >>> checked in/out somehow. Like they deal with windows using backslash
  16 >>> rather than slash, presumably. And there's nothing ikiwiki can do if
  17 >>> the source repo it's working on has a file with a problem character
  18 >>> added to it, since the breakage will happen at the revision control
  19 >>> system level.
  20 >>>
  21 >>> OTOH, there are some simple mods to ikiwiki that can make it escape
  22 >>> colons etc the same way it already escapes other problem characters
  23 >>> like "*", "?", etc. Without actually testing it, it should suffice to
  24 >>> edit `IkiWiki.pm` and modify `titlepage` and `linkpage`, removing the
  25 >>> colon from the character class in each. Also modify the
  26 >>> `wiki_file_regexp` similarly. Then ikiwiki will read and
  27 >>> write files with escaped colons, avoiding the problem.
  28 >>>
  29 >>> So that's a simple fix, but on the gripping hand, I can't just make
  30 >>> that change, because it would break all existing unix-based
  31 >>> wikis that actually contain colons in their filenames, requiring an
  32 >>> annoying transition. I could do a OS test and do it in Windows, but then
  33 >>> there would be interop problems if a Windows and non-windows system both
  34 >>> acted on the same wiki source.
  35 >>>
  36 >>> So, I guess it has to be a config option, possibly defaulting on
  37 >>> when the OS is Windows. And if being able to checkout/etc the wiki
  38 >>> source on windows systems is desired, you'd have to remember to turn
  39 >>> that on when setting up a wiki, even if the wiki was hosted on unix.
  40 >>>
  41 >>> BTW, I suspect there are lots of other problems with actually running
  42 >>> ikiwiki on windows, including its assumption that the directory
  43 >>> separator is "/". --[[Joey]]