doc/index/discussion.mdwn

   1 Seems like there should be a page for you to post your thoughts about
   2 ikiwiki, both pro and con, anything that didn't work, ideas, or whatever.
   3 Do so here..
   4
   5 Note that for more formal bug reports or todo items, you can also edit the
   6 [[bugs]] and [[todo]] pages.
   7
   8 # Installation/Setup questions
   9
  10 I have just installed ikiwiki and it works - at least I have the example index.mdwn page
  11 compiled and visible.  However I have a few issues/problems:-
  12
  13 * A couple of the 'optional' Perl modules aren't optional, you can't install ikiwiki without them,
  14 these are HTML::Template and HTML::Scrubber (at least I think it was these two, it's a bit messy
  15 to go back and find out).
  16
  17 > You're right, HTML::Template is required. HTML::Scrubber is only required
  18 > in the default configuration, and is optional if the htmlscrubber plugin
  19 > is disabled. --[[Joey]]
  20
  21 * I don't seem to have got an ikiwiki man page created.
  22
  23 > It should be installed in /usr/share/man, or a similar directory
  24 > depending on how your perl is set up and how you did the install.
  25 > --[[Joey]]
  26
  27 > Found it, in /usr/local/share/man, since no other man pages are in either /usr/share/man or in /usr/local/share/man the ikiwiki
  28 > man page is a bit lonely, and more to the point not on my MANPATH.  Still I have found it now, I'll just move it to somewhere
  29 > more sensible. [[Chris]]
  30
  31 * Running "ikiwiki --setup ikiwiki.setup" doesn't do anything.  I have edited ikiwiki.setup to
  32 my local settings.  There are no errors but neither does anything get compiled.  An ikiwiki
  33 command to explicitly do the compile works fine.  Am I misunderstanding something here?
  34
  35 > Further tests indicate that ikiwiki isn't seeing changed files so doesn't always rebuild.
  36 > How does ikiwiki decide when to rebuild?  I tried a full command line like "ikiwiki --verbose ikiwiki ~/public_html/ikiwiki --url=http://www.isbd.ltd.uk/~chris/ikiwiki/" and that doesn't do anything
  37 either though it was the command line I originally used to compile.  After a long interval I 'touch'ed
  38 the files and then it *did* compile but 'touch'ing the files after a few minutes only doesn't seem to force a recompile.  I'm even more confused!
  39
  40 > ikiwiki only compiles files whose modification times have changed. It
  41 > should see any change made as close as a second after the last compile.
  42 > When run with --setup, ikiwiki always rebuilds every file in the wiki. If
  43 > --setup is not working, you must have it pointed at the wrong path or
  44 > something; you can pass -v to see what it's doing. I don't know why it
  45 > would not see recently changed files; you could try stracing it.
  46 > --[[Joey]]
  47
  48 > OK, thanks, I don't quite know what was happening before but it seems to be working right now.
  49 > --[[Chris]]
  50
  51 >> Weird. I wish I knew what happened, but as it's working now, I'm
  52 >> guessing some kind of user error was involved. --[[Joey]]
  53
  54 * I wish there was a mailing list, much easier for this sort of stuff than this, apart from
  55 anything else I get to use a decent editor.
  56
  57 ----
  58 # Excellent - how do I translate a TWiki site?
  59
  60 I just discovered ikiwiki quite by chance, I was looking for a console/terminal
  61 menu system and found pdmenu.  So pdmenu brought me to here and I've found ikiwiki!
  62 It looks as if it's just what I've been wanting for a long time.  I wanted something
  63 to create mostly text web pages which, as far as possible, have source which is human
  64 readable or at least in a standard format.  ikiwiki does this twice over by using
  65 markdown for the source and producing static HTML from it.
  66
  67 I'm currently using TWiki and have a fair number of pages in that format, does
  68 anyone have any bright ideas for translating?  I can knock up awk scripts fairly
  69 easily, perl is possible (but I'm not strong in perl).
  70
  71 > Let us know if you come up with something to transition from the other
  72 > format. Another option would be writing a ikiwiki plugin to support the
  73 > TWiki format. --[[Joey]]
  74
  75 ----
  76
  77 # OpenID
  78
  79 I just figured I'd edit something on the page with my OpenID, since you've implemented it! --*[Kyle](http://kitenet.net/~kyle/)*=
  80
  81 > Kyle, If you like openid, I can switch your personal wiki over to use your openid. --[[Joey]]
  82
  83 ----
  84
  85 # ACL
  86
  87 How about adding ACL? So that you can control which users are allowed
  88 to read, write certain pages. The moinmoin wiki has that, and it is
  89 something, that I think is very valuable.
  90
  91 > ikiwiki currently has only the most rudimentary access controls: pages
  92 > can be locked, or unlocked and only the admin can edit locked pages. That
  93 > could certianly be expanded on, although it's not an area that I have an
  94 > overwhelming desire to work on myself right now. Patches appreciated and
  95 > I'll be happy to point you in the right directions.. --[[Joey]]
  96
  97 >> I'm really curious how you'd suggest implementing ACLs on reading a page.
  98 >> It seems to me the only way you could do it is .htaccess DenyAll or something,
  99 >> and then route all page views through ikiwiki.cgi. Am I missing something?
 100 >> --[[Ethan]]
 101
 102 >>> Or you could just use apache or whatever and set up the access controls
 103 >>> there. Of course, that wouldn't integrate very well with the wiki,
 104 >>> unless perhaps you decided to use http basic authentication and the
 105 >>> httpauth plugin for ikiwiki that integrates with that.. --[[Joey]]
 106
 107 >>>> Which would rule out openid, or other fun forms of auth. And routing all access
 108 >>>> through the CGI sort of defeats the purpose of ikiwiki. --[[Ethan]]
 109
 110 ----
 111
 112 Some questions about the RecentChanges function. -- Ethan
 113
 114 > (Moved to [[todo/recentchanges]] --[[Joey]])
 115
 116 ----
 117
 118 Also, I'd like to request another template parameter which is just
 119 $config{url}. That way you won't have to hard-code the URL of the wiki into
 120 the template. -- Ethan
 121
 122 > That's already available in the BASEURL parameter. --[[Joey]]
 123
 124 ----
 125
 126 # Canonical feed location?
 127
 128 Any way to use `inline` but point the feed links to a different feed on the
 129 same site?  I have news in news/*, a news archive in news.mdwn, and the
 130 first few news items on index.mdwn, but I don't really want two separate
 131 feeds, one with all news and one with the latest few articles; I'd rather
 132 point the RSS feed links of both to the same feed.  (Which one, the one
 133 with all news or the one with the latest news only, I don't know yet.)
 134
 135 > Not currently. It could be implemented, or you could just turn off the
 136 > rss feed for the index page, and manually put in a wikilink to the news
 137 > page and rss feed. --[[Joey]]
 138
 139 >> That wouldn't use the same style for the RSS and Atom links, and it
 140 >> wouldn't embed the feed link into `<head>` so that browsers can automatically
 141 >> find it.
 142
 143 ----
 144
 145 # asciidoc or txt2tags ?
 146
 147 Any plugins or support for using asciidoc or txt2tags as the wiki language and/or exporting to asciidoc or txt2tags?
 148
 149 > No, but it should be quite easy to write such a plugin. The otl plugin
 150 > is a good example of writing a formatting plugin that uses an external
 151 > conversion program, like asciidoc or txt2tags. --[[Joey]]
 152
 153 ----
 154
 155 # LaTeX support?
 156
 157 Any plugins or support for exporting to LaTeX?
 158 (If not could use asciidoc or txt2tags mentioned above to generated LaTeX.)
 159
 160 > It's already [[been_requested|todo/latex]], although perhaps not
 161 > working the way you're thinking of. Noone is currently working on it.
 162 > --[[Joey]]
 163
 164 ----
 165
 166 # Using with RCS?
 167
 168 Any examples of using co(1), ci(1) and other RCS related tools with ikiwiki?
 169
 170 > I don't belive that RCS offers enough SCM features to be useable as a
 171 > fullfledged backend to ikiwiki. For one thing, there's no way to have
 172 > hook scripts run when changes are ci'd, is there? So you'd have to ci and
 173 > then manually run ikiwiki. It should be possible to do an RCS backend
 174 > that supports web commits with ci, and history (parsing the rcs files by
 175 > hand?). If you're a masochist. :-) --[[Joey]]
 176
 177 ----
 178
 179 # Using with CVS?
 180
 181 Any examples of using ikiwiki with cvs?
 182
 183 > No, although the existing svn backend could fairly esily be modified into
 184 > a CVS backend, by someone who doesn't mind working with CVS. --[[Joey]]
 185
 186 ----
 187
 188 # Show differences before saving page?
 189
 190 It would be nice to be able to have a button to show "Differences" (or "Show Diff") when
 191 editing a page. Is that an option that can be enabled?
 192
 193 > It's doable, it could even be done by a [[todo/plugin]], I think.
 194 > --[[Joey]]