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