Difference between revisions of "Documentation/OHITool"

From Semantic CorA
Jump to: navigation, search
(Known issues)
(Usage)
 
(45 intermediate revisions by 3 users not shown)
Line 1: Line 1:
 
=== OHI Tool ===
 
=== OHI Tool ===
{{TNT|Extension|templatemode=
 
|name          = OHITool
 
|status        = beta
 
|type1        = Interface
 
|type2        = Special
 
|hook1        = BeforePageDisplay
 
|hook2        = SkinAfterContent
 
|hook3        = ArticleSaveComplete
 
|username      = LiaVeja
 
|author        = Lia Veja
 
|description  = Provides an interface for a VRE based on Semantic MediaWiki that allows researchers to carry out Qualitative Analysis of social interaction using Objective Hermeneutical methodology. 
 
|image        =
 
|imagesize    =
 
|version      = 2.0.0
 
|update        = 2018-01-29
 
|mediawiki    = 1.29+
 
|php          =
 
|license      = MIT
 
|download      = {{TNT|WikimediaDownload|OHITool}}
 
|needs-updatephp = No
 
|readme        =
 
|changelog    =
 
|parameters    =
 
|tags          =
 
|rights        = ohitool
 
|example      =
 
|compatibility =
 
}}
 
 
 
The '''OHITool''' extension is an extension used in a Virtual Research Environmen based on  Semantic MediaWiki and allows reaserchers to carry out Qualitative Analysis of social interaction using Objective Hermeneutical methodology. The extension particularly has been tailored to be use  for classroom interaction analysis.  
 
The '''OHITool''' extension is an extension used in a Virtual Research Environmen based on  Semantic MediaWiki and allows reaserchers to carry out Qualitative Analysis of social interaction using Objective Hermeneutical methodology. The extension particularly has been tailored to be use  for classroom interaction analysis.  
  
Line 35: Line 6:
 
== Download ==
 
== Download ==
  
