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