]> sipb.mit.edu Git - ikiwiki.git/blob - doc/index/discussion.mdwn
fix bazaar id
[ikiwiki.git] / 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
30 # Installation of selected docs (html)
31
32 The latest release has around 560 files (over 2MB) in html.
33
34 Any suggestions or ideas on limiting what html is installed?
35
36 For example, I don't see value in every ikiwiki install out there to also install personal "users" ikiwiki pages.
37
38 For now I copy ikiwiki.setup. And then use pax with -L switch to copy the targets of the symlinks of the basewiki.
39
40 I was thinking of making a list of desired documents from the html directory to install.
41
42 --JeremyReed
43
44 > You don't need any of them, unless you want to read ikiwiki's docs locally.
45
46 > I don't understand why you're installing the basewiki files manually;
47 > ikiwiki has a Makefile that will do this for you. --[[Joey]]
48
49 >> The Makefile's install doesn't do what I want so I use different installer for it.
50 >> It assumes wrong location for man pages for me. (And it should consider using INSTALLVENDORMAN1DIR and
51 >> MAN1EXT but I don't know about section 8 since I don't know of perl value for that.)
52 >> I don't want w3m cgi installed; it is optional for my package.
53 >> I will just patch for that instead of using my own installer.
54 >> Note: I am working on the pkgsrc package build specification for this. This is for creating
55 >> packages for NetBSD, DragonFly and other systems that use pkgsrc package system.
56 >> --JeremyReed
57
58 # Installation as non-root user
59
60 I'd like to install ikiwiki as a non-root user. I can plow through getting all the 
61 perl dependencies installed because that's well documented in the perl world,
62 but I don't know how to tell ikiwiki to install somewhere other than / --BrianWilson
63
64 ----
65
66 # Upgrade steps
67
68 I upgrades from 1.40  to 2.6.1. I ran "ikiwiki --setup" using my existing ikiwiki.setup configuration.
69 I had many errors like:
70
71     /home/bsdwiki/www/wiki/wikilink/index.html independently created, not overwriting with version from wikilink
72     BEGIN failed--compilation aborted at (eval 5) line 129.
73
74 and:
75
76     failed renaming /home/bsdwiki/www/wiki/smileys.ikiwiki-new to /home/bsdwiki/www/wiki/smileys: Is a directory
77     BEGIN failed--compilation aborted at (eval 5) line 129.
78
79 Probably about six errors like this. I worked around this by removing the files and directories it complained about.
80 Finally it finished.
81
82 > As of version 2.0, ikiwiki enables usedirs by default. See
83 > [[tips/switching_to_usedirs]] for details. --[[Joey]]
84
85 >> I read the config wrong. I was thinking that it showed the defaults even though commented out
86 >> (like ssh configs do). I fixed that part. --JeremyReed
87
88 My next problem was that ikiwiki start letting me edit without any password authentication. It used to prompt
89 me for a password but now just goes right into the "editing" mode.
90 The release notes for 2.0 say password auth is still on by default.
91
92 > It sounds like you have the anonok plugin enabled?
93
94 >> Where is the default documented? My config doesn't have it uncommented.
95
96 The third problem is that when editing my textbox is empty -- no content.
97
98 This is using my custom rcs.pm which has been used thousands of times.
99
100 > Have you rebuilt the cgi wrapper since you upgraded ikiwiki? AFAIK I
101 > fixed a bug that could result in the edit box always being empty back in
102 > version 2.3. The only other way it could happen is if ikiwiki does not
103 > have saved state about the page that it's editing (in .ikiwiki/index).
104
105 >> Rebuilt it several times. Now that I think of it, I think my early problem of having
106 >> no content in the textbox was before I rebuilt the cgi. And after I rebuilt the whole webpage was empty.
107
108 Now I regenerated my ikiwiki.cgi again (no change to my configuration,
109 and I just get an empty HTML page when attempting editing or "create".
110
111 > If the page is completly empty then ikiwiki is crashing before it can
112 > output anything, though this seems unlikely. Check the webserver logs.
113
114 Now I see it created directories for my data. I fixed that by setting 
115 usedirs (I see that is in the release notes for 2.0) and rerunning ikiwiki --setup
116 but I still have empty pages for editing (no textbox no html at all).
117
118 > Is IkiWiki crashing? If so, it would probably leave error text in the apache logs. --[[TaylorKillian]]
119
120 >> Not using apache. Nothing useful in logs other thn the HTTP return codes are "0" and bytes is "-"
121 >> on the empty ikiwiki.cgi output (should say " 200 " followed by bytes).
122
123 >>> You need to either figure out what your web server does with stderr
124 >>> from cgi programs, or run ikiwiki.cgi at the command line with an
125 >>> appropriate environment so it thinks it's being called from a web
126 >>> server, so you can see how it's failing. --[[Joey]]
127
128 (I am posting this now, but will do some research and post some more.)
129
130 Is there any webpage with upgrade steps?
131
132 > Users are expected to read [[news]], which points out any incompatible
133 > changes or cases where manual action is needed.
134
135 >> I read it but read the usedirs option wrong :(.
136 >> Also it appears to be missing the news from between 1.40 to 2.0 unless they dont' exist.
137 >> If they do exist maybe they have release notes I need?
138
139 >>> All the old ones are in the NEWS file. --[[Joey]]
140
141 --JeremyReed
142
143 My followup: I used a new ikiwiki.setup based on the latest version. But no changes for me.
144
145 Also I forgot to mention that do=recentchanges works good for me. It uses my 
146 rcs_recentchanges in my rcs perl module.
147
148 The do=prefs does nothing though -- just a blank webpage.
149
150 > You need to figure out why ikiwiki is crashing. The webserver logs should
151 > tell you.
152
153 I also set verbose => 1 and running ikiwiki --setup was verbose, but no changes in running CGI.
154 I was hoping for some output.
155
156 I am guessing that my rcs perl module stopped working on the upgrade. I didn't notice any release notes
157 on changes to revision control modules. Has something changed? I will also look.
158
159 > No, the rcs interface has not needed to change in a long time. Also,
160 > nothing is done with the rcs for do=prefs.
161
162 >> Thanks. I also checked differences between 1.40 Rcs plugins and didn't notice anything significant.
163
164 --JeremyReed
165
166 Another Followup: I created a new ikiwiki configuration and did the --setup to 
167 create an entirely different website. I have same problem there. No prompt for password
168 and empty webpage when using the cgi.
169 I never upgraded any perl modules so maybe a new perl module is required but I don't see any errors so I don't know.
170
171 The only errors I see when building and installing ikiwiki are:
172
173     Can't exec "otl2html": No such file or directory at IkiWiki/Plugin/otl.pm line 66.
174
175     gettext 0.14 too old, not updating the pot file
176
177 I don't use GNU gettext on here.
178
179 I may need to revert back to my old ikiwiki install which has been used to thousands of times (with around
180 1000 rcs commits via ikiwiki).
181
182 --JeremyReed
183
184 I downgraded to version 1.40 (that was what I had before I wrote wrong above).
185 Now ikiwiki is working for me again (but using 1.40). I shouldn't have tested on production system :)
186
187 --JeremyReed
188
189 I am back. On a different system, I installed ikiwiki 2.6.1. Same problem -- blank CGI webpage.
190
191 So I manually ran with:
192
193     REQUEST_METHOD=GET QUERY_STRING='do=create&page=jcr' kiwiki.cgi
194
195 And clearly saw the error:
196
197     [IkiWiki::main] Fatal: Bad template engine CGI::FormBuilder::Template::div: Can't locate CGI/FormBuilder/Template/div.pm
198
199 So I found my version was too old and 3.05 is the first to provide "Div" support. I upgraded my p5-CGI-FormBuilder to 3.0501.
200 And ikiwiki CGI started working for me.
201
202 The Ikiwiki docs about this requirement got removed in Revision 4367. There should be a page that lists the requirements.
203 (I guess I could have used the debian/control file.)
204
205 > There is a page, [[install]] documents that 3.05 is needed.
206
207 >> Sorry, I missed that. With hundreds of wikipages it is hard to read all of them.
208 >> I am updating the download page now to link to it.
209
210 I am now using ikiwiki 2.6.1 on my testing system.
211
212 --JeremyReed
213
214 ----
215 # Excellent - how do I translate a TWiki site?
216
217 I just discovered ikiwiki quite by chance, I was looking for a console/terminal
218 menu system and found pdmenu.  So pdmenu brought me to here and I've found ikiwiki!
219 It looks as if it's just what I've been wanting for a long time.  I wanted something
220 to create mostly text web pages which, as far as possible, have source which is human 
221 readable or at least in a standard format.  ikiwiki does this twice over by using 
222 markdown for the source and producing static HTML from it.
223
224 I'm currently using TWiki and have a fair number of pages in that format, does
225 anyone have any bright ideas for translating?  I can knock up awk scripts fairly
226 easily, perl is possible (but I'm not strong in perl).
227
228 > Let us know if you come up with something to transition from the other
229 > format. Another option would be writing a ikiwiki plugin to support the
230 > TWiki format. --[[Joey]]
231
232 > 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).
233 >
234 > 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.
235 >
236 > We will post the scripts as soon as we have them complete enough to convert our wikis.
237 >
238 > -- [[JoshTriplett]]
239
240 >> Thanks for an excellent Xmas present, I will appreciate the additional 
241 >> users this will help switch to ikiwiki! --[[Joey]]
242
243
244 >> Sounds great indeed. Learning from [here](http://www.bddebian.com/~wiki/AboutTheTWikiToIkiwikiConversion/) that HTML::WikiConverter needed for your conversion was not up-to-date on Debian I have now done an unofficial package, including your proposed Markdown patches, apt-get'able at <pre>deb http://debian.jones.dk/ sid wikitools</pre>
245 >> -- [[JonasSmedegaard]]
246
247
248 >>I see the "We will post the scripts ...." was committed about a year ago.  A current site search for "Moin" does not turn them up.  Any chance of an appearance in the near (end of year) future?
249 >>
250 >> -- [[MichaelRasmussen]]
251
252 ----
253
254 # LaTeX support?
255
256 Moved to [[todo/latex]] --[[Joey]]
257
258 ----
259
260 # Using with CVS?
261
262 Moved to a [[todo_item|todo/CVS_backend]]. --[[JoshTriplett]]
263
264 ----
265
266 # Show differences before saving page?
267
268 Moved to the existing [[todo_item|todo/preview_changes]]. --[[JoshTriplett]]
269
270 ----
271
272 # Max submit size?
273
274 Any setting for limiting how many kilobytes can be submitted via the "edit" form?
275 -- [[JeremyReed]]
276
277 >>> See [[todo/fileupload]] for an idea on limiting page size. --[[Joey]]
278
279 ----
280
281 # Access Keys
282
283 Would anyone else find this a valuable addition.  In oddmuse and instiki (the only other
284 wiki engines I am currently using, the edit, home, and submit link tags have an
285 accesskey attribute.  I find it nice not to have to resort to the mouse for those
286 actions.  However, it may not be something everyone appreciates.  Any thoughts?
287 --[Mazirian](http://mazirian.com)
288
289 > Maybe, although it would need to take the critisism at
290 > <http://www.cs.tut.fi/~jkorpela/forms/accesskey.html> into account.
291
292 >> Thank you for that link. Given that the edit link is the first thing you tab to
293 >> in the current layout, I guess it isn't all that necessary. I have had a 
294 >> a user complaint recently that Alt-e in oddmuse was overriding his access
295 >> to the browser menu.
296
297 ----
298
299 # Editing the style sheet.
300
301 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.
302 Ok, that's my last 2 cents for a while. --[Mazirian](http://mazirian.com)
303
304 > I don't support editing it, but if/when ikiwiki gets [[todo/fileupload]] support,
305 > it'll be possible to upload a style sheet. (If .css is in the allowed
306 > extensions list.. no idea how safe that would be, a style sheet is
307 > probably a great place to put XSS attacks and evil javascript that would
308 > be filtered out of any regular page in ikiwiki). --[[Joey]]
309
310 >> I hadn't thought of that at all.  It's a common feature and one I've
311 >> relied on safely, because the wikis I am maintaining at the moment
312 >> are all private and restricted to trusted users. Given that the whole
313 >> point of ikiwiki is to be able to access and edit via the shell as
314 >> well as the web, I suppose the features doesn't add a lot.  By the
315 >> way, the w3m mode is brilliant.  I haven't tried it yet, but the idea
316 >> is great.
317
318 ----
319
320 # Should not create an existing page
321
322 This might be a bug, but will discuss it here first.
323 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".
324
325 > I belive that currently it does a redirect to the new static web page.
326 > At least that's the intent of the code. --[[Joey]]
327
328 >> Try at your site: `?page=discussion&from=index&do=create`
329 >> It brings up an empty textarea to start a new webpage -- even though it already exists here. --reed
330
331 >>> Ah, right. Notice that the resulting form allows saving the page as
332 >>> discussion, or users/discussion, but not index/discussion, since this
333 >>> page already exists. If all the pages existed, it would do the redirect
334 >>> thing. --[[Joey]]
335
336 ----
337
338 # User database tools?
339
340 Any tool to view user database?
341
342 Any tool to edit the user database?
343
344 > No, but it's fairly easy to write such tools in perl. For example, to
345 > list all users in the user database:
346
347         joey@kodama:~/src/joeywiki/.ikiwiki>perl -le 'use Storable; my $userinfo=Storable::retrieve("userdb"); print $_ foreach keys %$userinfo'         
348         http://joey.kitenet.net/
349         foo
350
351 > To list each user's email address:
352
353         joey@kodama:~/src/joeywiki/.ikiwiki>perl -le 'use Storable; my $userinfo=Storable::retrieve("userdb"); print $userinfo->{$_}->{email} foreach keys %$userinfo'
354         
355         joey@kitenet.net
356
357 > Editing is simply a matter of changing values and calling Storable::store().
358 > I've not written actual utilities to do this yet because I've only needed
359 > to do it rarely, and the data I've wanted has been different each time.
360 > --[[Joey]]
361
362 >> Thanks for these examples -- I have been using them. I don't know the
363 >> Storable yet. Can someone share an example of removing a user? (I now
364 >> setup account\_creation\_password and I have some spammer with different
365 >> login names that I have banned that I might as well remove from the
366 >> userdb.)
367
368 >>> Let's see, you could do something like this:
369 >>>     perl -le 'use Storable; my $userinfo=Storable::retrieve("userdb"); delete $$userinfo{"joey"}; Storable::lock_store($userinfo, "userdb")'
370 >>> I suppose I should stop being lame and create a command line tool wrapping up these operations.. --[[Joey]]
371
372 ----
373
374 # Spaces in WikiLinks?
375
376 Hello Joey,
377
378 I've just switched from ikiwiki 2.0 to ikiwiki 2.2 and I'm really surprised
379 that I can't use the spaces in WikiLinks. Could you please tell me why the spaces
380 aren't allowed in WikiLinks now?
381
382 My best regards,
383
384 --[[PaweĊ‚|ptecza]]
385
386 > See [[bugs/Spaces_in_link_text_for_ikiwiki_links]]
387
388 ----
389
390 # Build in OpenSolaris?
391
392 Moved to [[bugs/build_in_opensolaris]] --[[Joey]]
393
394 ----
395
396 # Various ways to use Subversion with ikiwiki
397
398 I'm playing around with various ways that I can use subversion with ikiwiki.
399
400 * Is it possible to have ikiwiki point to a subversion repository which is on a different server?  The basic checkin/checkout functionality seems to work but there doesn't seem to be any way to make the post-commit hook work for a non-local server?
401
402 > This is difficult to do since ikiwiki's post-commit wrapper expects to
403 > run on a machine that contains both the svn repository and the .ikiwiki
404 > state directory. However, with recent versions of ikiwiki, you can get
405 > away without running the post-commit wrapper on commit, and all you lose
406 > is the ability to send commit notification emails.
407
408 > (And now that [[recentchanges]] includes rss, you can just subscribe to
409 > that, no need to worry about commit notification emails anymore.)
410
411 * Is it possible / sensible to have ikiwiki share a subversion repository with other data (either completely unrelated files or another ikiwiki instance)?  This works in part but again the post-commit hook seems problematic.
412
413 --[[AdamShand]]
414
415 > Sure, see ikiwiki's subversion repository for example of non-wiki files
416 > in the same repo. If you have two wikis in one repository, you will need
417 > to write a post-commit script that calls the post-commit wrappers for each
418 > wiki.
419
420 ----
421
422 # Regex for Valid Characters in Filenames
423
424 I'm sure that this is documented somewhere but I've ransacked the wiki and I can't find it.  :-(  What are the allowed characters in an ikiwiki page name?  I'm writing a simple script to make updating my blog easier and need to filter invalid characters (so far I've found that # and , aren't allowed ;-)).  Thanks for any pointers.  -- [[AdamShand]]
425
426 > The default `wiki_file_regexp` matches filenames containing only
427 > `[-[:alnum:]_.:/+]`
428
429 > The IkiWiki::titlepage() function will convert freeform text to a valid
430 > page name. See [[todo/should_use_a_standard_encoding_for_utf_chars_in_filenames]]
431 > for an example. --[[Joey]]
432
433 >> Perfect, thanks! 
434 >>
435 >> In the end I decided that I didn't need any special characters in filenames and replaced everything but alphanumeric characters with underscores.  In addition to replacing bad characters I also collapse multiple underscores into a single one, and strip off trailing and leading underscores to make tidy filenames.  If it's useful to anybody else here's a sed example:
436 >>
437 >>     # echo "++ Bad: ~@#$%^&*()_=}{[];,? Iki: +_-:./ Num: 65.5 ++" | sed -e 's/[^A-Za-z0-9_]/_/g' -e 's/__*/_/g' -e 's/^_//g' -e 's/_$//g'
438 >>     Bad_Iki_Num_65_5
439 >>
440 >>--[[AdamShand]]