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