releasing version 2.31.1

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

diff --git a/doc/index/discussion.mdwn b/doc/index/discussion.mdwn
index 4b8b1448314583da7b536e3fa0b21261c9aceb1b..4cf38e9cbb2d00577528d118a917d44127634b4f 100644 (file)
--- a/doc/index/discussion.mdwn
+++ b/doc/index/discussion.mdwn
@@ -25,9 +25,47 @@ of via syslog?
 > > 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.
 
 > > 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.
 

+----
+
+# Installation of selected docs (html)
+
+The latest release has around 560 files (over 2MB) in html.
+
+Any suggestions or ideas on limiting what html is installed?
+
+For example, I don't see value in every ikiwiki install out there to also install personal "users" ikiwiki pages.
+
+For now I copy ikiwiki.setup. And then use pax with -L switch to copy the targets of the symlinks of the basewiki.
+
+I was thinking of making a list of desired documents from the html directory to install.
+
+--JeremyReed
+
+> You don't need any of them, unless you want to read ikiwiki's docs locally.
+> 
+> I don't understand why you're installing the basewiki files manually;
+> ikiwiki has a Makefile that will do this for you. --[[Joey]]
+
+>> The Makefile's install doesn't do what I want so I use different installer for it.
+>> It assumes wrong location for man pages for me. (And it should consider using INSTALLVENDORMAN1DIR and
+>> MAN1EXT but I don't know about section 8 since I don't know of perl value for that.)
+>> I don't want w3m cgi installed; it is optional for my package.
+>> I will just patch for that instead of using my own installer.
+>> Note: I am working on the pkgsrc package build specification for this. This is for creating
+>> packages for NetBSD, DragonFly and other systems that use pkgsrc package system.
+>> --JeremyReed
+
+# Installation as non-root user
+
+I'd like to install ikiwiki as a non-root user. I can plow through getting all the 
+perl dependencies installed because that's well documented in the perl world,
+but I don't know how to tell ikiwiki to install somewhere other than / --BrianWilson
+
+----
+

 # Upgrade steps
 
 # Upgrade steps
 

-I upgrades from 1.37 to 2.6.1. I ran "ikiwiki --setup" using my existing ikiwiki.setup configuration.
+I upgrades from 1.40  to 2.6.1. I ran "ikiwiki --setup" using my existing ikiwiki.setup configuration.

 I had many errors like:
 
     /home/bsdwiki/www/wiki/wikilink/index.html independently created, not overwriting with version from wikilink
 I had many errors like:
 
     /home/bsdwiki/www/wiki/wikilink/index.html independently created, not overwriting with version from wikilink


@@ -41,27 +79,137 @@ and:
 Probably about six errors like this. I worked around this by removing the files and directories it complained about.
 Finally it finished.
 
 Probably about six errors like this. I worked around this by removing the files and directories it complained about.
 Finally it finished.
 

+> As of version 2.0, ikiwiki enables usedirs by default. See
+> [[tips/switching_to_usedirs]] for details. --[[Joey]]
+
+>> I read the config wrong. I was thinking that it showed the defaults even though commented out
+>> (like ssh configs do). I fixed that part. --JeremyReed
+

 My next problem was that ikiwiki start letting me edit without any password authentication. It used to prompt
 me for a password but now just goes right into the "editing" mode.
 The release notes for 2.0 say password auth is still on by default.
 
 My next problem was that ikiwiki start letting me edit without any password authentication. It used to prompt
 me for a password but now just goes right into the "editing" mode.
 The release notes for 2.0 say password auth is still on by default.
 

+> It sounds like you have the anonok plugin enabled?
+
+>> Where is the default documented? My config doesn't have it uncommented.
+

 The third problem is that when editing my textbox is empty -- no content.
 
 This is using my custom rcs.pm which has been used thousands of times.
 
 The third problem is that when editing my textbox is empty -- no content.
 
 This is using my custom rcs.pm which has been used thousands of times.
 

