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