web commit by http://adam.shand.net/

[git.ikiwiki.info.git] / doc / index / discussion.mdwn

diff --git a/doc/index/discussion.mdwn b/doc/index/discussion.mdwn
index fc17ab380d1fd2f88db1ef43cab4cb66eeb2caa5..af3884dfb6628ce8c3e2ea24a3ae758c77204502 100644 (file)
--- a/doc/index/discussion.mdwn
+++ b/doc/index/discussion.mdwn
@@ -9,83 +9,21 @@ Note that for more formal bug reports or todo items, you can also edit the
 
 # Installation/Setup questions
 
 
 # Installation/Setup questions
 

-I ran into a problem when installing from svn.  I got "invalid variable
-interpolation" errors for Wrappers.pm.  I added the flag '--extract-all' to
-'po/Makefile' and 'po/t' to the xgettext line.  Once I did that I was able
-to make and make test just fine. --HarleyPig
-
-> It would be helpful if you could post the actual error message you saw.
-> Also would be nice to know what versions of perl and gettext you have.
-> Perhaps your xgettext is an older version from before it natively
-> supported perl.
-> Adding --extract-all doesn't seem like a good idea, since this causes it
-> to treat every string in the entire wiki as translatable. I don't know
-> what you're talking about regarding 'po/t'. --[[Joey]]
-
->> make[1]: Entering directory `/home/www/ikiwiki/po'
->> Rebuilding the pot file
->> xgettext ../IkiWiki/CGI.pm ../IkiWiki/Plugin/aggregate.pm ../IkiWiki/Plugin/brokenlinks.pm ../IkiWiki/Plugin/camelcase.pm ../IkiWiki/Plugin/ddate.pm ../IkiWiki/Plugin/favicon.pm ../IkiWiki/Plugin/fortune.pm ../IkiWiki/Plugin/goodstuff.pm ../IkiWiki/Plugin/googlecalendar.pm ../IkiWiki/Plugin/haiku.pm ../IkiWiki/Plugin/html.pm ../IkiWiki/Plugin/htmlscrubber.pm ../IkiWiki/Plugin/htmltidy.pm ../IkiWiki/Plugin/httpauth.pm ../IkiWiki/Plugin/img.pm ../IkiWiki/Plugin/inline.pm ../IkiWiki/Plugin/linkmap.pm ../IkiWiki/Plugin/map.pm ../IkiWiki/Plugin/mdwn.pm ../IkiWiki/Plugin/meta.pm ../IkiWiki/Plugin/mirrorlist.pm ../IkiWiki/Plugin/openid.pm ../IkiWiki/Plugin/orphans.pm ../IkiWiki/Plugin/otl.pm ../IkiWiki/Plugin/pagecount.pm ../IkiWiki/Plugin/pagestats.pm ../IkiWiki/Plugin/passwordauth.pm ../IkiWiki/Plugin/poll.pm ../IkiWiki/Plugin/polygen.pm ../IkiWiki/Plugin/rawhtml.pm ../IkiWiki/Plugin/rst.pm ../IkiWiki/Plugin/search.pm ../IkiWiki/Plugin/shortcut.pm ../IkiWiki/Plugin/sidebar.pm ../IkiWiki/Plugin/skeleton.pm ../IkiWiki/Plugin/smiley.pm ../IkiWiki/Plugin/tag.pm ../IkiWiki/Plugin/template.pm ../IkiWiki/Plugin/textile.pm ../IkiWiki/Plugin/toc.pm ../IkiWiki/Plugin/toggle.pm ../IkiWiki/Plugin/typography.pm ../IkiWiki/Plugin/wikitext.pm ../IkiWiki/Rcs/Stub.pm ../IkiWiki/Rcs/git.pm ../IkiWiki/Rcs/mercurial.pm ../IkiWiki/Rcs/svn.pm ../IkiWiki/Rcs/tla.pm ../IkiWiki/Render.pm ../IkiWiki/Setup.pm ../IkiWiki/Setup/Standard.pm ../IkiWiki/UserInfo.pm ../IkiWiki/Wrapper.pm ../ikiwiki.in ../IkiWiki.pm -o ikiwiki.pot -Lperl --add-comments=translators ../IkiWiki/Wrapper.pm:64: invalid variable interpolation at "$"
->> make[1]: *** [ikiwiki.pot] Error 1
->> make[1]: Leaving directory `/home/www/ikiwiki/po'
->> make: *** [extra_build] Error 2
->>
->> harleypig ikiwiki # xgettext --version
->>
->> xgettext (GNU gettext-tools) 0.15
->>
->> harleypig ikiwiki # perl -v
->>
->> This is perl, v5.8.8 built for i686-linux
->>
->> Sorry about the po/t report ... it was the test file I used to figure out what was wrong and I forgot to remove it.  This is against the subversion repository, version 2338.
->> The referenced line has a $! variable, which the documentation for gettext indicates is the problem.
-
-I have just installed ikiwiki and it works - at least I have the example index.mdwn page
-compiled and visible.  However I have a few issues/problems:-
-
-* A couple of the 'optional' Perl modules aren't optional, you can't install ikiwiki without them,
-these are HTML::Template and HTML::Scrubber (at least I think it was these two, it's a bit messy 
-to go back and find out).
-
-> You're right, HTML::Template is required. HTML::Scrubber is only required
-> in the default configuration, and is optional if the htmlscrubber plugin
-> is disabled. --[[Joey]]
-
-* I don't seem to have got an ikiwiki man page created.
-
-> It should be installed in /usr/share/man, or a similar directory
-> depending on how your perl is set up and how you did the install.
-> --[[Joey]]
+Ikiwiki creates a .ikiwiki directory in my wikiwc working directory. Should I
+"svn add .ikiwiki" or add it to svn:ignore?

 
 

