]> sipb.mit.edu Git - ikiwiki.git/blob - doc/index/discussion.mdwn
web commit by JeremyReed: ,v files in source?
[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 # Installation/Setup questions
9
10 I have just installed ikiwiki and it works - at least I have the example index.mdwn page
11 compiled and visible.  However I have a few issues/problems:-
12
13 * A couple of the 'optional' Perl modules aren't optional, you can't install ikiwiki without them,
14 these are HTML::Template and HTML::Scrubber (at least I think it was these two, it's a bit messy 
15 to go back and find out).
16
17 > You're right, HTML::Template is required. HTML::Scrubber is only required
18 > in the default configuration, and is optional if the htmlscrubber plugin
19 > is disabled. --[[Joey]]
20
21 * I don't seem to have got an ikiwiki man page created.
22
23 > It should be installed in /usr/share/man, or a similar directory
24 > depending on how your perl is set up and how you did the install.
25 > --[[Joey]]
26
27 > 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
28 > 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
29 > more sensible. [[Chris]]
30
31 * Running "ikiwiki --setup ikiwiki.setup" doesn't do anything.  I have edited ikiwiki.setup to
32 my local settings.  There are no errors but neither does anything get compiled.  An ikiwiki
33 command to explicitly do the compile works fine.  Am I misunderstanding something here?
34
35 > Further tests indicate that ikiwiki isn't seeing changed files so doesn't always rebuild.
36 > 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
37 either though it was the command line I originally used to compile.  After a long interval I 'touch'ed 
38 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!
39
40 > ikiwiki only compiles files whose modification times have changed. It
41 > should see any change made as close as a second after the last compile.
42 > When run with --setup, ikiwiki always rebuilds every file in the wiki. If
43 > --setup is not working, you must have it pointed at the wrong path or
44 > something; you can pass -v to see what it's doing. I don't know why it
45 > would not see recently changed files; you could try stracing it.
46 > --[[Joey]]
47
48 > OK, thanks, I don't quite know what was happening before but it seems to be working right now.
49 > --[[Chris]]
50
51 >> Weird. I wish I knew what happened, but as it's working now, I'm
52 >> guessing some kind of user error was involved. --[[Joey]]
53
54 * I wish there was a mailing list, much easier for this sort of stuff than this, apart from
55 anything else I get to use a decent editor.
56
57 ----
58 # Excellent - how do I translate a TWiki site?
59
60 I just discovered ikiwiki quite by chance, I was looking for a console/terminal
61 menu system and found pdmenu.  So pdmenu brought me to here and I've found ikiwiki!
62 It looks as if it's just what I've been wanting for a long time.  I wanted something
63 to create mostly text web pages which, as far as possible, have source which is human 
64 readable or at least in a standard format.  ikiwiki does this twice over by using 
65 markdown for the source and producing static HTML from it.
66
67 I'm currently using TWiki and have a fair number of pages in that format, does
68 anyone have any bright ideas for translating?  I can knock up awk scripts fairly
69 easily, perl is possible (but I'm not strong in perl).
70
71 > Let us know if you come up with something to transition from the other
72 > format. Another option would be writing a ikiwiki plugin to support the
73 > TWiki format. --[[Joey]]
74
75 > 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).
76 >
77 > 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.
78 >
79 > We will post the scripts as soon as we have them complete enough to convert our wikis.
80 >
81 > -- Josh Triplett
82
83 >> Thanks for an excellent Xmas present, I will appreciate the additional 
84 >> users this will help switch to ikiwiki! --[[Joey]]
85
86 ----
87
88 # OpenID
89
90 I just figured I'd edit something on the page with my OpenID, since you've implemented it! --*[Kyle](http://kitenet.net/~kyle/)*=
91
92 > Kyle, If you like openid, I can switch your personal wiki over to use your openid. --[[Joey]]
93
94 ---- 
95
96 # ACL
97
98 How about adding ACL? So that you can control which users are allowed
99 to read, write certain pages. The moinmoin wiki has that, and it is
100 something, that I think is very valuable. 
101
102 > ikiwiki currently has only the most rudimentary access controls: pages
103 > can be locked, or unlocked and only the admin can edit locked pages. That
104 > could certianly be expanded on, although it's not an area that I have an
105 > overwhelming desire to work on myself right now. Patches appreciated and
106 > I'll be happy to point you in the right directions.. --[[Joey]]
107
108 >> I'm really curious how you'd suggest implementing ACLs on reading a page.
109 >> It seems to me the only way you could do it is .htaccess DenyAll or something,
110 >> and then route all page views through ikiwiki.cgi. Am I missing something?
111 >> --[[Ethan]]
112
113 >>> Or you could just use apache or whatever and set up the access controls
114 >>> there. Of course, that wouldn't integrate very well with the wiki,
115 >>> unless perhaps you decided to use http basic authentication and the
116 >>> httpauth plugin for ikiwiki that integrates with that.. --[[Joey]]
117
118 >>>> Which would rule out openid, or other fun forms of auth. And routing all access 
119 >>>> through the CGI sort of defeats the purpose of ikiwiki. --[[Ethan]]
120
121 ----
122
123 Some questions about the RecentChanges function. -- Ethan
124
125 > (Moved to [[todo/recentchanges]] --[[Joey]])
126
127 ----
128
129 Also, I'd like to request another template parameter which is just
130 $config{url}. That way you won't have to hard-code the URL of the wiki into
131 the template. -- Ethan
132
133 > That's already available in the BASEURL parameter. --[[Joey]]
134
135 ----
136
137 # Canonical feed location?
138
139 Any way to use `inline` but point the feed links to a different feed on the
140 same site?  I have news in news/*, a news archive in news.mdwn, and the
141 first few news items on index.mdwn, but I don't really want two separate
142 feeds, one with all news and one with the latest few articles; I'd rather
143 point the RSS feed links of both to the same feed.  (Which one, the one
144 with all news or the one with the latest news only, I don't know yet.)
145
146 > Not currently. It could be implemented, or you could just turn off the
147 > rss feed for the index page, and manually put in a wikilink to the news
148 > page and rss feed. --[[Joey]]
149
150 >> That wouldn't use the same style for the RSS and Atom links, and it
151 >> wouldn't embed the feed link into `<head>` so that browsers can automatically
152 >> find it.
153
154 ----
155
156 # asciidoc or txt2tags ?
157
158 Any plugins or support for using asciidoc or txt2tags as the wiki language and/or exporting to asciidoc or txt2tags?
159
160 > No, but it should be quite easy to write such a plugin. The otl plugin
161 > is a good example of writing a formatting plugin that uses an external
162 > conversion program, like asciidoc or txt2tags. --[[Joey]]
163
164 ----
165
166 # LaTeX support?
167
168 Any plugins or support for exporting to LaTeX?
169 (If not could use asciidoc or txt2tags mentioned above to generated LaTeX.)
170
171 > It's already [[been_requested|todo/latex]], although perhaps not
172 > working the way you're thinking of. Noone is currently working on it.
173 > --[[Joey]]
174
175 >> I did some tests with using Markdown and a customized HTML::Latex and html2latex
176 >> and it appears it will work for me now. (I hope to use ikiwiki for many
177 >> to collaborate on a printed book that will be generated at least once per day in PDF format.)
178 >>
179 >> --JeremyReed
180
181 ----
182
183 # Using with RCS?
184
185 Any examples of using co(1), ci(1) and other RCS related tools with ikiwiki?
186
187 > I don't belive that RCS offers enough SCM features to be useable as a
188 > fullfledged backend to ikiwiki. For one thing, there's no way to have
189 > hook scripts run when changes are ci'd, is there? So you'd have to ci and
190 > then manually run ikiwiki. It should be possible to do an RCS backend
191 > that supports web commits with ci, and history (parsing the rcs files by
192 > hand?). If you're a masochist. :-) --[[Joey]]
193
194 >> It does have history using rlog(1) which is similar format to "cvs log".
195 >> I don't think it has any possible hooks. What would happen if I call
196 >> ikiwiki directly from rcs_commit? (I didn't try yet.) On that note,
197 >> I don't see any way for ikiwiki to generate a single file, but I guess
198 >> that doesn't matter as --refresh should be fast enough.
199 >> I made a Rcs/rcs.pm plugin from Stub. I have been testing it some.
200 >>
201 >> --JeremyReed
202
203 >> I made a working rcs plugin. And I made a RCS-to-web CGI. Details
204 >> at [[patchqueue/rcs_(third-party_plugin)]]
205 >> --[[JeremyReed]]
206 >>
207 >> (Moved to patchqueue --[[Joey]])
208
209 ----
210
211 # Using with CVS?
212
213 Any examples of using ikiwiki with cvs?
214
215 > No, although the existing svn backend could fairly esily be modified into
216 > a CVS backend, by someone who doesn't mind working with CVS. --[[Joey]]
217
218 ----
219
220 # Show differences before saving page?
221
222 It would be nice to be able to have a button to show "Differences" (or "Show Diff") when
223 editing a page. Is that an option that can be enabled?
224
225 > It's doable, it could even be done by a [[todo/plugin]], I think.
226 > --[[Joey]]
227
228 ----
229
230 # Max submit size?
231
232 Any setting for limiting how many kilobytes can be submitted via the "edit" form?
233 -- [[JeremyReed]]
234
235 > Not currently. Worried about abuse? --[[Joey]]
236
237 ----
238
239 # Disable sub-discussion pages?
240
241 Any setting to disable having a discussion of a discussion?
242 The [[features]] page says every page, but I don't want every page.
243 I do want discussion subpage, but I don't want to have, for example: discussion/ discussion/ discussion.
244 -- [[JeremyReed]]
245
246 ----
247
248 # wiki\_file\_regexp and RCS ,v files
249
250 I have RCS ,v files in my source directory. But get many "skipping bad filename" warnings.
251
252 Also I don't see wiki\_file\_regexp documented. Because it is used with $config{wiki\_file\_regexp} I assume it can be set in the ikiwiki.setup.
253 I added a comma to it in my IkiWiki.pm in the defaultconfig(). But that was wrong (so I reverted back), because then the ,v files were copied to my www tree.
254
255 What is the correct way to include ,v RCS revision files in my source tree without receiving the "bad" messages and without copying over to www tree?
256
257 -- [[JeremyReed]]