Talk:Toolserver/TStoc
Add topic | This page is kept for historical interest. Any policies mentioned may be obsolete. If you want to revive the topic, you can use the talk page or start a discussion on the community forum. |
Most things are optional. If in a hurry, just throw up the URL and title, and somebody else may edit in the rest for you.
TSTOC only pays attention to {{ToolserverProject}}. All other text is ignored by TSTOC, so feel free to add any niceties or ornaments for human use as needed. (in particular, the ==Headers== are arbitrary and unused by TSTOC)
If you'd like to see the immediate results of an edit without saving changes on-wiki, place a tool's information in /home/interiot/tstoc.txt while editing (it will override any on-wiki information). Once you have everything looking good, please move the tool's information to this page so it can be edited by others if needed.
Attributes
[edit]- url
- The URL of the tool. Typically should be something on the toolserver, but offsite tools running on database dumps may be interesting to toolserver users as well, or toolserver tools may store their output on-wiki.
- title
- A short title for the tool
- description (optional)
- A one or two sentence description for the tool. HTML or other markup can't be used.
- long-description-HTML (optional)
- Only allowed in /home/interiot/tstoc.txt due to malicious HTML issues. Use as much text as needed to describe a tool, this information will be displayed in the pop-up.
- tags
- A way to informally classify tools. These have no special meaning to scripts, they mean whatever users want them to mean. Please feel free to add new tags or rename or rearrange existing tags.
- released
- The approximate date that the tool was publically released. TSTOC sorts newest tools on top, to give more exposure to tools that users may not have heard about before. If not specified, TSTOC will use the ctime of the script, though this is a rough estimate that can be corrupted, so it's best to explicitely specify a release date.
- updated (optional)
- If a tool has be so significantly updated that it may attract new users, updating this value will make the tool appear at the top of the list to attract new attention. "Significantly updated" is subjective, but try not to overuse this.
- specific-to (optional)
- If the tool can't be used across all servers and all languages, this specifies the specific languages it can be used for. (for some things like "commons", that can alternately be conveyed via the tags field). Specify multiple servers by separating them by spaces.
- programminglanguage (optional)
- The programming language the tool was written in. In most cases, TSTOC can figure this out on its own, especially if it can figure out the path to the tool.
- file (optional)
- When JSP or mod_rewrite are used, TSTOC may not be able to figure out where on the filesystem the tool is, preventing it from deriving some other data. This specifies the final location on disk where it's at. (usually used in /home/interiot/tstoc.txt in case privacy or security issues are a concern)
- username (optional)
- In most cases, TSTOC can figure out who the author is based on the URL or filename. In a few cases, it may be necessary to explicitely state the author's toolserver username (case is sensitive).
- status (optional)
- Things that may be hidden or hilighted in specific views. Possible values:
- nonWM
- Not directly related to content on the Wikimedia servers (eg. pages, categories, users, logs, etc). Tools related only to things on the toolserver, or to MediaWiki software generally but not Wikimedia content specifically, should be marked with nonWM as well.
- alpha
- Alpha quality software. (may be hidden from view when minor/deprecated tools are hidden)
- manualreport
- A report that's infrequently updated.
- rating (optional)
- Valid values: 1, 2, 3, 4, or 5. Tools rated as 1 or 2 will be hidden when the "minor/deprecated" checkbox is off. Tools rated 5 will be hilighted with a star. Feel free to assign any meanings, as long as one user doesn't have more than ~20% of their tools as 5, or more than ~20% as 4. Feel free to assign them in an author-specific way, rather than relative to other tools (eg. if an author has three tools, assign one as "5" just because it's their own best work, even if it's not necessarily better than other author's rated-4s.) "3" is a tool of average usefulness, and it's expected that the largest number of tools will be rated 3.
- url-mask (optional) (not yet used)
- Specifies additional URLs that should count towards this tool's hits when scanning the Apache logs
Other documentation
[edit]The username displayed on TSTOC can be specified by adding displayname= to your ~/.about.me. If no displayname is specified, TSTOC uses whichever field (ircname or wikiname) that is listed first in the ~/.about.me.
Running /home/interiot/cgi-bin/tstoc --dump [--purge] from the toolserver will dump the parsed and auto-generated information, making it easier to build tools on top of this data.
Discussion
[edit]Wow, thanks! Can you please change the file format to use templates? Everything but the templates should be ignored (see Literate programming). -- Nichtich 22:48, 7 May 2006 (UTC)
Example
[edit]| you type: | {{ToolserverProject|
|url=http://tools.wikimedia.de/~magnus/wiki2xml/w2x.php
|title=WikiMarkup-to-XML
|description=WikiMarkup-to-XML-to-text/DocBook/PDF/ODT/XHTML converter
|released=May 1, 2006
|tags=wikitext}}
|
|---|---|
| shown as: |
|
Additional ideas and wishes
[edit]- Include user data: {{ToolserverUser|name=voj|display=JakobVoss|home=http://de.wikipedia.org/wiki/Benutzer:JakobVoss}}
- Additional fields for projects:
- help: an URL with detailed description of the tool (usually a wiki page) - optional
- status: Development Status (beta/stable) - needed to filter out projects that should not prominently be presented to all visitors.
- password needed for "action=purge"
- {{ToolserverUser}} is basically covered by ~/.about.me now. I don't mind putting it on-wiki, but it would be nicer to have a single reliable source for it.
- For templates, that's a very good idea I think. I will look into doing this.
- Yes, I want some kind of field to hide some tools as well, but still make them available if someone really wants to see ALL possible tools available. For instance, I think that everyone should try out CatScan and an edit counter at least once, though perhaps not everyone would be interested in StubSense. I'm not sure how to do that objectively though, other than perhaps counting hits in the Apache logs, though that's made more difficult by some tools that do AJAX stuff, and do many many queries (eg. River's username-matching tool) that I'd have to sort out by hand.
- For help... See the long-description-HTML in /home/interiot/tstoc.txt, and the popups on TSTOC. I can make any changes to make the popup easier to use... is that sufficient? --Interiot 04:54, 29 June 2006 (UTC)
Bug? Missing author.
[edit]My project QICbot has an empty author field on the toolserverpage. What is going on? --Dschwen 13:15, 1 April 2007 (UTC)
How do you edit toolserver.org?
[edit]How do you edit this page: http://toolserver.org/~interiot/cgi-bin/tstoc?
How about writing out these obscure acronyms for others to understand: RFA, SUL, etc. Odessaukrain 18:47, 18 October 2008 (UTC)