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