{{TNT|WikimediaGitCheckout}}
+
Download the [https://smw-cora.org/index.php/File:OHI.zip zip file] and extract it to the folder of your MediaWiki installation, unter the folder ''extensions''.
  
 
== Installation ==
 
== Installation ==
 +
This extension requires [https://www.mediawiki.org/wiki/Extension:Semantic_MediaWiki Semantic MediaWiki],
 +
[https://www.mediawiki.org/wiki/Extension:Semantic_MediaWiki Semantic Result Formats] and [https://www.mediawiki.org/wiki/Extension:Header_Tabs Header Tabs] to be installed first.
  
{{TNT|note}} This extension requires [[Extension:Semantic MediaWiki|Semantic MediaWiki]] to be installed first.
+
Please edit the file '''LocalSettings.php''' and add the following line:
{{TNT|ExtensionInstall}}
+
 
 +
require_once( "$IP/extensions/OHI/OHI.php" );
 +
 
 +
The extension will be installed under the Section '''Other special pages''' of  Special:SpecialPages, under the name '''Objective Hermeneutic Interpretor Tool'''.  
  
 
== Usage ==
 
== Usage ==
  
 
This is a brief introduction on how to use the OHITool. A more detailed guide will appear on this page in the near future.
 
This is a brief introduction on how to use the OHITool. A more detailed guide will appear on this page in the near future.
 +
 +
 +
'''Important'''. After the installation, in the extension folder, there is a folder ''OHI/resources/templates''. An XML file contaning templates, forms and semantic properties could be automatically created using [[Special:Import|Special:Import]] procedure of MediaWiki. The import will also create a complete example of a transcript, in the main namespace, under the ''Neu_Ethik_Klasse6_Fremdsein_apaek02152'' name.
 +
 +
In order to start a new transcript, please call special page '''Formular:Erhebungsmaterial_Metadaten''', if your wiki is in German, otherwise call '''Form:Erhebungsmaterial_Metadaten''' (for English). After you collect the transcript data and save the formular, you should see the following interface:
 +
 +
[[File:OHITool1.jpg|600px]]
 +
 +
An explanation for abbreviation used by tool is here (German version): [[Documentation/OHITool/Help|Help]].
 +
 +
  You will find detailed instructions, written in English, on how to use the OHITool
 +
  under the following links:
 +
  [[General information on working with Semantic CorA]]
 +
  [[Working with Semantic CorA]]
 +
  [[Creating a new transcript]]
 +
 +
  The same instructions are also available in German:
 +
  [[Allgemeine Hinweise zum Arbeiten mit Semantic CorA]]
 +
  [[Mit Semantic CorA arbeiten]]
 +
  [[Ein neues Transkript erstellen]]
 +
 +
=== List of Templates and Forms ===
 +
 +
==== Templates ====
 +
 +
#Erhebungsmaterial Metadaten
 +
#Extension DPL
 +
#Fallstrukturanalyse
 +
#ShowText
 +
#Show Metadata
 +
#StoreFallstrukturanalyse
 +
#StoreFallstrukturhypothese
 +
#TextAnnotation
 +
#TextAnnotationLevel2
 +
#TextAnnotationLevel3
 +
#TextAnnotationNew
 +
#Transkript
 +
#Transkript kurz
 +
#Zeige Metadata
 +
 +
==== Forms ====
 +
#Erhebungsmaterial Metadaten
 +
#Erhebungsmaterial Metadaten 2
 +
#Fallstrukturanalyse
 +
#Linkliste
 +
#Medien
 +
#TextAnnotation
  
 
=== About Objective Hermeneutic method ===
 
=== About Objective Hermeneutic method ===
For an extensive information about Objective Hermeneutic method, please consult [].
+
For an extensive information about Objective Hermeneutic method, please consult the following papers (in English):
 +
* [http://opensym.lero.ie/wp-content/uploads/2017/08/a10-veja.pdf SMW based VRE for addressing multi-layered data analysis: The use case of classroom interaction interpretation]
 +
* [https://dh2017.adho.org/abstracts/DH2017-abstracts.pdf#page=580 Interfacing collaborative and multiple-layered spaces of interpretation in humanities research: The case of semantically-enhanced objective hermeneutics.]
 +
*[http://www.qualitative-research.net/index.php/fqs/article/view/21/46 Competence and Praxis: Sequential Analysis in German Sociology]
 +
 
 +
 
 
In the following picture we present the ontology of classroom interaction:
 
In the following picture we present the ontology of classroom interaction:
  
Line 58: Line 86:
 
You may also consult the presentation of the talk given at the OpenSym'17 conference in Galway, Ireland:
 
You may also consult the presentation of the talk given at the OpenSym'17 conference in Galway, Ireland:
  
[https://semantic-cora.org/index.php/File:SMW_VRE_for_multi-layered_data_analysis.pdf|SMW Based VRE for Addressing Multi-Layered Data Analysis – The Use Case of Classroom Interaction Interpretation]
+
[https://semantic-cora.org/index.php/File:SMW_VRE_for_multi-layered_data_analysis.pdf SMW Based VRE for Addressing Multi-Layered Data Analysis – The Use Case of Classroom Interaction Interpretation].
  
 
=== Known issues ===
 
=== Known issues ===
 
*This tool is usually required in German space, due the fact that it was a genuine German idea. This is the reason that properties, templates
 
*This tool is usually required in German space, due the fact that it was a genuine German idea. This is the reason that properties, templates
 
and interface is in German. For the next version, we plan to have an English version also.
 
and interface is in German. For the next version, we plan to have an English version also.
 +
*The Header Tabs extension is incompaticle with '''Tweeki''' skin. See: [https://www.mediawiki.org/wiki/Extension:Header_Tabs#Incompatible_extensions_and_skins Incompatible extensions and skins]. It would be recommendable to use [https://www.mediawiki.org/wiki/Skin:Vector Vector skin], or [[Cora_Skin_implementation|Cora skin]] instead.
 
*If you find a bug, please report it on the [[Extension_talk:OHITool|discussion page]].
 
*If you find a bug, please report it on the [[Extension_talk:OHITool|discussion page]].
 +
 +
===Citation===
 +
If you use our software, we would be really happy if you cite our work like this:  Kminek, H., Meier, M., Hocker, J. Veja, L., Schindler, C, Sticht, K. (2018). OHTool:  Extension for Objective Hermeneutics for Semantic MediaWiki [Software]. Online available at: https://semantic-cora.org/index.php/Documentation/OHITool
  
 
[[Category:Semantic MediaWiki extensions]][[Category:Documentation]]
 
[[Category:Semantic MediaWiki extensions]][[Category:Documentation]]

Latest revision as of 14:57, 27 August 2019

OHI Tool

The OHITool extension is an extension used in a Virtual Research Environmen based on Semantic MediaWiki and allows reaserchers to carry out Qualitative Analysis of social interaction using Objective Hermeneutical methodology. The extension particularly has been tailored to be use for classroom interaction analysis.

It was developed within the research project SMW-CorA and funded by the DFG.

Download

Download the zip file and extract it to the folder of your MediaWiki installation, unter the folder extensions.

Installation

This extension requires Semantic MediaWiki, Semantic Result Formats and Header Tabs to be installed first.

Please edit the file LocalSettings.php and add the following line:

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

The extension will be installed under the Section Other special pages of Special:SpecialPages, under the name Objective Hermeneutic Interpretor Tool.

Usage

This is a brief introduction on how to use the OHITool. A more detailed guide will appear on this page in the near future.


Important. After the installation, in the extension folder, there is a folder OHI/resources/templates. An XML file contaning templates, forms and semantic properties could be automatically created using Special:Import procedure of MediaWiki. The import will also create a complete example of a transcript, in the main namespace, under the Neu_Ethik_Klasse6_Fremdsein_apaek02152 name.

In order to start a new transcript, please call special page Formular:Erhebungsmaterial_Metadaten, if your wiki is in German, otherwise call Form:Erhebungsmaterial_Metadaten (for English). After you collect the transcript data and save the formular, you should see the following interface:

OHITool1.jpg

An explanation for abbreviation used by tool is here (German version): Help.

 You will find detailed instructions, written in English, on how to use the OHITool 
 under the following links:
 General information on working with Semantic CorA
 Working with Semantic CorA
 Creating a new transcript
 The same instructions are also available in German:
 Allgemeine Hinweise zum Arbeiten mit Semantic CorA 
 Mit Semantic CorA arbeiten
 Ein neues Transkript erstellen

List of Templates and Forms

Templates

  1. Erhebungsmaterial Metadaten
  2. Extension DPL
  3. Fallstrukturanalyse
  4. ShowText
  5. Show Metadata
  6. StoreFallstrukturanalyse
  7. StoreFallstrukturhypothese
  8. TextAnnotation
  9. TextAnnotationLevel2
  10. TextAnnotationLevel3
  11. TextAnnotationNew
  12. Transkript
  13. Transkript kurz
  14. Zeige Metadata

Forms

  1. Erhebungsmaterial Metadaten
  2. Erhebungsmaterial Metadaten 2
  3. Fallstrukturanalyse
  4. Linkliste
  5. Medien
  6. TextAnnotation

About Objective Hermeneutic method

For an extensive information about Objective Hermeneutic method, please consult the following papers (in English):


In the following picture we present the ontology of classroom interaction:

Ontology.jpg

Also, the researcher will follow the Objective Hermeneutic protocol, as in the picture:

Workflow.png

You may also consult the presentation of the talk given at the OpenSym'17 conference in Galway, Ireland:

SMW Based VRE for Addressing Multi-Layered Data Analysis – The Use Case of Classroom Interaction Interpretation.

Known issues

  • This tool is usually required in German space, due the fact that it was a genuine German idea. This is the reason that properties, templates

and interface is in German. For the next version, we plan to have an English version also.

Citation

If you use our software, we would be really happy if you cite our work like this: Kminek, H., Meier, M., Hocker, J. Veja, L., Schindler, C, Sticht, K. (2018). OHTool: Extension for Objective Hermeneutics for Semantic MediaWiki [Software]. Online available at: https://semantic-cora.org/index.php/Documentation/OHITool