https://github.com/leocornus/tracutils

All kind of utilities for incorporating Trac into MediaWiki
https://github.com/leocornus/tracutils

Last synced: 5 days ago
JSON representation

All kind of utilities for incorporating Trac into MediaWiki

• Host: GitHub
• URL: https://github.com/leocornus/tracutils
• Owner: leocornus
• License: gpl-2.0
• Created: 2014-06-18T11:14:40.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2015-02-04T14:00:13.000Z (almost 10 years ago)
• Last Synced: 2024-03-26T01:46:01.551Z (8 months ago)
• Language: PHP
• Size: 215 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE

Awesome Lists containing this project

README

        
TracUtils

=========

All kind of utilities for incorporating Trac_ into MediaWiki_.

- `Change Logs `_

- `TODO List `_

- `Features`_

- `Installation and Configuration`_

Features

========

**ticket tag**

We will introduce a new tag named **ticket** to 

provide a easy and flexible way to link a ticket number.

For example, if you have the following wikitext 

on a wiki page::

  Please check 2378 for details

When we visit the wiki page, we should have this following

HTML::

  Please check 

  2378 for details.

`MediaWiki Tag Extensions`_ page hase all we need to create a

tag for MediaWiki_.

**commit tag**

Similar to the **ticket** tag, the **commit** tag will generate

a hyperlink to a commit id.

**milestone tag**

The **milestone** tag will provide a overall summary for a 

milestone planned in Trac_ project.

Installation and Configuration

==============================

Install **TracUtils** as a regular MediaWiki_ extension::

  require_once("$IP/extensions/TracUtils/TracUtils.php");

We should make our extension user configuable.

Check `MediaWiki Making your extension user configurable`_

for more details.

The extension will offer the following configuration options:

- $wgTracTicketLinkPattern defines the hyperlink pattern for 

  **ticket** tag. 

  **[TICKET_ID]** will be replaced with the actural ticket id.

- $wgTracCommitLinkPattern defines the hyperlink pattern for

  **commit** tag. 

  **[COMMIT_ID]** will be replaced with the actural commit id.

Here are some examples::

  $wgTracTicketLinkPattern = "http://url.to.trac/ticket?id=[TICKET_ID]"

  $wgTracCommitLinkPattern = "http://url.to.trac/commit?id=[COMMIT_ID]"

License

=======

GNU General Public License Version 2  

.. _Trac: http://trac.edgewall.org/

.. _MediaWiki: http://www.mediawiki.org/

.. _MediaWiki Tag Extensions: http://www.mediawiki.org/wiki/Manual:Tag_extensions

.. _MediaWiki Making your extension user configurable: http://www.mediawiki.org/wiki/Manual:Developing_extensions#Making_your_extension_user_configurable