web commit by JeremyReed: more about my upgrade problems
[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 # Upgrade steps
29
30 I upgrades from 1.37 to 2.6.1. I ran "ikiwiki --setup" using my existing ikiwiki.setup configuration.
31 I had many errors like:
32
33     /home/bsdwiki/www/wiki/wikilink/index.html independently created, not overwriting with version from wikilink
34     BEGIN failed--compilation aborted at (eval 5) line 129.
35
36 and:
37
38     failed renaming /home/bsdwiki/www/wiki/smileys.ikiwiki-new to /home/bsdwiki/www/wiki/smileys: Is a directory
39     BEGIN failed--compilation aborted at (eval 5) line 129.
40
41 Probably about six errors like this. I worked around this by removing the files and directories it complained about.
42 Finally it finished.
43
44 My next problem was that ikiwiki start letting me edit without any password authentication. It used to prompt
45 me for a password but now just goes right into the "editing" mode.
46 The release notes for 2.0 say password auth is still on by default.
47
48 The third problem is that when editing my textbox is empty -- no content.
49
50 This is using my custom rcs.pm which has been used thousands of times.
51
52 Now I regenerated my ikiwiki.cgi again (no change to my configuration,
53 and I just get an empty HTML page when attempting editing or "create".
54
55 Now I see it created directories for my data. I fixed that by setting 
56 usedirs (I see that is in the release notes for 2.0) and rerunning ikiwiki --setup
57 but I still have empty pages for editing (no textbox no html at all).
58
59 > Is IkiWiki crashing? If so, it would probably leave error text in the apache logs. --[[TaylorKillian]]
60
61 (I am posting this now, but will do some research and post some more.)
62
63 Is there any webpage with upgrade steps?
64
65 --JeremyReed
66
67 My followup: I used a new ikiwiki.setup based on the latest version. But no changes for me.
68
69 Also I forgot to mention that do=recentchanges works good for me. It uses my 
70 rcs_recentchanges in my rcs perl module.
71
72 The do=prefs does nothing though -- just a blank webpage.
73
74 I also set verbose => 1 and running ikiwiki --setup was verbose, but no changes in running CGI.
75 I was hoping for some output.
76
77 I am guessing that my rcs perl module stopped working on the upgrade. I didn't notice any release notes
78 on changes to revision control modules. Has something changed? I will also look.
79
80 --JeremyReed
81
82 ----
83 # Excellent - how do I translate a TWiki site?
84
85 I just discovered ikiwiki quite by chance, I was looking for a console/terminal
86 menu system and found pdmenu.  So pdmenu brought me to here and I've found ikiwiki!
87 It looks as if it's just what I've been wanting for a long time.  I wanted something
88 to create mostly text web pages which, as far as possible, have source which is human 
89 readable or at least in a standard format.  ikiwiki does this twice over by using 
90 markdown for the source and producing static HTML from it.
91
92 I'm currently using TWiki and have a fair number of pages in that format, does
93 anyone have any bright ideas for translating?  I can knock up awk scripts fairly
94 easily, perl is possible (but I'm not strong in perl).
95
96 > Let us know if you come up with something to transition from the other
97 > format. Another option would be writing a ikiwiki plugin to support the
98 > TWiki format. --[[Joey]]
99
100 > 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).
101 >
102 > 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.
103 >
104 > We will post the scripts as soon as we have them complete enough to convert our wikis.
105 >
106 > -- [[JoshTriplett]]
107
108 >> Thanks for an excellent Xmas present, I will appreciate the additional 
109 >> users this will help switch to ikiwiki! --[[Joey]]
110
111 ----
112
113 # LaTeX support?
114
115 Moved to [[todo/latex]] --[[Joey]]
116
117 ----
118
119 # Using with CVS?
120
121 Moved to a [[todo_item|todo/CVS_backend]]. --[[JoshTriplett]]
122
123 ----
124
125 # Show differences before saving page?
126
127 Moved to the existing [[todo_item|todo/preview_changes]]. --[[JoshTriplett]]
128
129 ----
130
131 # Max submit size?
132
133 Any setting for limiting how many kilobytes can be submitted via the "edit" form?
134 -- [[JeremyReed]]
135
136 >>> See [[todo/fileupload]] for an idea on limiting page size. --[[Joey]]
137
138 ----
139
140 # Access Keys
141
142 Would anyone else find this a valuable addition.  In oddmuse and instiki (the only other
143 wiki engines I am currently using, the edit, home, and submit link tags have an
144 accesskey attribute.  I find it nice not to have to resort to the mouse for those
145 actions.  However, it may not be something everyone appreciates.  Any thoughts?
146 --[Mazirian](http://mazirian.com)
147
148 > Maybe, although it would need to take the critisism at
149 > <http://www.cs.tut.fi/~jkorpela/forms/accesskey.html> into account.
150
151 >> Thank you for that link. Given that the edit link is the first thing you tab to
152 >> in the current layout, I guess it isn't all that necessary. I have had a 
153 >> a user complaint recently that Alt-e in oddmuse was overriding his access
154 >> to the browser menu.
155
156 ----
157
158 # Editing the style sheet.
159
160 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.
161 Ok, that's my last 2 cents for a while. --[Mazirian](http://mazirian.com)
162
163 > I don't support editing it, but if/when ikiwiki gets [[todo/fileupload]] support,
164 > it'll be possible to upload a style sheet. (If .css is in the allowed
165 > extensions list.. no idea how safe that would be, a style sheet is
166 > probably a great place to put XSS attacks and evil javascript that would
167 > be filtered out of any regular page in ikiwiki). --[[Joey]]
168
169 >> I hadn't thought of that at all.  It's a common feature and one I've
170 >> relied on safely, because the wikis I am maintaining at the moment
171 >> are all private and restricted to trusted users. Given that the whole
172 >> point of ikiwiki is to be able to access and edit via the shell as
173 >> well as the web, I suppose the features doesn't add a lot.  By the
174 >> way, the w3m mode is brilliant.  I haven't tried it yet, but the idea
175 >> is great.
176
177 ----
178
179 # Should not create an existing page
180
181 This might be a bug, but will discuss it here first.
182 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".
183
184 > I belive that currently it does a redirect to the new static web page.
185 > At least that's the intent of the code. --[[Joey]]
186
187 >> Try at your site: `?page=discussion&from=index&do=create`
188 >> It brings up an empty textarea to start a new webpage -- even though it already exists here. --reed
189
190 >>> Ah, right. Notice that the resulting form allows saving the page as
191 >>> discussion, or users/discussion, but not index/discussion, since this
192 >>> page already exists. If all the pages existed, it would do the redirect
193 >>> thing. --[[Joey]]
194
195 ----
196
197 # User database tools?
198
199 Any tool to view user database?
200
201 Any tool to edit the user database?
202
203 > No, but it's fairly easy to write such tools in perl. For example, to
204 > list all users in the user database:
205
206         joey@kodama:~/src/joeywiki/.ikiwiki>perl -le 'use Storable; my $userinfo=Storable::retrieve("userdb"); print $_ foreach keys %$userinfo'         
207         http://joey.kitenet.net/
208         foo
209
210 > To list each user's email address:
211
212         joey@kodama:~/src/joeywiki/.ikiwiki>perl -le 'use Storable; my $userinfo=Storable::retrieve("userdb"); print $userinfo->{$_}->{email} foreach keys %$userinfo'
213         
214         joey@kitenet.net
215
216 > Editing is simply a matter of changing values and calling Storable::store().
217 > I've not written actual utilities to do this yet because I've only needed
218 > to do it rarely, and the data I've wanted has been different each time.
219 > --[[Joey]]
220
221 ----
222
223 # Spaces in WikiLinks?
224
225 Hello Joey,
226
227 I've just switched from ikiwiki 2.0 to ikiwiki 2.2 and I'm really surprised
228 that I can't use the spaces in WikiLinks. Could you please tell me why the spaces
229 aren't allowed in WikiLinks now?
230
231 My best regards,
232
233 --[[PaweĊ‚|ptecza]]
234
235 > See [[bugs/Spaces_in_link_text_for_ikiwiki_links]]
236
237 ----
238
239 # Build in OpenSolaris?
240
241 Moved to [[bugs/build_in_opensolaris]] --[[Joey]]
242
243 ----
244
245 # Various ways to use Subversion with ikiwiki
246
247 I'm playing around with various ways that I can use subversion with ikiwiki.
248
249 * 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?
250
251 > This is difficult to do since ikiwiki's post-commit wrapper expects to
252 > run on a machine that contains both the svn repository and the .ikiwiki
253 > state directory. However, with recent versions of ikiwiki, you can get
254 > away without running the post-commit wrapper on commit, and all you lose
255 > is the ability to send commit notification emails.
256
257 * 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.
258
259 --[[AdamShand]]
260
261 > Sure, see ikiwiki's subversion repository for example of non-wiki files
262 > in the same repo. If you have two wikis in one repository, you will need
263 > to write a post-commit script that calls the post-commit wrappers for each
264 > wiki.