web commit by MarkusSchaber
[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 # Excellent - how do I translate a TWiki site?
23
24 I just discovered ikiwiki quite by chance, I was looking for a console/terminal
25 menu system and found pdmenu.  So pdmenu brought me to here and I've found ikiwiki!
26 It looks as if it's just what I've been wanting for a long time.  I wanted something
27 to create mostly text web pages which, as far as possible, have source which is human 
28 readable or at least in a standard format.  ikiwiki does this twice over by using 
29 markdown for the source and producing static HTML from it.
30
31 I'm currently using TWiki and have a fair number of pages in that format, does
32 anyone have any bright ideas for translating?  I can knock up awk scripts fairly
33 easily, perl is possible (but I'm not strong in perl).
34
35 > Let us know if you come up with something to transition from the other
36 > format. Another option would be writing a ikiwiki plugin to support the
37 > TWiki format. --[[Joey]]
38
39 > 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).
40 >
41 > 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.
42 >
43 > We will post the scripts as soon as we have them complete enough to convert our wikis.
44 >
45 > -- [[JoshTriplett]]
46
47 >> Thanks for an excellent Xmas present, I will appreciate the additional 
48 >> users this will help switch to ikiwiki! --[[Joey]]
49
50 ----
51
52 # LaTeX support?
53
54 Moved to [[todo/latex]] --[[Joey]]
55
56 ----
57
58 # Using with CVS?
59
60 Moved to a [[todo_item|todo/CVS_backend]]. --[[JoshTriplett]]
61
62 ----
63
64 # Show differences before saving page?
65
66 Moved to the existing [[todo_item|todo/preview_changes]]. --[[JoshTriplett]]
67
68 ----
69
70 # Max submit size?
71
72 Any setting for limiting how many kilobytes can be submitted via the "edit" form?
73 -- [[JeremyReed]]
74
75 >>> See [[todo/fileupload]] for an idea on limiting page size. --[[Joey]]
76
77 ----
78
79 # Access Keys
80
81 Would anyone else find this a valuable addition.  In oddmuse and instiki (the only other
82 wiki engines I am currently using, the edit, home, and submit link tags have an
83 accesskey attribute.  I find it nice not to have to resort to the mouse for those
84 actions.  However, it may not be something everyone appreciates.  Any thoughts?
85 --[Mazirian](http://mazirian.com)
86
87 > Maybe, although it would need to take the critisism at
88 > <http://www.cs.tut.fi/~jkorpela/forms/accesskey.html> into account.
89
90 >> Thank you for that link. Given that the edit link is the first thing you tab to
91 >> in the current layout, I guess it isn't all that necessary. I have had a 
92 >> a user complaint recently that Alt-e in oddmuse was overriding his access
93 >> to the browser menu.
94
95 ----
96
97 # Editing the style sheet.
98
99 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.
100 Ok, that's my last 2 cents for a while. --[Mazirian](http://mazirian.com)
101
102 > I don't support editing it, but if/when ikiwiki gets [[todo/fileupload]] support,
103 > it'll be possible to upload a style sheet. (If .css is in the allowed
104 > extensions list.. no idea how safe that would be, a style sheet is
105 > probably a great place to put XSS attacks and evil javascript that would
106 > be filtered out of any regular page in ikiwiki). --[[Joey]]
107
108 >> I hadn't thought of that at all.  It's a common feature and one I've
109 >> relied on safely, because the wikis I am maintaining at the moment
110 >> are all private and restricted to trusted users. Given that the whole
111 >> point of ikiwiki is to be able to access and edit via the shell as
112 >> well as the web, I suppose the features doesn't add a lot.  By the
113 >> way, the w3m mode is brilliant.  I haven't tried it yet, but the idea
114 >> is great.
115
116 ----
117
118 # Should not create an existing page
119
120 This might be a bug, but will discuss it here first.
121 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".
122
123 > I belive that currently it does a redirect to the new static web page.
124 > At least that's the intent of the code. --[[Joey]]
125
126 >> Try at your site: `?page=discussion&from=index&do=create`
127 >> It brings up an empty textarea to start a new webpage -- even though it already exists here. --reed
128
129 >>> Ah, right. Notice that the resulting form allows saving the page as
130 >>> discussion, or users/discussion, but not index/discussion, since this
131 >>> page already exists. If all the pages existed, it would do the redirect
132 >>> thing. --[[Joey]]
133
134 ----
135
136 # User database tools?
137
138 Any tool to view user database?
139
140 Any tool to edit the user database?
141
142 > No, but it's fairly easy to write such tools in perl. For example, to
143 > list all users in the user database:
144
145         joey@kodama:~/src/joeywiki/.ikiwiki>perl -le 'use Storable; my $userinfo=Storable::retrieve("userdb"); print $_ foreach keys %$userinfo'         
146         http://joey.kitenet.net/
147         foo
148
149 > To list each user's email address:
150
151         joey@kodama:~/src/joeywiki/.ikiwiki>perl -le 'use Storable; my $userinfo=Storable::retrieve("userdb"); print $userinfo->{$_}->{email} foreach keys %$userinfo'
152         
153         joey@kitenet.net
154
155 > Editing is simply a matter of changing values and calling Storable::store().
156 > I've not written actual utilities to do this yet because I've only needed
157 > to do it rarely, and the data I've wanted has been different each time.
158 > --[[Joey]]