aboutsummaryrefslogtreecommitdiff
path: root/doc/plugins/autoindex/discussion.mdwn
blob: 2d6b6f1f0ad3b4e0944e4f81884442011765055f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
Would it be possible to add an option to only generate the index files
for the html output and not place the markdown files in the wiki source?

The reason being that I have a lot of directories which need to be autoindexed,
but I would prefer if the index files didn't clutter up my git repository.

even without that feature the plugin is a great help, thanks


------

If you just don't want to clutter your git repo, below it's a patch does the following:

* If you set autoindex_commit to 0 in your ikiwiki.setup file, we *do* place auto-generated markdown files in the **wiki source** but *not* in the **repo**

* If you set autoindex_commit to 1 (this is the default), auto-generated index files will be put in the repo provided you enabled rcs backend.

<pre>
--- autoindex.pm.orig	2009-10-01 17:13:51.000000000 +0800
+++ autoindex.pm	2009-10-01 17:21:09.000000000 +0800
@@ -17,6 +17,13 @@
 			safe => 1,
 			rebuild => 0,
 		},
+        autoindex_commit => {
+            type => 'boolean',
+            default => 1,
+            description => 'commit generated autoindex pages into RCS',
+            safe => 0,
+            rebuild => 0,
+        },
 }
 
 sub genindex ($) {
@@ -25,7 +32,7 @@
 	my $template=template("autoindex.tmpl");
 	$template->param(page => $page);
 	writefile($file, $config{srcdir}, $template->output);
-	if ($config{rcs}) {
+	if ($config{rcs} and $config{autoindex_commit}) {
 		IkiWiki::rcs_add($file);
 	}
 }
@@ -94,13 +101,13 @@
 	}
 	
 	if (@needed) {
-		if ($config{rcs}) {
+		if ($config{rcs} and $config{autoindex_commit}) {
 			IkiWiki::disable_commit_hook();
 		}
 		foreach my $page (@needed) {
 			genindex($page);
 		}
-		if ($config{rcs}) {
+		if ($config{rcs} and $config{autoindex_commit}) {
 			IkiWiki::rcs_commit_staged(
 				gettext("automatic index generation"),
 				undef, undef);
</pre>

 
Warning:  I guess this patch may work, but I *haven't tested it yet*.  -- [[weakish]]