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 [[toc ]]
   9
  10 # Installation/Setup questions
  11
  12 (I've moved HarleyPig's problem to its [[own_page|bugs/xgettext_issue]]
  13 --[[Joey]])
  14
  15 ----
  16 # Excellent - how do I translate a TWiki site?
  17
  18 I just discovered ikiwiki quite by chance, I was looking for a console/terminal
  19 menu system and found pdmenu.  So pdmenu brought me to here and I've found ikiwiki!
  20 It looks as if it's just what I've been wanting for a long time.  I wanted something
  21 to create mostly text web pages which, as far as possible, have source which is human
  22 readable or at least in a standard format.  ikiwiki does this twice over by using
  23 markdown for the source and producing static HTML from it.
  24
  25 I'm currently using TWiki and have a fair number of pages in that format, does
  26 anyone have any bright ideas for translating?  I can knock up awk scripts fairly
  27 easily, perl is possible (but I'm not strong in perl).
  28
  29 > Let us know if you come up with something to transition from the other
  30 > format. Another option would be writing a ikiwiki plugin to support the
  31 > TWiki format. --[[Joey]]
  32
  33 > Jamey Sharp and I have a set of scripts in progress to convert other wikis to ikiwiki, including history, so that we can migrate a few of our wikis.  We already have support for migrating MoinMoin wikis to ikiwiki, including conversion of the entire history to Git.  We used this to convert the [XCB wiki](http://xcb.freedesktop.org/wiki/) to ikiwiki; until we finalize the conversion and put the new wiki in place of the old one, you can browse the converted result at <http://xcb.freedesktop.org/ikiwiki>.  We already plan to add support for TWiki (including history, since you can just run parsecvs on the TWiki RCS files to get Git), so that we can convert the [Portland State Aerospace Society wiki](http://psas.pdx.edu) (currently in Moin, but with much of its history in TWiki, and with many of its pages still in TWiki format using Jamey's TWiki format for MoinMoin).
  34 >
  35 > Our scripts convert by way of HTML, using portions of the source wiki's code to render as HTML (with some additional code to do things like translate MoinMoin's `\[[TableOfContents]]` to ikiwiki's `\[[toc ]]`), and then using a modified [[cpan HTML::WikiConverter]] to turn this into markdown and ikiwiki.  This produces quite satisfactory results, apart from things that don't have any markdown equivalent and thus remain HTML, such as tables and definition lists.  Conversion of the history occurs by first using another script we wrote to translate MoinMoin history to Git, then using our git-map script to map a transformation over the Git history.
  36 >
  37 > We will post the scripts as soon as we have them complete enough to convert our wikis.
  38 >
  39 > -- Josh Triplett
  40
  41 >> Thanks for an excellent Xmas present, I will appreciate the additional
  42 >> users this will help switch to ikiwiki! --[[Joey]]
  43
  44 ----
  45
  46 # asciidoc or txt2tags ?
  47
  48 Any plugins or support for using asciidoc or txt2tags as the wiki language and/or exporting to asciidoc or txt2tags?
  49
  50 > No, but it should be quite easy to write such a plugin. The otl plugin
  51 > is a good example of writing a formatting plugin that uses an external
  52 > conversion program, like asciidoc or txt2tags. --[[Joey]]
  53
  54 ----
  55
  56 # LaTeX support?
  57
  58 Any plugins or support for exporting to LaTeX?
  59 (If not could use asciidoc or txt2tags mentioned above to generated LaTeX.)
  60
  61 > It's already [[been_requested|todo/latex]], although perhaps not
  62 > working the way you're thinking of. Noone is currently working on it.
  63 > --[[Joey]]
  64
  65 >> I did some tests with using Markdown and a customized HTML::Latex and html2latex
  66 >> and it appears it will work for me now. (I hope to use ikiwiki for many
  67 >> to collaborate on a printed book that will be generated at least once per day in PDF format.)
  68 >>
  69 >> --JeremyReed
  70
  71 >>> Have a look at [pandoc](http://code.google.com/p/pandoc/).  It can make PDFs via pdflatex. --[[roktas]]
  72
  73 ----
  74
  75 # Using with CVS?
  76
  77 Any examples of using ikiwiki with cvs?
  78
  79 > No, although the existing svn backend could fairly esily be modified into
  80 > a CVS backend, by someone who doesn't mind working with CVS. --[[Joey]]
  81
  82 ----
  83
  84 # Show differences before saving page?
  85
  86 It would be nice to be able to have a button to show "Differences" (or "Show Diff") when
  87 editing a page. Is that an option that can be enabled?
  88
  89 > It's doable, it could even be done by a [[todo/plugin]], I think.
  90 > --[[Joey]]
  91
  92 ----
  93
  94 # Max submit size?
  95
  96 Any setting for limiting how many kilobytes can be submitted via the "edit" form?
  97 -- [[JeremyReed]]
  98
  99 > Not currently. Worried about abuse? --[[Joey]]
 100
 101 >> I didn't want it abused accidently or with malice. I was thinking that Perl's CGI.pm would handle this, but I don't see that.
 102 >> I read that textarea max bytes may be 500 lines or 28000 characters or 30000 characters or 64kB. It seems like it
 103 >> varies and I didn't test myself, because I guess it may depend on different clients and different HTTP servers.
 104 >> This could be checked using javascript on the client side (before submitting) and by checking size on server side (before saving). --[[JeremyReed]]
 105
 106 >>> The absolute limit varies by browser. If there are web servers that
 107 >>> also limit it, I don't know of them. --[[Joey]]
 108
 109 ----
 110
 111 # Access Keys
 112
 113 Would anyone else find this a valuable addition.  In oddmuse and instiki (the only other
 114 wiki engines I am currently using, the edit, home, and submit link tags have an
 115 accesskey attribute.  I find it nice not to have to resort to the mouse for those
 116 actions.  However, it may not be something everyone appreciates.  Any thoughts?
 117 --[Mazirian](http://mazirian.com)
 118
 119 > Maybe, although it would need to take the critisism at
 120 > http://www.cs.tut.fi/~jkorpela/forms/accesskey.html into account.
 121
 122 >> Thank you for that link. Given that the edit link is the first thing you tab to
 123 >> in the current layout, I guess it isn't all that necessary. I have had a
 124 >> a user complaint recently that Alt-e in oddmuse was overriding his access
 125 >> to the browser menu.
 126
 127 ----
 128
 129 # Editing the style sheet.
 130
 131 It would be nice to be able to edit the stylesheet by means of the cgi.  Or is this possible?  I wasn't able to achieve it.
 132 Ok, that's my last 2 cents for a while. --[Mazirian](http://mazirian.com)
 133
 134 > I don't support editing it, but if/when ikiwiki gets file upload support,
 135 > it'll be possible to upload a style sheet. (If .css is in the allowed
 136 > extensions list.. no idea how safe that would be, a style sheet is
 137 > probably a great place to put XSS attacks and evil javascript that would
 138 > be filtered out of any regular page in ikiwiki). --[[Joey]]
 139
 140 >> I hadn't thought of that at all.  It's a common feature and one I've
 141 >> relied on safely, because the wikis I am maintaining at the moment
 142 >> are all private and restricted to trusted users. Given that the whole
 143 >> point of ikiwiki is to be able to access and edit via the shell as
 144 >> well as the web, I suppose the features doesn't add a lot.  By the
 145 >> way, the w3m mode is brilliant.  I haven't tried it yet, but the idea
 146 >> is great.
 147
 148 ----
 149
 150 # Should not create an existing page
 151
 152 This might be a bug, but will discuss it here first.
 153 Clicking on an old "?" or going to a create link but new Markdown content exists, should not go into "create" mode, but should do a regular "edit".
 154
 155 > I belive that currently it does a redirect to the new static web page.
 156 > At least that's the intent of the code. --[[Joey]]
 157
 158 >> Try at your site: `?page=discussion&from=index&do=create`
 159 >> It brings up an empty textarea to start a new webpage -- even though it already exists here. --reed
 160
 161 >>> Ah, right. Notice that the resulting form allows saving the page as
 162 >>> discussion, or users/discussion, but not index/discussion, since this
 163 >>> page already exists. If all the pages existed, it would do the redirect
 164 >>> thing. --[[Joey]]
 165
 166 ----
 167
 168 # User database tools?
 169
 170 Any tool to view user database?
 171
 172 Any tool to edit the user database?
 173
 174 > No, but it's fairly easy to write such tools in perl. For example, to
 175 > list all users in the user database:
 176
 177         joey@kodama:~/src/joeywiki/.ikiwiki>perl -le 'use Storable; my $userinfo=Storable::retrieve("userdb"); print $_ foreach keys %$userinfo'
 178         http://joey.kitenet.net/
 179         foo
 180
 181 > To list each user's email address:
 182
 183         joey@kodama:~/src/joeywiki/.ikiwiki>perl -le 'use Storable; my $userinfo=Storable::retrieve("userdb"); print $userinfo->{$_}->{email} foreach keys %$userinfo'
 184
 185         joey@kitenet.net
 186
 187 > Editing is simply a matter of changing values and calling Storable::store().
 188 > I've not written actual utilities to do this yet because I've only needed
 189 > to do it rarely, and the data I've wanted has been different each time.
 190 > --[[Joey]]