urosm
/
ikiwiki
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

responses and doc improvement

master
joey 2006-12-23 05:58:15 +00:00
parent 61b85443d1
commit be81a25cc5
3 changed files with 25 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
doc/bugs/HTML_is_not_update_nor_created_when_editing_markdown_via_CGI.mdwn
View File

@ -6,3 +6,14 @@ so when have new page it has a "?Page". (So CGI is working that much.) I edit ("
How to get that file generated automatically on save (via edit)? How to get that file generated automatically on save (via edit)?
If this is documented, sorry I missed it. If this is documented, sorry I missed it.
> If a revision control system is configured, ikiwiki relies on a hook
> being triggered by its commit to the RCS, which then runs ikiwiki again
> to do the build, same as happens when a commit is made to the RCS
> directly. If the appropriate hook is not uncommented and configured in
> the setup file, you could see the behavior you describe.
>
> If no revision control system is used, ikiwiki handles the build after
> writing the file.
>
> --[[Joey]]

9
doc/bugs/cgi_wrapper_always_regenerated.mdwn
View File

@ -5,3 +5,12 @@ Whenever I run ikiwiki with --setup with this same configuration, then each time
Should I use a different config? This is confusing because if I use a config without my cgi wrapper defined, I still have my left-over ikiwiki.cgi still in place (so CGI is enabled). Should I use a different config? This is confusing because if I use a config without my cgi wrapper defined, I still have my left-over ikiwiki.cgi still in place (so CGI is enabled).
It seems wasteful to update each time when my goal is just to create the HTML pges (since the CGI didn't generate them) as noted in my other bug report. It seems wasteful to update each time when my goal is just to create the HTML pges (since the CGI didn't generate them) as noted in my other bug report.
> If ikiwiki is run in refresh mode, it won't regnerate the wrapper. You
> want to run it in refresh mode, because it's also wastful to rebuild all
> the unchanged pages, which is done by default when setting up a wiki with
> --setup.
>
> Example of refresh mode: `ikiwiki -setup ikiwiki.setup --refresh`
>
> Improved the docs slightly, so I'll call this [[bugs/done]] --[[Joey]]

6
doc/usage.mdwn
View File

@ -56,10 +56,12 @@ These options control the mode that ikiwiki is operating in.
In setup mode, ikiwiki reads the config file, which is really a perl In setup mode, ikiwiki reads the config file, which is really a perl
program that can call ikiwiki internal functions. program that can call ikiwiki internal functions.
[[ikiwiki.setup]] is an example of such a config file.
The default action when --setup is specified is to automatically generate The default action when --setup is specified is to automatically generate
wrappers for a wiki based on data in a config file, and rebuild the wiki. wrappers for a wiki based on data in a config file, and rebuild the wiki.
If you only want to build any changed pages, you can use --refresh with
[[ikiwiki.setup]] is an example of such a config file. --setup.
* --wrappers * --wrappers