Difference between revisions of "Extension:SemanticComments"

Latest revision as of 01:17, 21 January 2013

Description

SemanticComments is an extension that displays & manages any number of comments and replies that are attached to any page in a wiki. This extension stores comments in semantic properties while also providing an alternative to TALK namespaces for each SUBJECT namespace in a wiki.

The SemanticComments extension was derived from the Project Halo Collaboration extension by Hypergrove.

Setup

To install SemanticComments, please follow the steps indicated below.

Download instructions

The latest release may be found .

Prerequisites

Semantic MediaWiki 1.8+

Copy Files

Extract the downloaded archive into folder $IP/extensions/SemanticComments/

LocalSettings.php

Add the following to LocalSettings.php:

include_once("$IP/extensions/SemanticComments/SemanticComments.php");

enableSemanticComments();

Import ontology

SemanticComments comes with a small ontology to provide functionality for displaying and querying existing comments and some icons. Go to Special:Import and upload /extensions/SemanticComments/import/SemanticComments.xml

Import graphics

To use the delivered icons you need to upload the following files in your wiki:

/extensions/SemanticComments/skins/icons/bad_active.png
/extensions/SemanticComments/skins/icons/neutral_active.png
/extensions/SemanticComments/skins/icons/good_active.png
/extensions/SemanticComments/skins/icons/defaultuser.gif
/extensions/SemanticComments/skins/icons/Comment_icon_crystal.png

Please be sure that you keep the original file names.
Options: All configuration options are defined in /SemanticComments/SemanticComments.php.; To reformat the style of existing comments or of the comment form, use the Cascading Style Sheet in the '/skins' directory.

Usage

Enter {{ShowComments|show=True}} to any article where you want to get a list of all 'related comments' and a form that allows you to enter new comments.

From the list of Special pages, go to page “Special:SemanticComments”.

Languages supported

SemanticComments has support for three languages so far:

English
German
French

Extension Wishlist

Store all comments and their replies in subobjects on a single page in the Comment namespace.

@@ Line 6: / Line 6: @@
 |type3         = ajax
 |username      =
-|author        = Benjamin Langguth & others, [[User:Pokoptsev|Dmitry Pokoptsev]]
+|author        = Benjamin Langguth & others
 |description   = This extension manages comments for a page, using the Comment namespace.
 |image         =
@@ Line 31: / Line 31: @@
 ==Setup==
-===Download instructions===
-The latest release may be found .
-===Installation===
-* [[Extension:Semantic MediaWiki|Semantic MediaWiki 1.8+]]
 To install SemanticComments, please follow the steps indicated below.
+;Download instructions
+:The latest release may be found .
+;Prerequisites
+:[[Extension:SemanticMediaWiki|Semantic MediaWiki 1.8+]]
+;Copy Files
+:Extract the downloaded archive into folder $IP/extensions/SemanticComments/
+;LocalSettings.php
+:Add the following to [[Manual:LocalSettings.php|LocalSettings.php]]:
+:<syntaxhighlight lang="php">include_once("$IP/extensions/SemanticComments/SemanticComments.php");</syntaxhighlight>
+:<syntaxhighlight lang="php">enableSemanticComments();</syntaxhighlight>
+;Import ontology
+:SemanticComments comes with a small ontology to provide functionality for displaying and querying existing comments and some icons.  Go to [[Special:Import]] and upload <code>/extensions/SemanticComments/import/SemanticComments.xml</code>
+;Import graphics
+:To use the delivered icons you need to upload the following files in your wiki:
+#/extensions/SemanticComments/skins/icons/bad_active.png
+#/extensions/SemanticComments/skins/icons/neutral_active.png
+#/extensions/SemanticComments/skins/icons/good_active.png
+#/extensions/SemanticComments/skins/icons/defaultuser.gif
+#/extensions/SemanticComments/skins/icons/Comment_icon_crystal.png
+:Please be sure that you keep the original file names.
+;Options
+:All configuration options are defined in /SemanticComments/SemanticComments.php.
+:
+:To reformat the style of existing comments or of the comment form, use the Cascading Style Sheet in the '/skins' directory.
-===Copy Files===
+==Usage==
-Extract the downloaded archive into your extension folder so that you get the following path $IP/extensions/SemanticComments/
+Enter <code><nowiki>{{ShowComments|show=True}}</nowiki></code> to any article where you want to get a list of all 'related comments' and a form that allows you to enter new comments.
-{{$IP}}
-===LocalSettings.php===
-Add the following to [[Manual:LocalSettings.php|LocalSettings.php]]:
-<syntaxhighlight lang="php">include_once("$IP/extensions/SemanticComments/SemanticComments.php");</syntaxhighlight>
-<syntaxhighlight lang="php">enableSemanticComments();</syntaxhighlight>
-===Process the extension setup===
-SemanticComments comes with a small ontology to provide functionality for displaying and querying existing comments and some icons.
-For that go to Special:Import, select and upload '/extensions/SemanticComments/import/SemanticComments.xml'
-To use the delivered icons you need to upload the following files in your wiki:
-#'/extensions/SemanticComments/skins/icons/bad_active.png'
-#'/extensions/SemanticComments/skins/icons/neutral_active.png'
-#'/extensions/SemanticComments/skins/icons/good_active.png'
-#'/extensions/SemanticComments/skins/icons/defaultuser.gif'
-#'/extensions/SemanticComments/skins/icons/Comment_icon_crystal.png'
-Please be sure that you keep the original file names.
-Options:
-========
-All configuration options are defined and described in /SemanticComments/SemanticComments.php.
-To reformat the style of existing comments or of the comment form, use the provided Cascading Style Sheet in '/skins' directory.
-===Testing your installation===
-Now you can enter {{ShowComments|show=True}} to any article where you want to get a
-list of all 'related comments' and a form that allows you to enter new comments.
 From the list of Special pages, go to page “Special:SemanticComments”.