-> 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
-> 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
-> more sensible. [[Chris]]
-
-* Running "ikiwiki --setup ikiwiki.setup" doesn't do anything.  I have edited ikiwiki.setup to
-my local settings.  There are no errors but neither does anything get compiled.  An ikiwiki
-command to explicitly do the compile works fine.  Am I misunderstanding something here?
-
-> Further tests indicate that ikiwiki isn't seeing changed files so doesn't always rebuild.
-> 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
-either though it was the command line I originally used to compile.  After a long interval I 'touch'ed 
-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!
-
-> ikiwiki only compiles files whose modification times have changed. It
-> should see any change made as close as a second after the last compile.
-> When run with --setup, ikiwiki always rebuilds every file in the wiki. If
-> --setup is not working, you must have it pointed at the wrong path or
-> something; you can pass -v to see what it's doing. I don't know why it
-> would not see recently changed files; you could try stracing it.
-> --[[Joey]]
+> `.ikiwiki` is used by ikiwiki to store internal state. You can add it to
+> svn:ignore. --[[Joey]]
+> > Thanks a lot.

 
 

-> OK, thanks, I don't quite know what was happening before but it seems to be working right now.
-> --[[Chris]]
+Is there an easy way to log via e-mail to some webmaster address, instead
+of via syslog?

 
 

->> Weird. I wish I knew what happened, but as it's working now, I'm
->> guessing some kind of user error was involved. --[[Joey]]
+> Not sure why you'd want to do that, but couldn't you use a tool like
+> logwatch to mail selected lines from the syslog? --[[Joey]]

 
 

-* I wish there was a mailing list, much easier for this sort of stuff than this, apart from
-anything else I get to use a decent editor.
+> > The reason is that I'm not logged in on the web server regularly to
+> > check the log files. I'll see whether I can install a logwatch instance.

 
 ----
 # Excellent - how do I translate a TWiki site?
 
 ----
 # Excellent - how do I translate a TWiki site?


