0336e8342f1ede0af3fbd50da9f27eea9126773b
[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 I have just installed ikiwiki and it works - at least I have the example index.mdwn page
13 compiled and visible.  However I have a few issues/problems:-
14
15 * A couple of the 'optional' Perl modules aren't optional, you can't install ikiwiki without them,
16 these are HTML::Template and HTML::Scrubber (at least I think it was these two, it's a bit messy 
17 to go back and find out).
18
19 > You're right, HTML::Template is required. HTML::Scrubber is only required
20 > in the default configuration, and is optional if the htmlscrubber plugin
21 > is disabled. --[[Joey]]
22
23 * I don't seem to have got an ikiwiki man page created.
24
25 > It should be installed in /usr/share/man, or a similar directory
26 > depending on how your perl is set up and how you did the install.
27 > --[[Joey]]
28
29 > Found it, in /usr/local/share/man, since no other man pages are in either /usr/share/man or in /usr/local/share/man the ikiwiki
30 > man page is a bit lonely, and more to the point not on my MANPATH.  Still I have found it now, I'll just move it to somewhere
31 > more sensible. [[Chris]]
32
33 * Running "ikiwiki --setup ikiwiki.setup" doesn't do anything.  I have edited ikiwiki.setup to
34 my local settings.  There are no errors but neither does anything get compiled.  An ikiwiki
35 command to explicitly do the compile works fine.  Am I misunderstanding something here?
36
37 > Further tests indicate that ikiwiki isn't seeing changed files so doesn't always rebuild.
38 > How does ikiwiki decide when to rebuild?  I tried a full command line like "ikiwiki --verbose ikiwiki ~/public_html/ikiwiki --url=http://www.isbd.ltd.uk/~chris/ikiwiki/" and that doesn't do anything
39 either though it was the command line I originally used to compile.  After a long interval I 'touch'ed 
40 the files and then it *did* compile but 'touch'ing the files after a few minutes only doesn't seem to force a recompile.  I'm even more confused!
41
42 > ikiwiki only compiles files whose modification times have changed. It
43 > should see any change made as close as a second after the last compile.
44 > When run with --setup, ikiwiki always rebuilds every file in the wiki. If
45 > --setup is not working, you must have it pointed at the wrong path or
46 > something; you can pass -v to see what it's doing. I don't know why it
47 > would not see recently changed files; you could try stracing it.
48 > --[[Joey]]
49
50 > OK, thanks, I don't quite know what was happening before but it seems to be working right now.
51 > --[[Chris]]
52
53 >> Weird. I wish I knew what happened, but as it's working now, I'm
54 >> guessing some kind of user error was involved. --[[Joey]]
55
56 * I wish there was a mailing list, much easier for this sort of stuff than this, apart from
57 anything else I get to use a decent editor.
58
59 ----
60 # Excellent - how do I translate a TWiki site?
61
62 I just discovered ikiwiki quite by chance, I was looking for a console/terminal
63 menu system and found pdmenu.  So pdmenu brought me to here and I've found ikiwiki!
64 It looks as if it's just what I've been wanting for a long time.  I wanted something
65 to create mostly text web pages which, as far as possible, have source which is human 
66 readable or at least in a standard format.  ikiwiki does this twice over by using 
67 markdown for the source and producing static HTML from it.
68
69 I'm currently using TWiki and have a fair number of pages in that format, does
70 anyone have any bright ideas for translating?  I can knock up awk scripts fairly
71 easily, perl is possible (but I'm not strong in perl).
72
73 > Let us know if you come up with something to transition from the other
74 > format. Another option would be writing a ikiwiki plugin to support the
75 > TWiki format. --[[Joey]]
76
77 > 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).
78 >
79 > 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.
80 >
81 > We will post the scripts as soon as we have them complete enough to convert our wikis.
82 >
83 > -- Josh Triplett
84
85 >> Thanks for an excellent Xmas present, I will appreciate the additional 
86 >> users this will help switch to ikiwiki! --[[Joey]]
87
88 ----
89
90 # asciidoc or txt2tags ?
91
92 Any plugins or support for using asciidoc or txt2tags as the wiki language and/or exporting to asciidoc or txt2tags?
93
94 > No, but it should be quite easy to write such a plugin. The otl plugin
95 > is a good example of writing a formatting plugin that uses an external
96 > conversion program, like asciidoc or txt2tags. --[[Joey]]
97
98 ----
99
100 # LaTeX support?
101
102 Any plugins or support for exporting to LaTeX?
103 (If not could use asciidoc or txt2tags mentioned above to generated LaTeX.)
104
105 > It's already [[been_requested|todo/latex]], although perhaps not
106 > working the way you're thinking of. Noone is currently working on it.
107 > --[[Joey]]
108
109 >> I did some tests with using Markdown and a customized HTML::Latex and html2latex
110 >> and it appears it will work for me now. (I hope to use ikiwiki for many
111 >> to collaborate on a printed book that will be generated at least once per day in PDF format.)
112 >>
113 >> --JeremyReed
114
115 >>> Have a look at [pandoc](http://code.google.com/p/pandoc/).  It can make PDFs via pdflatex. --[[roktas]]
116
117 ----
118
119 # Using with CVS?
120
121 Any examples of using ikiwiki with cvs?
122
123 > No, although the existing svn backend could fairly esily be modified into
124 > a CVS backend, by someone who doesn't mind working with CVS. --[[Joey]]
125
126 ----
127
128 # Show differences before saving page?
129
130 It would be nice to be able to have a button to show "Differences" (or "Show Diff") when
131 editing a page. Is that an option that can be enabled?
132
133 > It's doable, it could even be done by a [[todo/plugin]], I think.
134 > --[[Joey]]
135
136 ----
137
138 # Max submit size?
139
140 Any setting for limiting how many kilobytes can be submitted via the "edit" form?
141 -- [[JeremyReed]]
142
143 > Not currently. Worried about abuse? --[[Joey]]
144
145 >> I didn't want it abused accidently or with malice. I was thinking that Perl's CGI.pm would handle this, but I don't see that.
146 >> I read that textarea max bytes may be 500 lines or 28000 characters or 30000 characters or 64kB. It seems like it
147 >> varies and I didn't test myself, because I guess it may depend on different clients and different HTTP servers. 
148 >> This could be checked using javascript on the client side (before submitting) and by checking size on server side (before saving). --[[JeremyReed]]
149
150 >>> The absolute limit varies by browser. If there are web servers that
151 >>> also limit it, I don't know of them. --[[Joey]]
152
153 ----
154
155 # Access Keys
156
157 Would anyone else find this a valuable addition.  In oddmuse and instiki (the only other
158 wiki engines I am currently using, the edit, home, and submit link tags have an
159 accesskey attribute.  I find it nice not to have to resort to the mouse for those
160 actions.  However, it may not be something everyone appreciates.  Any thoughts?
161 --[Mazirian](http://mazirian.com)
162
163 > Maybe, although it would need to take the critisism at
164 > http://www.cs.tut.fi/~jkorpela/forms/accesskey.html into account.
165
166 >> Thank you for that link. Given that the edit link is the first thing you tab to
167 >> in the current layout, I guess it isn't all that necessary. I have had a 
168 >> a user complaint recently that Alt-e in oddmuse was overriding his access
169 >> to the browser menu.
170
171 ----
172
173 # Editing the style sheet.
174
175 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.
176 Ok, that's my last 2 cents for a while. --[Mazirian](http://mazirian.com)
177
178 > I don't support editing it, but if/when ikiwiki gets file upload support,
179 > it'll be possible to upload a style sheet. (If .css is in the allowed
180 > extensions list.. no idea how safe that would be, a style sheet is
181 > probably a great place to put XSS attacks and evil javascript that would
182 > be filtered out of any regular page in ikiwiki). --[[Joey]]
183
184 >> I hadn't thought of that at all.  It's a common feature and one I've
185 >> relied on safely, because the wikis I am maintaining at the moment
186 >> are all private and restricted to trusted users. Given that the whole
187 >> point of ikiwiki is to be able to access and edit via the shell as
188 >> well as the web, I suppose the features doesn't add a lot.  By the
189 >> way, the w3m mode is brilliant.  I haven't tried it yet, but the idea
190 >> is great.
191
192 ----
193
194 # RecentChanges should show path to wiki sub-pages?
195
196 The RecentChanges only shows the final file name for the recently changes file,
197 for example "discussion". It would be more useful to see "index/discussion"
198 or the path to the sub-page. I think this is handled by the htmllink() routine.
199
200 >> IMHO it's a good idea and I like it. Often I can see changes in
201 >> any discussion page, but I don't know without clicking the link
202 >> what discussion was changed.
203
204 >> However, I can see one problem here. You can commit via command line
205 >> changes in many pages. It will be displayed ugly then, because probably
206 >> a width of the RecentChanges page will be greater then a width of
207 >> user's browser. I hate these pages. So I propose to display a list of
208 >> changed pages in a column, not in a row. --Pawel
209
210 >>> Well, it's a simple [[patch|patchqueue/full_paths_in_recentchanges]].
211 >>> For a limited time I have that patch running on this wiki. Undecided if
212 >>> I like it or not; the width is not really a problem due to the design
213 >>> of the recentchanges page, but all those paths do clutter up the page
214 >>> somewhat. Comments? --[[Joey]]
215
216 ----
217
218 # Should not create an existing page
219
220 This might be a bug, but will discuss it here first.
221 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".
222
223 > I belive that currently it does a redirect to the new static web page.
224 > At least that's the intent of the code. --[[Joey]]
225
226 >> Try at your site: `?page=discussion&from=index&do=create`
227 >> It brings up an empty textarea to start a new webpage -- even though it already exists here. --reed
228
229 >>> Ah, right. Notice that the resulting form allows saving the page as
230 >>> discussion, or users/discussion, but not index/discussion, since this
231 >>> page already exists. If all the pages existed, it would do the redirect
232 >>> thing. --[[Joey]]
233
234 ----
235
236 # Refreshing RecentChanges page
237
238 What do you think about refreshing RecentChanges page (via Meta Refresh Tag)?
239 It can be useful for users like me which rather prefer watching the last changes
240 in WWW browser tab than subscribing to page. --Pawel
241
242 > Depends, if it were done the time period should be made configurable.
243 > Unwanted server load due to refeshing could be a problem for some.
244 > --[[Joey]]
245
246 >> Yes, it should be configurable by ikiwiki admin. I believe he's not
247 >> stupid and he will not set too short refresh period to kill his server :)
248 >> I propose to add `recentchanges_refresh` variable in ikiwiki setup
249 >> to setting refresh period. If it's not defined, then ikiwiki doesn't put
250 >> refresh meta tag into `recentchanges.tmpl`. Do you like it? ;) --Pawel
251
252 >>> Seems reasonable --[[Joey]]