]> rtime.felk.cvut.cz Git - ert_linux_web.git/blob - ikiwiki.setup
Fix typos etc.
[ert_linux_web.git] / ikiwiki.setup
1 # IkiWiki::Setup::Yaml - YAML formatted setup file
2 #
3 # Setup file for ikiwiki.
4
5 # Passing this to ikiwiki --setup will make ikiwiki generate
6 # wrappers and build the wiki.
7
8 # Remember to re-run ikiwiki --setup any time you edit this file.
9 #
10 # name of the wiki
11 wikiname: LinTarget
12 # contact email for wiki
13 adminemail: sojkam1@fel.cvut.cz
14 # users who are wiki admins
15 adminuser: []
16 # users who are banned from the wiki
17 banned_users: []
18 # where the source of the wiki is located
19 srcdir: ''
20 # where to build the wiki
21 destdir: ''
22 # base url to the wiki
23 url: 'http://lintarget.sourceforge.net/'
24 # url to the ikiwiki.cgi
25 cgiurl: ''
26 # filename of cgi wrapper to generate
27 cgi_wrapper: ''
28 # mode for cgi_wrapper (can safely be made suid)
29 cgi_wrappermode: 06755
30 # number of seconds to delay CGI requests when overloaded
31 cgi_overload_delay: ''
32 # message to display when overloaded (may contain html)
33 cgi_overload_message: ''
34 # enable optimization of only refreshing committed changes?
35 only_committed_changes: 0
36 # rcs backend to use
37 rcs: ''
38 # plugins to add to the default configuration
39 add_plugins:
40   - html
41   - toc
42 # plugins to disable
43 disable_plugins: []
44 # additional directory to search for template files
45 templatedir: /usr/share/ikiwiki/templates
46 # base wiki source location
47 underlaydir: /usr/share/ikiwiki/basewiki
48 # display verbose messages?
49 #verbose: 1
50 # log to syslog?
51 #syslog: 1
52 # create output files named page/index.html?
53 usedirs: 1
54 # use '!'-prefixed preprocessor directives?
55 prefix_directives: 1
56 # use page/index.mdwn source files
57 indexpages: 1
58 # enable Discussion pages?
59 discussion: 1
60 # name of Discussion pages
61 discussionpage: Discussion
62 # generate HTML5?
63 html5: 0
64 # only send cookies over SSL connections?
65 sslcookie: 0
66 # extension to use for new pages
67 default_pageext: mdwn
68 # extension to use for html files
69 htmlext: html
70 # strftime format string to display date
71 timeformat: '%c'
72 # UTF-8 locale to use
73 #locale: en_US.UTF-8
74 # put user pages below specified page
75 userdir: ''
76 # how many backlinks to show before hiding excess (0 to show all)
77 numbacklinks: 10
78 # attempt to hardlink source files? (optimisation for large files)
79 hardlink: 0
80 # force ikiwiki to use a particular umask (keywords public, group or private, or a number)
81 #umask: public
82 # group for wrappers to run in
83 #wrappergroup: ikiwiki
84 # extra library and plugin directory
85 libdir: ''
86 # environment variables
87 ENV: {}
88 # time zone name
89 #timezone: US/Eastern
90 # regexp of normally excluded files to include
91 #include: ^\.htaccess$
92 # regexp of files that should be skipped
93 #exclude: ^(*\.private|Makefile)$
94 # specifies the characters that are allowed in source filenames
95 wiki_file_chars: -[:alnum:]+/.:_
96 # allow symlinks in the path leading to the srcdir (potentially insecure)
97 allow_symlinks_before_srcdir: 0
98 # cookie control
99 cookiejar:
100   file: /home/wsh/.ikiwiki/cookies
101 # set custom user agent string for outbound HTTP requests e.g. when fetching aggregated RSS feeds
102 #useragent: Wget/1.13.4 (linux-gnu)
103
104 ######################################################################
105 # core plugins
106 #   (editpage, htmlscrubber, inline, link, meta, parentlinks)
107 ######################################################################
108
109 # htmlscrubber plugin
110 # PageSpec specifying pages not to scrub
111 #htmlscrubber_skip: '!*/Discussion'
112
113 # inline plugin
114 # enable rss feeds by default?
115 #rss: 0
116 # enable atom feeds by default?
117 #atom: 0
118 # allow rss feeds to be used?
119 #allowrss: 0
120 # allow atom feeds to be used?
121 #allowatom: 0
122 # urls to ping (using XML-RPC) on feed update
123 pingurl: []
124
125 ######################################################################
126 # auth plugins
127 #   (anonok, blogspam, httpauth, lockedit, moderatedcomments,
128 #    opendiscussion, openid, passwordauth, signinedit)
129 ######################################################################
130
131 # anonok plugin
132 # PageSpec to limit which pages anonymous users can edit
133 #anonok_pagespec: '*/discussion'
134
135 # blogspam plugin
136 # PageSpec of pages to check for spam
137 #blogspam_pagespec: postcomment(*)
138 # options to send to blogspam server
139 #blogspam_options: blacklist=1.2.3.4,blacklist=8.7.6.5,max-links=10
140 # blogspam server XML-RPC url
141 #blogspam_server: ''
142
143 # httpauth plugin
144 # url to redirect to when authentication is needed
145 #cgiauthurl: http://example.com/wiki/auth/ikiwiki.cgi
146 # PageSpec of pages where only httpauth will be used for authentication
147 #httpauth_pagespec: '!*/Discussion'
148
149 # lockedit plugin
150 # PageSpec controlling which pages are locked
151 #locked_pages: '!*/Discussion'
152
153 # moderatedcomments plugin
154 # PageSpec matching users or comment locations to moderate
155 #moderate_pagespec: '*'
156
157 # openid plugin
158 # url pattern of openid realm (default is cgiurl)
159 #openid_realm: ''
160 # url to ikiwiki cgi to use for openid authentication (default is cgiurl)
161 #openid_cgiurl: ''
162
163 # passwordauth plugin
164 # a password that must be entered when signing up for an account
165 #account_creation_password: s3cr1t
166 # cost of generating a password using Authen::Passphrase::BlowfishCrypt
167 #password_cost: 8
168
169 ######################################################################
170 # format plugins
171 #   (creole, highlight, hnb, html, mdwn, otl, po, rawhtml, rst, textile,
172 #    txt)
173 ######################################################################
174
175 # highlight plugin
176 # types of source files to syntax highlight
177 #tohighlight: .c .h .cpp .pl .py Makefile:make
178 # location of highlight's filetypes.conf
179 #filetypes_conf: /etc/highlight/filetypes.conf
180 # location of highlight's langDefs directory
181 #langdefdir: /usr/share/highlight/langDefs
182
183 # mdwn plugin
184 # enable multimarkdown features?
185 #multimarkdown: 0
186 # disable use of markdown discount?
187 #nodiscount: 0
188
189 # po plugin
190 # master language (non-PO files)
191 #po_master_language: en|English
192 # slave languages (translated via PO files) format: ll|Langname
193 #po_slave_languages:
194 #- fr|Français
195 #- es|Español
196 #- de|Deutsch
197 # PageSpec controlling which pages are translatable
198 #po_translatable_pages: '* and !*/Discussion'
199 # internal linking behavior (default/current/negotiated)
200 #po_link_to: current
201
202 ######################################################################
203 # special-purpose plugins
204 #   (osm, underlay)
205 ######################################################################
206
207 # osm plugin
208 # the default zoom when you click on the map link
209 #osm_default_zoom: 15
210 # the icon shown on links and on the main map
211 #osm_default_icon: ikiwiki/images/osm.png
212 # the alt tag of links, defaults to empty
213 #osm_alt: ''
214 # the output format for waypoints, can be KML, GeoJSON or CSV (one or many, comma-separated)
215 #osm_format: KML
216 # the icon attached to a tag, displayed on the map for tagged pages
217 #osm_tag_default_icon: icon.png
218 # Url for the OpenLayers.js file
219 #osm_openlayers_url: http://www.openlayers.org/api/OpenLayers.js
220 # Layers to use in the map. Can be either the 'OSM' string or a type option for Google maps (GoogleNormal, GoogleSatellite, GoogleHybrid or GooglePhysical). It can also be an arbitrary URL in a syntax acceptable for OpenLayers.Layer.OSM.url parameter.
221 #osm_layers:
222 #  OSM: GoogleSatellite
223 # Google maps API key, Google layer not used if missing, see https://code.google.com/apis/console/ to get an API key
224 #osm_google_apikey: ''
225
226 # underlay plugin
227 # extra underlay directories to add
228 #add_underlays:
229 #- /home/wsh/wiki.underlay
230
231 ######################################################################
232 # web plugins
233 #   (404, attachment, comments, editdiff, edittemplate, getsource, google,
234 #    goto, mirrorlist, remove, rename, repolist, search, theme, userlist,
235 #    websetup, wmd)
236 ######################################################################
237
238 # attachment plugin
239 # enhanced PageSpec specifying what attachments are allowed
240 #allowed_attachments: virusfree() and mimetype(image/*) and maxsize(50kb)
241 # virus checker program (reads STDIN, returns nonzero if virus found)
242 #virus_checker: clamdscan -
243
244 # comments plugin
245 # PageSpec of pages where comments are allowed
246 #comments_pagespec: blog/* and !*/Discussion
247 # PageSpec of pages where posting new comments is not allowed
248 #comments_closed_pagespec: blog/controversial or blog/flamewar
249 # Base name for comments, e.g. "comment_" for pages like "sandbox/comment_12"
250 #comments_pagename: ''
251 # Interpret directives in comments?
252 #comments_allowdirectives: 0
253 # Allow anonymous commenters to set an author name?
254 #comments_allowauthor: 0
255 # commit comments to the VCS
256 #comments_commit: 1
257 # Restrict formats for comments to (no restriction if empty)
258 #comments_allowformats: mdwn txt
259
260 # getsource plugin
261 # Mime type for returned source.
262 #getsource_mimetype: text/plain; charset=utf-8
263
264 # mirrorlist plugin
265 # list of mirrors
266 #mirrorlist: {}
267 # generate links that point to the mirrors' ikiwiki CGI
268 #mirrorlist_use_cgi: 1
269
270 # repolist plugin
271 # URIs of repositories containing the wiki's source
272 #repositories:
273 #- svn://svn.example.org/wiki/trunk
274
275 # search plugin
276 # path to the omega cgi program
277 #omega_cgi: /usr/lib/cgi-bin/omega/omega
278 # use google site search rather than internal xapian index?
279 #google_search: 1
280
281 # theme plugin
282 # name of theme to enable
283 #theme: actiontabs
284
285 # websetup plugin
286 # list of plugins that cannot be enabled/disabled via the web interface
287 #websetup_force_plugins: []
288 # list of additional setup field keys to treat as unsafe
289 #websetup_unsafe: []
290 # show unsafe settings, read-only, in web interface?
291 #websetup_show_unsafe: 1
292
293 ######################################################################
294 # widget plugins
295 #   (calendar, color, conditional, cutpaste, date, format, fortune,
296 #    graphviz, haiku, headinganchors, img, linkmap, listdirectives, map,
297 #    more, orphans, pagecount, pagestats, poll, polygen, postsparkline,
298 #    progress, shortcut, sparkline, table, template, teximg, toc, toggle,
299 #    version)
300 ######################################################################
301
302 # calendar plugin
303 # base of the archives hierarchy
304 #archivebase: archives
305 # PageSpec of pages to include in the archives; used by ikiwiki-calendar command
306 #archive_pagespec: page(posts/*) and !*/Discussion
307
308 # listdirectives plugin
309 # directory in srcdir that contains directive descriptions
310 #directive_description_dir: ikiwiki/directive
311
312 # teximg plugin
313 # Should teximg use dvipng to render, or dvips and convert?
314 #teximg_dvipng: ''
315 # LaTeX prefix for teximg plugin
316 #teximg_prefix: '\documentclass{article}
317 #
318 #  \usepackage[utf8]{inputenc}
319 #
320 #  \usepackage{amsmath}
321 #
322 #  \usepackage{amsfonts}
323 #
324 #  \usepackage{amssymb}
325 #
326 #  \pagestyle{empty}
327 #
328 #  \begin{document}
329 #
330 #'
331 # LaTeX postfix for teximg plugin
332 #teximg_postfix: \end{document}
333
334 ######################################################################
335 # other plugins
336 #   (aggregate, autoindex, brokenlinks, camelcase, ddate, embed, favicon,
337 #    filecheck, flattr, goodstuff, htmlbalance, localstyle, notifyemail,
338 #    pagetemplate, pingee, pinger, prettydate, recentchanges,
339 #    recentchangesdiff, relativedate, rsync, sidebar, smiley,
340 #    sortnaturally, tag, testpagespec, trail, transient, typography)
341 ######################################################################
342
343 # aggregate plugin
344 # enable aggregation to internal pages?
345 #aggregateinternal: 1
346 # allow aggregation to be triggered via the web?
347 #aggregate_webtrigger: 0
348
349 # autoindex plugin
350 # commit autocreated index pages
351 #autoindex_commit: 1
352
353 # camelcase plugin
354 # list of words to not turn into links
355 #camelcase_ignore: []
356
357 # flattr plugin
358 # userid or user name to use by default for Flattr buttons
359 #flattr_userid: joeyh
360
361 # pinger plugin
362 # how many seconds to try pinging before timing out
363 #pinger_timeout: 15
364
365 # prettydate plugin
366 # format to use to display date
367 #prettydateformat: '%X, %B %o, %Y'
368
369 # recentchanges plugin
370 # name of the recentchanges page
371 recentchangespage: recentchanges
372 # number of changes to track
373 recentchangesnum: 100
374
375 # rsync plugin
376 # command to run to sync updated pages
377 #rsync_command: rsync -qa --delete . user@host:/path/to/docroot/
378
379 # sidebar plugin
380 # show sidebar page on all pages?
381 #global_sidebars: 1
382
383 # tag plugin
384 # parent page tags are located under
385 #tagbase: tag
386 # autocreate new tag pages?
387 #tag_autocreate: 1
388 # commit autocreated tag pages
389 #tag_autocreate_commit: 1
390
391 # typography plugin
392 # Text::Typography attributes value
393 #typographyattributes: 3