- Introduction
- Svnwiki properties
- svnwiki:title
- svnwiki:application-url
- svnwiki:authenticate
- svnwiki:charset
- svnwiki:css
- svnwiki:frozen
- svnwiki:raw
- svnwiki:template
- svnwiki:edit-deny
- svnwiki:create-text
- svnwiki:toc
- svnwiki:javascript
- svnwiki:pdf-document-class
- svnwiki:pdf-lang
- svnwiki:pdf
- svnwiki:confirm-save
- svnwiki:search-register
- svnwiki:static-url
- svnwiki:stats-file
- svnwiki:stats-ignore
- svnwiki:ignore
- svnwiki:text:edit
- svnwiki:text:post
- svnwiki:text:history
- svnwiki:text:discuss:link-zero
- svnwiki:text:discuss:link-one
- svnwiki:text:discuss:link-many
- svnwiki:text:xml
- svnwiki:text:tags
- svnwiki:text:links:del.icio.us
- svnwiki:icon
- svnwiki:discuss
- svnwiki:discuss-subject
- Weblog extension
- Archives extension
- RSS
- Links in wiki pages
- Upload binary files
- Rating
Introduction
Svnwiki uses Subversion properties exahustively to control the functionality of the wiki. The following is a list of some of the properties it recognizes:
Svnwiki properties
svnwiki:title
When rendering a file, Svnwiki will use the file's name as its title. Sometimes this is undesirable: you may want to make your file's name short and use dashes instead of spaces. In this case, set svnwiki:title to the string you want Svnwiki to use as the file's title instead of its name.
For example, in a weblog post free-software-and-the-web, you may want to use "How Web 2.0 threatens software users' freedoms" as the title. The second string would probably make a very bad file name (for example, the URL would get lots of %20 and it would be very long and difficult to type), so you use a better string as the file name and use svnwiki:title.
svnwiki:application-url
The URL where the CGI for the Svnwiki installation for the wiki can be accessed. This is used by the svnwiki-post-commit program to create HTML links to the CGI application.
It should end with the name for the wiki (from the config.scm file) followed by a slash.
svnwiki:authenticate
If set to yes on a file, the Svnwiki web interface will require users to provide authentication tokens in order to modify it. Basically, the Other option in the Identity section of the Edit form will be disabled.
You can set this property on a directory to afect all its contents recursively.
See svnwiki:frozen for a way to make it impossible (even for users with access to the Subversion repository) to modify a file through Svnwiki's web interface.
svnwiki:charset
Set this property to the name of the character encoding you want to use for the contents of the files in your wiki.
By default this is "utf-8".
Usually this is set on the root directory containing the entire wiki. You can also set it on different files or directories if you need to maintain information in different character encodings within the same wiki.
Note that this only affects the contents of files, not their names. As of 2007-06-28, you can only have files with names in us-ascii in a wiki handled by Svnwiki.
svnwiki:css
Set this property in the root of the repository to the full URL for the cascading style sheet you want to apply to all files.
You can override this value by setting the property to a different values on files or directories (applies to all its contents recursively).
svnwiki:frozen
Set this property to yes in some file and svnwiki won't let users modify it through the web interface. You will, of course, still be able to modify it through Subversion.
You can set it on a directory and all its included files will be affected as well.
In the future, setting it to no will reverse its effect (allowing you, for example, to set it to yes on some directory and then to no in some subdirectory).
See svnwiki:authenticate for a way require users to provide authentication tokens in order to modify a certain file.
svnwiki:raw
Set this property (to any value, usually you'll want to use the empty string) on files and svnwiki will output them as they are (rather than parsing them as wiki files and converting them to HTML). If you set this property on a directory, it will apply to all its files and directories recursively.
svnwiki:template
This property allows you to override the default template that svnwiki uses to render wiki pages to HTML. You should set it to the absolute path where the HTML file lives inside the wiki directory. This file can include special sequences starting with a %.
svnwiki:edit-deny
...
svnwiki:create-text
...
svnwiki:toc
The svnwiki:toc property, which is usually set in the root of a Subversion repository for a wiki handled by Svnwiki but which you can set in individual files or directories, should be set to the path to the file in the repository that you want Svnwiki to include as the menu for all other files.
This menu is usually shown in a small box at the left of the articles with links to the main pages in the wiki. Depending on the CSS and template for the wiki it could be shown elsewhere (or even completely hidden).
svnwiki:javascript
...
svnwiki:pdf-document-class
...
svnwiki:pdf-lang
...
svnwiki:pdf
...
svnwiki:confirm-save
...
svnwiki:search-register
Set to no on a file or directory and its contents won't be registered to the search engine's database. Note that if they had already been registered, they won't get erased (but they won't get updated neither).
svnwiki:static-url
Must be / terminated.
svnwiki:stats-file
The URL to the file that svnwiki-stats will use in HTML plots. Should be the URL (probably absolute, or at least start with a slash) for a 1x1 pixel image of any color you want.
svnwiki:stats-ignore
No access nor commit stats will be generated for the files or directories this property is set on.
svnwiki:ignore
Ignores a given file (or directory). The value of the property is ignored (use the empty string).
svnwiki:text:edit
Replace the text in the links to edit articles (which is “Edit” by default).
svnwiki:text:post
Replace the text in the links to post new comments in discussions (which is “Post” by default).
svnwiki:text:history
Replace the text in the links to the history of the articles (which is “History” by default).
svnwiki:text:discuss:link-zero
Replace the text used to link from article pages to discussion pages when the discussion pages don't have any comments (which is “Discussion” by default).
svnwiki:text:discuss:link-one
Replace the text used to link from article pages to discussion pages when the discussion pages have more than one comment (which is “Discussion (~N)” by default). In this string the sequence “~N” will be replaced with the number of comments.
svnwiki:text:discuss:link-many
Replace the text used to link from article pages to discussion pages when the discussion pages have more than one comment (which is “Discussion (~N)” by default). In this string the sequence “~N” will be replaced with the number of comments.
svnwiki:text:xml
Replace the “XML” text used to link to the ATOM/RSS of each page.
svnwiki:text:tags
Replace the “Tags” text used to link to the list of tags of a given page.
svnwiki:text:links:del.icio.us
Affects the links svnwiki extension, replacing the message shown next to the links to save a page in del.icio.us (which defaults to "Save to del.icio.us").
svnwiki:icon
Optional with the URL to the Favicon shortcut icon.
svnwiki:discuss
Set to no on a file or directory and the links to discussion pages won't be shown.
svnwiki:discuss-subject
If set to no on a given file, its Discussion page won't prompt for a subject. You can set it on a directory to affect all its contents.
Weblog extension
svnblog:separator
...
svnblog:ignore
For directories managed by the weblog extension, all their files will be considered part of the weblog (eg. included in the main page or archives) except those that have the svnblog:ignore property set. You can set the property on directories and svnblog will skip all their contents.
svnblog:creation-date
If set on a post, its value will be used as its date. Svnblog will normally use the date of the first commit to the file. The value should be the number of seconds since the beginning of the epoch (eg. "1151879185").
svnblog:count
Set it on the directory on which you enable the weblog extension (the svnwiki:handler property) to a number; svnblog will show exactly that number of posts in the generated index (or less if the directory doesn't have that number of files yet).
The default value is 10.
Archives extension
svnarchive:ignore
Set it on a directory or file to cause the archive extension to ignore it.
RSS
svnwiki:rss:include
Can be "yes" (default) or "no" on a directory or a specific file to control whether or not it will be included in RSSs.
Links in wiki pages
The following properties control wich links are shown at the top of a wiki page. They all default to "yes" and can be set on specific files or on directories to affect their content recursively.
You can disable a set of links in a single step with the following bash command:
for link in pdf history do svn ps svnwiki:links:$link "no" example-file done
svnwiki:links
This properties controls whether links are shown at all. If you set it to "no", no links will be shown (regardless of the value of the other properties).
svnwiki:links:atom
If set to "yes", shows the link to the RSS.
svnwiki:links:tags
If set to "yes", shows the link to a page that shows the set of tags for the file.
svnwiki:links:upload
If set to "yes", show the "Upload" link that allows users to upload binary files.
svnwiki:links:stats
If set to "yes", shows the link to the statistics generated for the file.
svnwiki:links:pdf
If set to "yes", shows the link for the generated PDF.
svnwiki:links:edit
If set to "yes", shows the link to the edition form. Note that this property does not disable the edition of the file and adding ?action=edit to the URL will show the edit form.
See svnwiki:frozen for a way to make it impossible (even for users with access to the Subversion repository) to modify a file through Svnwiki's web interface.
See svnwiki:authenticate also.
svnwiki:links:history
If set, show the link to the history of the files.
svnwiki:links:discuss
If set, show the link that shows the current entries in the discussions of the file and also a form to add new entries to the discussion.
Upload binary files
svnwiki:upload:allow-overwrite
Default to "yes". Set to "no" and Svnwiki won't allow the upload functionality to overwrite existing files.
svnwiki:upload:enable
Default to "yes". Set to "no" on a directory and Svnwiki won't allow uploads to it.
Rating
The following properties control the behaviour of the rating extension.
svnwiki:rating:best-name
Specifies the name of the file that should be generated with the highest rated files (minus the “.html” extension). It defaults to xsvnwiki-rating-top. You should set it on a directory (it will affect subdirectories as well).
svnwiki:rating:best-count
Controls the number of files that will be shown in the file with the highest rated files. It defaults to 10. You should set it on a directory (it will affect subdirectories as well).
svnwiki:rating:votes-image-up
If set, instead of the text “Vote down”, and image with the URL specified will be shown. Tipically this will be a thumbs-down icon. You can set this on a directory to affect all its contents recursively (usually you'll just set it on the base of your wiki).
svnwiki:rating:votes-image-down
If set, instead of the text “Vote up”, and image with the URL specified will be shown. Tipically this will be a thumbs-up icon. You can set this on a directory to affect all its contents recursively (usually you'll just set it on the base of your wiki).
Last update: 2007-11-26 (Rev 13166)