Difference between revisions of "Tool template"

From TEIWiki
Jump to navigation Jump to search
(link to TaDiRAH)
 
(15 intermediate revisions by 4 users not shown)
Line 1: Line 1:
 +
When creating or revising a page for a particular tool, please consider copying and pasting this code to help structure the page. Though it's possible to use MetaWiki templates instead, it's hard to learn how to edit pages generated using templates as well as templates themselves, so for now we'll use this simpler method.
 +
 +
''Consider revising the categories below to use [https://github.com/Tadirah/TaDiRAH TaDiRAH]?''
 +
 +
<pre>
 
[[Category:Tools]]
 
[[Category:Tools]]
  
 +
(Leave one or more of the following on the page to automatically categorize
 +
the page for this tool. Take out this notice and all categories that the tool
 +
does NOT fit into.)
  
 
+
(These are the original categories)
 +
[[Category:Administrative tools]]
 +
[[Category:Development tools]]
 +
[[Category:Editing tools]]
 +
[[Category:Conversion and preprocessing tools]]
 +
[[Category:Testing and QA tools]]
 
[[Category:Publishing and delivery tools]]
 
[[Category:Publishing and delivery tools]]
 
[[Category:Querying tools]]
 
[[Category:Querying tools]]
 
[[Category:Analysis tools]]
 
[[Category:Analysis tools]]
 
[[Category:Header creation tools]]
 
[[Category:Header creation tools]]
[[Category:All-in-one tools]]
+
[[Category:All-in-one Tools]]
 +
[[Category:Interfaces]]
 +
 
 +
(These are "scholarly primitives")
 +
[[Category:Discovering]]
 +
[[Category:Annotating]]
 +
[[Category:Comparing]]
 +
[[Category:Referring]]
 +
[[Category:Sampling]]
 +
[[Category:Illustrating]]
 +
[[Category:Representing]]
  
 
== Synopsis ==
 
== Synopsis ==
 +
(give name of tool and brief description)
  
XAIRA : XML Aware Indexing and Retrieval Architecture
+
== Features ==
 +
* first feature
 +
* second feature
 +
* third feature
  
== Features ==
+
== User commentary ==
* operates on large collections (1 to 1000 million tokens) of XML documents
+
'''Please sign all comments.'''
* provides full range of linguistic analysis tools and methods
+
(please leave the above note about signing comments, and add signed comments here below it)
* platform independent indexer and server with documented API
 
* full-featured  Microsoft windows client
 
* combines the structured search cabilities of e.g. exist or a rdbms with the free text capabilities of eg Lucene or a traditional concordancer
 
  
 
== System requirements ==
 
== System requirements ==
 
+
(type in that information here)
Clients need a reasonable amount of memory (e.g. 640 Mb); indexer performs faster with more memory, but is primarily disk-bound. A corpus of x Mb will need 2x Mb of index, and 4x scratch space during indexing process.
 
  
 
== Source code and licensing ==
 
== Source code and licensing ==
 
+
(Is it open-source?  If so, what license type?)
GPL.
+
(For non-open source software, What does a license cost?)
 
+
(Is there any technical support fee?  How often do you have to pay it?)
No fees.
+
(Is there any discount for academic institutions?)
 +
(Is there a discount for TEI members?)
  
 
== Support for TEI ==
 
== Support for TEI ==
 
+
(Does it support TEI or TEI Lite "out of the box"?)
Supports TEI documents out of the box.
+
(How easily can TEI be implemented?)
 
+
(Are there customized versions of the tool created for the TEI community, perhaps even by those not affiliated with the tool's creators?)
  
 
== Language(s) ==
 
== Language(s) ==
 +
(What computer language is the tool written in?)
 +
(What language(s) are used in the interface?)
 +
(What language(s) are used in the documentation?)
  
Written in C++, API is documented with dOxygen.
+
== Documentation ==
 
+
(link to or information about documentation available)
User manuals etc. in TEI (but still under development)
 
  
 
== Tech support ==
 
== Tech support ==
 
+
(What technical support is provided by the creators of the tool?)
Best endeavours... there is a mailing list on SourceForge
 
  
 
== User community ==
 
== User community ==
 
+
(Are there any communities of users?)
Yes
 
  
 
== Sample implementations ==
 
== Sample implementations ==
 
+
(links to demo sites running the tool or successful implementations of it)
http://www.natcorp.ox.ac.uk
 
 
 
  
 
== Current version number and date of release ==
 
== Current version number and date of release ==
1.23 Feb 2007
+
(type in that information here)
  
 
== History of versions ==
 
== History of versions ==
Line 61: Line 83:
  
 
== How to download or buy ==
 
== How to download or buy ==
Visit http://xaira.sf.net
+
(type in that information here)
  
 +
== Additional notes ==
 +
(type in that information here)
 +
</pre>
  
== Additional notes ==
+
[[Category:TEI Wiki]]

Latest revision as of 20:27, 7 March 2014

When creating or revising a page for a particular tool, please consider copying and pasting this code to help structure the page. Though it's possible to use MetaWiki templates instead, it's hard to learn how to edit pages generated using templates as well as templates themselves, so for now we'll use this simpler method.

Consider revising the categories below to use TaDiRAH?

[[Category:Tools]]

(Leave one or more of the following on the page to automatically categorize 
the page for this tool. Take out this notice and all categories that the tool 
does NOT fit into.)

(These are the original categories)
[[Category:Administrative tools]]
[[Category:Development tools]]
[[Category:Editing tools]]
[[Category:Conversion and preprocessing tools]]
[[Category:Testing and QA tools]]
[[Category:Publishing and delivery tools]]
[[Category:Querying tools]]
[[Category:Analysis tools]]
[[Category:Header creation tools]]
[[Category:All-in-one Tools]]
[[Category:Interfaces]]

(These are "scholarly primitives")
[[Category:Discovering]]
[[Category:Annotating]]
[[Category:Comparing]]
[[Category:Referring]]
[[Category:Sampling]]
[[Category:Illustrating]]
[[Category:Representing]]

== Synopsis ==
(give name of tool and brief description)

== Features ==
* first feature
* second feature
* third feature

== User commentary ==
'''Please sign all comments.'''
(please leave the above note about signing comments, and add signed comments here below it)

== System requirements ==
(type in that information here)

== Source code and licensing ==
(Is it open-source?  If so, what license type?)
(For non-open source software, What does a license cost?)
(Is there any technical support fee?  How often do you have to pay it?)
(Is there any discount for academic institutions?)
(Is there a discount for TEI members?)

== Support for TEI ==
(Does it support TEI or TEI Lite "out of the box"?)
(How easily can TEI be implemented?)
(Are there customized versions of the tool created for the TEI community, perhaps even by those not affiliated with the tool's creators?)

== Language(s) ==
(What computer language is the tool written in?)
(What language(s) are used in the interface?)
(What language(s) are used in the documentation?)

== Documentation ==
(link to or information about documentation available)

== Tech support ==
(What technical support is provided by the creators of the tool?)

== User community ==
(Are there any communities of users?)

== Sample implementations ==
(links to demo sites running the tool or successful implementations of it)

== Current version number and date of release ==
(type in that information here)

== History of versions ==
(type in that information here)

== How to download or buy ==
(type in that information here)

== Additional notes ==
(type in that information here)