Extension:SVNIntegration

From MediaWiki.org

Manual on MediaWiki Extensions
List of MediaWiki Extensions

SVNIntegration Release status: stable
Implementation	Tag
Description	Adds some custom tags which allow an integration of files from Subversion repositories into the wiki.
Author(s)	StefanMackeTalk
Last Version	1.1.2 (2008-11-07)
MediaWiki	1.11
License	GPL
Download	http://f.macke.it/MediaWikiSVNIntegration
Hooks used ParserAfterTidy ArticleSave AlternateEdit

Contents 1 What can this extension do? 2 Usage 2.1 Screenshots 3 Download instructions 4 Prerequisites 5 Installation 6 See also 7 Changelog 7.1 Version 1.1.2 7.2 Version 1.1.1 7.3 Version 1.1.0 7.4 Version 1.0.2 7.5 Version 1.0.1 7.6 Version 1.0

[edit] What can this extension do?

This extension adds the following custom tags which allow an integration of files from Subversion repositories into the wiki:

SVNPrintFile 

Prints the contents of the given file using GeSHi for syntax highlighting if existent.

SVNFileInfo 

Prints some information about the given file (e.g. name, path, last author, last revision message etc.).

SVNFileHistory 

Prints the revision history for the given file.

SVNTodo 

Prints a list of TODO/FIXME/XXX comment tags found in the given file.

[edit] Usage

Some examples:

<svnFileInfo username="user" password="pass">http://svn.example.com/File.php</svnFileInfo>
<svnPrintFile revision="1" filetype="ini">http://svn.example.com/File.txt</svnPrintFile>
<svnFileHistory>http://svn.example.com/File.php</svnFileHistory>
<svnFileHistory r="103:HEAD">http://svn.example.com/File.php</svnFileHistory>

[edit] Screenshots

• See the svnFileInfo tag in action: http://f.macke.it/SVNIntegrationExample1
• See the svnTodo tag in action: http://f.macke.it/SVNIntegrationExample2

[edit] Download instructions

Until further notice you can download the extension here: http://f.macke.it/MediaWikiSVNIntegration

[edit] Prerequisites

• MediaWiki >= 1.11 due to use of function "wfLoadExtensionMessages".
• VersionControl_SVN PEAR package must be installed to be able to use this extension.
  • You need to apply the patch from Info.php.patch to VersionControl/SVN/Info.php to get this extension to work.
• If you would like to get the file output syntax highlighted you also need the GeSHiHighlight extension for MediaWiki.

[edit] Installation

1. Extract the files from the archive to "extensions/SVNIntegration"
2. Configure some needed values in "SVNIntegration.setup.php"
3. Insert the following line into your "LocalSettings.php" (behind GeSHi inclusion if existent)

include("extensions/SVNIntegration/SVNIntegration.setup.php");

1. (optional) Insert the following line into your "main.css"

@import "/extensions/SVNIntegration/SVNIntegration.css";

[edit] See also

• VersionControl_SVN PEAR package
• GeSHiHighlight
• Extension:GoogleCode integration with Google Project Hosting

[edit] Changelog

[edit] Version 1.1.2

• svnPrintFile now accepts parameters startLine and endLine to print only parts of files.

[edit] Version 1.1.1

• Fixed problem with editing sections when database contains searchable text from SVN.

[edit] Version 1.1.0

• Fixed problem with configuration of SVN path in VersionControl: now you need to configure the path to the svn binary only in the extension's setup.
• Added SVNTodo functionality.
• The SVN output can now optionally be appended to the article's text in the database so that it becomes searchable.
• An empty username and/or password is now supported.

[edit] Version 1.0.2

• Added patch for VersionControl_SVN_Info (fixes disability to get file information from SVN)

[edit] Version 1.0.1

• Fixed invalid switches "username" and "password" for VersionControl_SVN_Info
• Fixed invalid parameter "filetype" for VersionControl_SVN

[edit] Version 1.0

• Initial release