@@ -111,58 +49,28 @@ easily, perl is possible (but I'm not strong in perl).
 >
 > We will post the scripts as soon as we have them complete enough to convert our wikis.
 >
 >
 > We will post the scripts as soon as we have them complete enough to convert our wikis.
 >

-> -- Josh Triplett
+> -- [[JoshTriplett]]

 
 >> Thanks for an excellent Xmas present, I will appreciate the additional 
 >> users this will help switch to ikiwiki! --[[Joey]]
 
 ----
 
 
 >> Thanks for an excellent Xmas present, I will appreciate the additional 
 >> users this will help switch to ikiwiki! --[[Joey]]
 
 ----
 

-# asciidoc or txt2tags ?
-
-Any plugins or support for using asciidoc or txt2tags as the wiki language and/or exporting to asciidoc or txt2tags?
-
-> No, but it should be quite easy to write such a plugin. The otl plugin
-> is a good example of writing a formatting plugin that uses an external
-> conversion program, like asciidoc or txt2tags. --[[Joey]]
-
-----
-

 # LaTeX support?
 
 # LaTeX support?
 

-Any plugins or support for exporting to LaTeX?
-(If not could use asciidoc or txt2tags mentioned above to generated LaTeX.)
-
-> It's already [[been_requested|todo/latex]], although perhaps not
-> working the way you're thinking of. Noone is currently working on it.
-> --[[Joey]]
-
->> I did some tests with using Markdown and a customized HTML::Latex and html2latex
->> and it appears it will work for me now. (I hope to use ikiwiki for many
->> to collaborate on a printed book that will be generated at least once per day in PDF format.)
->>
->> --JeremyReed
-
->>> Have a look at [pandoc](http://code.google.com/p/pandoc/).  It can make PDFs via pdflatex. --[[roktas]]
+Moved to [[todo/latex]] --[[Joey]]

 
 ----
 
 # Using with CVS?
 
 
 ----
 
 # Using with CVS?
 

-Any examples of using ikiwiki with cvs?
-
-> No, although the existing svn backend could fairly esily be modified into
-> a CVS backend, by someone who doesn't mind working with CVS. --[[Joey]]
+Moved to a [[todo_item|todo/CVS_backend]]. --[[JoshTriplett]]

 
 ----
 
 # Show differences before saving page?
 
 
 ----
 
 # Show differences before saving page?
 

-It would be nice to be able to have a button to show "Differences" (or "Show Diff") when
-editing a page. Is that an option that can be enabled?
-
-> It's doable, it could even be done by a [[todo/plugin]], I think.
-> --[[Joey]]
+Moved to the existing [[todo_item|todo/preview_changes]]. --[[JoshTriplett]]

 
 ----
 
 
 ----
 


@@ -171,15 +79,7 @@ editing a page. Is that an option that can be enabled?
 Any setting for limiting how many kilobytes can be submitted via the "edit" form?
 -- [[JeremyReed]]
 
 Any setting for limiting how many kilobytes can be submitted via the "edit" form?
 -- [[JeremyReed]]
 

-> Not currently. Worried about abuse? --[[Joey]]
-
->> 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.
->> I read that textarea max bytes may be 500 lines or 28000 characters or 30000 characters or 64kB. It seems like it
->> varies and I didn't test myself, because I guess it may depend on different clients and different HTTP servers. 
->> This could be checked using javascript on the client side (before submitting) and by checking size on server side (before saving). --[[JeremyReed]]
-
->>> The absolute limit varies by browser. If there are web servers that
->>> also limit it, I don't know of them. --[[Joey]]
+>>> See [[todo/fileupload]] for an idea on limiting page size. --[[Joey]]

 
 ----
 
 
 ----
 


@@ -192,7 +92,7 @@ actions.  However, it may not be something everyone appreciates.  Any thoughts?
 --[Mazirian](http://mazirian.com)
 
 > Maybe, although it would need to take the critisism at
 --[Mazirian](http://mazirian.com)
 
 > Maybe, although it would need to take the critisism at

-> http://www.cs.tut.fi/~jkorpela/forms/accesskey.html into account.
+> <http://www.cs.tut.fi/~jkorpela/forms/accesskey.html> into account.

 
 >> Thank you for that link. Given that the edit link is the first thing you tab to
 >> in the current layout, I guess it isn't all that necessary. I have had a 
 
 >> Thank you for that link. Given that the edit link is the first thing you tab to
 >> in the current layout, I guess it isn't all that necessary. I have had a 


@@ -206,7 +106,7 @@ actions.  However, it may not be something everyone appreciates.  Any thoughts?
 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.
 Ok, that's my last 2 cents for a while. --[Mazirian](http://mazirian.com)
 
 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.
 Ok, that's my last 2 cents for a while. --[Mazirian](http://mazirian.com)
 

-> I don't support editing it, but if/when ikiwiki gets file upload support,
+> I don't support editing it, but if/when ikiwiki gets [[todo/fileupload]] support,

 > it'll be possible to upload a style sheet. (If .css is in the allowed
 > extensions list.. no idea how safe that would be, a style sheet is
 > probably a great place to put XSS attacks and evil javascript that would
 > it'll be possible to upload a style sheet. (If .css is in the allowed
 > extensions list.. no idea how safe that would be, a style sheet is
 > probably a great place to put XSS attacks and evil javascript that would


@@ -222,16 +122,6 @@ Ok, that's my last 2 cents for a while. --[Mazirian](http://mazirian.com)
 
 ----
 
 
 ----
 

-# RecentChanges should show path to wiki sub-pages?
-
-The RecentChanges only shows the final file name for the recently changes file,
-for example "discussion". It would be more useful to see "index/discussion"
-or the path to the sub-page. I think this is handled by the htmllink() routine.
-
-> Went ahead and did this, IMHO the display is ok as-is. --[[Joey]]
-
-----
-

 # Should not create an existing page
 
 This might be a bug, but will discuss it here first.
 # Should not create an existing page
 
 This might be a bug, but will discuss it here first.


@@ -250,20 +140,26 @@ Clicking on an old "?" or going to a create link but new Markdown content exists
 
 ----
 
 
 ----
 

-# Refreshing RecentChanges page
+# User database tools?

 
 

-What do you think about refreshing RecentChanges page (via Meta Refresh Tag)?
-It can be useful for users like me which rather prefer watching the last changes
-in WWW browser tab than subscribing to page. --Pawel
+Any tool to view user database?

 
 

-> Depends, if it were done the time period should be made configurable.
-> Unwanted server load due to refeshing could be a problem for some.
-> --[[Joey]]
+Any tool to edit the user database?
+
+> No, but it's fairly easy to write such tools in perl. For example, to
+> list all users in the user database:

 
 

->> Yes, it should be configurable by ikiwiki admin. I believe he's not
->> stupid and he will not set too short refresh period to kill his server :)
->> I propose to add `recentchanges_refresh` variable in ikiwiki setup
->> to setting refresh period. If it's not defined, then ikiwiki doesn't put
->> refresh meta tag into `recentchanges.tmpl`. Do you like it? ;) --Pawel
+       joey@kodama:~/src/joeywiki/.ikiwiki>perl -le 'use Storable; my $userinfo=Storable::retrieve("userdb"); print $_ foreach keys %$userinfo'         
+       http://joey.kitenet.net/
+       foo

 
 

->>> Seems reasonable --[[Joey]]
+> To list each user's email address:
+
+       joey@kodama:~/src/joeywiki/.ikiwiki>perl -le 'use Storable; my $userinfo=Storable::retrieve("userdb"); print $userinfo->{$_}->{email} foreach keys %$userinfo'
+       
+       joey@kitenet.net
+
+> Editing is simply a matter of changing values and calling Storable::store().
+> I've not written actual utilities to do this yet because I've only needed
+> to do it rarely, and the data I've wanted has been different each time.
+> --[[Joey]]