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