+> Have you rebuilt the cgi wrapper since you upgraded ikiwiki? AFAIK I
+> fixed a bug that could result in the edit box always being empty back in
+> version 2.3. The only other way it could happen is if ikiwiki does not
+> have saved state about the page that it's editing (in .ikiwiki/index).
+
+>> Rebuilt it several times. Now that I think of it, I think my early problem of having
+>> no content in the textbox was before I rebuilt the cgi. And after I rebuilt the whole webpage was empty.
+

 Now I regenerated my ikiwiki.cgi again (no change to my configuration,
 and I just get an empty HTML page when attempting editing or "create".
 
 Now I regenerated my ikiwiki.cgi again (no change to my configuration,
 and I just get an empty HTML page when attempting editing or "create".
 

+> If the page is completly empty then ikiwiki is crashing before it can
+> output anything, though this seems unlikely. Check the webserver logs.
+

 Now I see it created directories for my data. I fixed that by setting 
 usedirs (I see that is in the release notes for 2.0) and rerunning ikiwiki --setup
 but I still have empty pages for editing (no textbox no html at all).
 
 Now I see it created directories for my data. I fixed that by setting 
 usedirs (I see that is in the release notes for 2.0) and rerunning ikiwiki --setup
 but I still have empty pages for editing (no textbox no html at all).
 

+> Is IkiWiki crashing? If so, it would probably leave error text in the apache logs. --[[TaylorKillian]]
+
+>> Not using apache. Nothing useful in logs other thn the HTTP return codes are "0" and bytes is "-"
+>> on the empty ikiwiki.cgi output (should say " 200 " followed by bytes).
+
+>>> You need to either figure out what your web server does with stderr
+>>> from cgi programs, or run ikiwiki.cgi at the command line with an
+>>> appropriate environment so it thinks it's being called from a web
+>>> server, so you can see how it's failing. --[[Joey]]
+

 (I am posting this now, but will do some research and post some more.)
 
 Is there any webpage with upgrade steps?
 
 (I am posting this now, but will do some research and post some more.)
 
 Is there any webpage with upgrade steps?
 

+> Users are expected to read [[news]], which points out any incompatible
+> changes or cases where manual action is needed.
+
+>> I read it but read the usedirs option wrong :(.
+>> Also it appears to be missing the news from between 1.40 to 2.0 unless they dont' exist.
+>> If they do exist maybe they have release notes I need?
+
+>>> All the old ones are in the NEWS file. --[[Joey]]
+

 --JeremyReed
 
 --JeremyReed
 

+My followup: I used a new ikiwiki.setup based on the latest version. But no changes for me.
+
+Also I forgot to mention that do=recentchanges works good for me. It uses my 
+rcs_recentchanges in my rcs perl module.
+
+The do=prefs does nothing though -- just a blank webpage.
+
+> You need to figure out why ikiwiki is crashing. The webserver logs should
+> tell you.
+
+I also set verbose => 1 and running ikiwiki --setup was verbose, but no changes in running CGI.
+I was hoping for some output.
+
+I am guessing that my rcs perl module stopped working on the upgrade. I didn't notice any release notes
+on changes to revision control modules. Has something changed? I will also look.
+
+> No, the rcs interface has not needed to change in a long time. Also,
+> nothing is done with the rcs for do=prefs.
+
+>> Thanks. I also checked differences between 1.40 Rcs plugins and didn't notice anything significant.
+
+--JeremyReed
+
+Another Followup: I created a new ikiwiki configuration and did the --setup to 
+create an entirely different website. I have same problem there. No prompt for password
+and empty webpage when using the cgi.
+I never upgraded any perl modules so maybe a new perl module is required but I don't see any errors so I don't know.
+
+The only errors I see when building and installing ikiwiki are:
+
+    Can't exec "otl2html": No such file or directory at IkiWiki/Plugin/otl.pm line 66.
+
+    gettext 0.14 too old, not updating the pot file
+
+I don't use GNU gettext on here.
+
+I may need to revert back to my old ikiwiki install which has been used to thousands of times (with around
+1000 rcs commits via ikiwiki).
+
+--JeremyReed
+
+I downgraded to version 1.40 (that was what I had before I wrote wrong above).
+Now ikiwiki is working for me again (but using 1.40). I shouldn't have tested on production system :)
+
+--JeremyReed
+
+I am back. On a different system, I installed ikiwiki 2.6.1. Same problem -- blank CGI webpage.
+
+So I manually ran with:
+
+    REQUEST_METHOD=GET QUERY_STRING='do=create&page=jcr' kiwiki.cgi
+
+And clearly saw the error:
+
+    [IkiWiki::main] Fatal: Bad template engine CGI::FormBuilder::Template::div: Can't locate CGI/FormBuilder/Template/div.pm
+
+So I found my version was too old and 3.05 is the first to provide "Div" support. I upgraded my p5-CGI-FormBuilder to 3.0501.
+And ikiwiki CGI started working for me.
+
+The Ikiwiki docs about this requirement got removed in Revision 4367. There should be a page that lists the requirements.
+(I guess I could have used the debian/control file.)
+
+> There is a page, [[install]] documents that 3.05 is needed.
+
+>> Sorry, I missed that. With hundreds of wikipages it is hard to read all of them.
+>> I am updating the download page now to link to it.
+
+I am now using ikiwiki 2.6.1 on my testing system.
+
+--JeremyReed

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


@@ -92,6 +240,15 @@ easily, perl is possible (but I'm not strong in perl).
 >> 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]]
 

+
+>> Sounds great indeed. Learning from [here](http://www.bddebian.com/~wiki/AboutTheTWikiToIkiwikiConversion/) that HTML::WikiConverter needed for your conversion was not up-to-date on Debian I have now done an unofficial package, including your proposed Markdown patches, apt-get'able at <pre>deb http://debian.jones.dk/ sid wikitools</pre>
+>> -- [[JonasSmedegaard]]
+
+
+>>I see the "We will post the scripts ...." was committed about a year ago.  A current site search for "Moin" does not turn them up.  Any chance of an appearance in the near (end of year) future?
+>>
+>> -- [[MichaelRasmussen]]
+

 ----
 
 # LaTeX support?
 ----
 
 # LaTeX support?


@@ -202,6 +359,16 @@ Any tool to edit the user database?
 > to do it rarely, and the data I've wanted has been different each time.
 > --[[Joey]]
 
 > to do it rarely, and the data I've wanted has been different each time.
 > --[[Joey]]
 

+>> Thanks for these examples -- I have been using them. I don't know the
+>> Storable yet. Can someone share an example of removing a user? (I now
+>> setup account\_creation\_password and I have some spammer with different
+>> login names that I have banned that I might as well remove from the
+>> userdb.)
+
+>>> Let's see, you could do something like this:
+>>>    perl -le 'use Storable; my $userinfo=Storable::retrieve("userdb"); delete $$userinfo{"joey"}; Storable::lock_store($userinfo, "userdb")'
+>>> I suppose I should stop being lame and create a command line tool wrapping up these operations.. --[[Joey]]
+

 ----
 
 # Spaces in WikiLinks?
 ----
 
 # Spaces in WikiLinks?


@@ -238,6 +405,9 @@ I'm playing around with various ways that I can use subversion with ikiwiki.
 > away without running the post-commit wrapper on commit, and all you lose
 > is the ability to send commit notification emails.
 
 > away without running the post-commit wrapper on commit, and all you lose
 > is the ability to send commit notification emails.
 

+> (And now that [[recentchanges]] includes rss, you can just subscribe to
+> that, no need to worry about commit notification emails anymore.)
+

 * 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.
 
 --[[AdamShand]]
 * 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.
 
 --[[AdamShand]]


@@ -246,3 +416,25 @@ I'm playing around with various ways that I can use subversion with ikiwiki.
 > in the same repo. If you have two wikis in one repository, you will need
 > to write a post-commit script that calls the post-commit wrappers for each
 > wiki.
 > in the same repo. If you have two wikis in one repository, you will need
 > to write a post-commit script that calls the post-commit wrappers for each
 > wiki.

+
+----
+
+# Regex for Valid Characters in Filenames
+
+I'm sure that this is documented somewhere but I've ransacked the wiki and I can't find it.  :-(  What are the allowed characters in an ikiwiki page name?  I'm writing a simple script to make updating my blog easier and need to filter invalid characters (so far I've found that # and , aren't allowed ;-)).  Thanks for any pointers.  -- [[AdamShand]]
+
+> The default `wiki_file_regexp` matches filenames containing only
+> `[-[:alnum:]_.:/+]`
+> 
+> The IkiWiki::titlepage() function will convert freeform text to a valid
+> page name. See [[todo/should_use_a_standard_encoding_for_utf_chars_in_filenames]]
+> for an example. --[[Joey]]
+
+>> Perfect, thanks! 
+>>
+>> In the end I decided that I didn't need any special characters in filenames and replaced everything but alphanumeric characters with underscores.  In addition to replacing bad characters I also collapse multiple underscores into a single one, and strip off trailing and leading underscores to make tidy filenames.  If it's useful to anybody else here's a sed example:
+>>
+>>     # echo "++ Bad: ~@#$%^&*()_=}{[];,? Iki: +_-:./ Num: 65.5 ++" | sed -e 's/[^A-Za-z0-9_]/_/g' -e 's/__*/_/g' -e 's/^_//g' -e 's/_$//g'
+>>     Bad_Iki_Num_65_5
+>>
+>>--[[AdamShand]]