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 Ikiwiki creates a .ikiwiki directory in my wikiwc working directory. Should I
  13 "svn add .ikiwiki" or add it to svn:ignore?
  14
  15 > `.ikiwiki` is used by ikiwiki to store internal state. You can add it to
  16 > svn:ignore. --[[Joey]]
  17 > > Thanks a lot.
  18
  19 Is there an easy way to log via e-mail to some webmaster address, instead
  20 of via syslog?
  21
  22 > Not sure why you'd want to do that, but couldn't you use a tool like
  23 > logwatch to mail selected lines from the syslog? --[[Joey]]
  24
  25 > > The reason is that I'm not logged in on the web server regularly to
  26 > > check the log files. I'll see whether I can install a logwatch instance.
  27
  28 ----
  29 # Excellent - how do I translate a TWiki site?
  30
  31 I just discovered ikiwiki quite by chance, I was looking for a console/terminal
  32 menu system and found pdmenu.  So pdmenu brought me to here and I've found ikiwiki!
  33 It looks as if it's just what I've been wanting for a long time.  I wanted something
  34 to create mostly text web pages which, as far as possible, have source which is human
  35 readable or at least in a standard format.  ikiwiki does this twice over by using
  36 markdown for the source and producing static HTML from it.
  37
  38 I'm currently using TWiki and have a fair number of pages in that format, does
  39 anyone have any bright ideas for translating?  I can knock up awk scripts fairly
  40 easily, perl is possible (but I'm not strong in perl).
  41
  42 > Let us know if you come up with something to transition from the other
  43 > format. Another option would be writing a ikiwiki plugin to support the
  44 > TWiki format. --[[Joey]]
  45
  46 > 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).
  47 >
  48 > 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.
  49 >
  50 > We will post the scripts as soon as we have them complete enough to convert our wikis.
  51 >
  52 > -- [[JoshTriplett]]
  53
  54 >> Thanks for an excellent Xmas present, I will appreciate the additional
  55 >> users this will help switch to ikiwiki! --[[Joey]]
  56
  57 ----
  58
  59 # LaTeX support?
  60
  61 Moved to [[todo/latex]] --[[Joey]]
  62
  63 ----
  64
  65 # Using with CVS?
  66
  67 Moved to a [[todo_item|todo/CVS_backend]]. --[[JoshTriplett]]
  68
  69 ----
  70
  71 # Show differences before saving page?
  72
  73 Moved to the existing [[todo_item|todo/preview_changes]]. --[[JoshTriplett]]
  74
  75 ----
  76
  77 # Max submit size?
  78
  79 Any setting for limiting how many kilobytes can be submitted via the "edit" form?
  80 -- [[JeremyReed]]
  81
  82 >>> See [[todo/fileupload]] for an idea on limiting page size. --[[Joey]]
  83
  84 ----
  85
  86 # Access Keys
  87
  88 Would anyone else find this a valuable addition.  In oddmuse and instiki (the only other
  89 wiki engines I am currently using, the edit, home, and submit link tags have an
  90 accesskey attribute.  I find it nice not to have to resort to the mouse for those
  91 actions.  However, it may not be something everyone appreciates.  Any thoughts?
  92 --[Mazirian](http://mazirian.com)
  93
  94 > Maybe, although it would need to take the critisism at
  95 > <http://www.cs.tut.fi/~jkorpela/forms/accesskey.html> into account.
  96
  97 >> Thank you for that link. Given that the edit link is the first thing you tab to
  98 >> in the current layout, I guess it isn't all that necessary. I have had a
  99 >> a user complaint recently that Alt-e in oddmuse was overriding his access
 100 >> to the browser menu.
 101
 102 ----
 103
 104 # Editing the style sheet.
 105
 106 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.
 107 Ok, that's my last 2 cents for a while. --[Mazirian](http://mazirian.com)
 108
 109 > I don't support editing it, but if/when ikiwiki gets [[todo/fileupload]] support,
 110 > it'll be possible to upload a style sheet. (If .css is in the allowed
 111 > extensions list.. no idea how safe that would be, a style sheet is
 112 > probably a great place to put XSS attacks and evil javascript that would
 113 > be filtered out of any regular page in ikiwiki). --[[Joey]]
 114
 115 >> I hadn't thought of that at all.  It's a common feature and one I've
 116 >> relied on safely, because the wikis I am maintaining at the moment
 117 >> are all private and restricted to trusted users. Given that the whole
 118 >> point of ikiwiki is to be able to access and edit via the shell as
 119 >> well as the web, I suppose the features doesn't add a lot.  By the
 120 >> way, the w3m mode is brilliant.  I haven't tried it yet, but the idea
 121 >> is great.
 122
 123 ----
 124
 125 # Should not create an existing page
 126
 127 This might be a bug, but will discuss it here first.
 128 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".
 129
 130 > I belive that currently it does a redirect to the new static web page.
 131 > At least that's the intent of the code. --[[Joey]]
 132
 133 >> Try at your site: `?page=discussion&from=index&do=create`
 134 >> It brings up an empty textarea to start a new webpage -- even though it already exists here. --reed
 135
 136 >>> Ah, right. Notice that the resulting form allows saving the page as
 137 >>> discussion, or users/discussion, but not index/discussion, since this
 138 >>> page already exists. If all the pages existed, it would do the redirect
 139 >>> thing. --[[Joey]]
 140
 141 ----
 142
 143 # User database tools?
 144
 145 Any tool to view user database?
 146
 147 Any tool to edit the user database?
 148
 149 > No, but it's fairly easy to write such tools in perl. For example, to
 150 > list all users in the user database:
 151
 152         joey@kodama:~/src/joeywiki/.ikiwiki>perl -le 'use Storable; my $userinfo=Storable::retrieve("userdb"); print $_ foreach keys %$userinfo'
 153         http://joey.kitenet.net/
 154         foo
 155
 156 > To list each user's email address:
 157
 158         joey@kodama:~/src/joeywiki/.ikiwiki>perl -le 'use Storable; my $userinfo=Storable::retrieve("userdb"); print $userinfo->{$_}->{email} foreach keys %$userinfo'
 159
 160         joey@kitenet.net
 161
 162 > Editing is simply a matter of changing values and calling Storable::store().
 163 > I've not written actual utilities to do this yet because I've only needed
 164 > to do it rarely, and the data I've wanted has been different each time.
 165 > --[[Joey]]