Toolhub/cs

This page is a translated version of the page Toolhub and the translation is 2% complete.

Toolhub is a community managed catalog of software tools used in the Wikimedia movement. Technical volunteers can use Toolhub to document the tools that they create or maintain. All Wikimedians can use Toolhub to search for tools to help with their workflows and to create lists of useful tools to share with others.

Visit Toolhub

What is a "tool"?

In Toolhub, "tool" is an inclusive term for software applications which interact with the Wikimedia projects without being fully implemented by MediaWiki. This includes things like user scripts, gadgets, bots, templates, lua modules, web applications, and mobile apps. The catalog is intended to be inclusive rather than exclusive as long as the things it documents are useful for improving workflows and user experiences when interacting with the projects of the Wikimedia movement.

Content license

Toolinfo.json data and other structured data collected in Toolhub is licensed under the Creative Commons CC0 Dedication (CC0). Re-users are encouraged to provide attribution by linking back to Toolhub, but this is not required for license compliance. It is the responsibility of maintainers of externally hosted toolinfo.json data files to ensure that their contributors are aware of the CC0 licensing requirement. Toolinfo data copied from Wikimedia content wikis or other documentation under a non-CC0 license should restrict the copied description content to 50 words/250 characters to limit claims of potential copyright license obligations, like attribution. The word/character limit only applies to copied content, and original CC0 descriptions may be any length.

User accounts

Toolhub uses OAuth authentication to allow users to login to Toolhub using their Wikimedia wiki user account. No new accounts or passwords are needed.

Adding tools to the catalog

Tools can be added to the Toolhub catalog by either being read from a registered toolinfo.json file URL or by directly sending data to the Toolhub API.

Hosting your toolinfo.json files as part of a Git repository makes it possible for volunteers to submit pull requests to help keep the core tool information updated.

Publish a toolinfo file and register it with Toolhub's web crawler

A toolinfo file is a JSON document conforming to the toolinfo schema. This standard is an extension of the toolinfo specification originally developed by Husky as part of his Hay's Directory tool.

Create a JSON file conforming to the schema
Publish that file on a website
Use the Toolhub UI to register the URL of the file with Toolhub's web crawler

Toolhub will check each registered toolinfo URL approximately every 60 minutes and update the catalog with changes.

Example toolinfo.json files from real tools:

Use the Toolhub user interface to create and edit a toolinfo record

The Add or remove tools > Create a new tool screen in Toolhub can be used to create a new toolinfo record directly in Toolhub's catalog. Additional information not collected in the toolinfo creation form can be added via subsequent edits using the edit tool screen for the tool.

Use the Toolhub API to create and edit a toolinfo record

The POST /api/tools/ endpoint of Toolhub's API can be used to create a new toolinfo record directly in Toolhub's catalog. This API is used behind the scenes by the Toolhub user interface. See Toolhub's API documentation for detailed information about the expected inputs and outputs of this API endpoint.

Editing tool info

Some of the information contained in the toolinfo record is editable by anyone, but some of it can only be edited by owners or admins. Toolhub's data model splits tool information into two parts: the core tool info and its annotations:

Type of metadata	How it is created	Who can change it	Where to make changes
Core tool info Basic and essential information about the tool.	Created by using API or Toolhub (the UI uses the API on the backend) Examples OR By submitting a toolinfo.json URL to be crawled Examples	The owner, Administrators and Oversighters OR Users who can change (or submit pull requests for) the externally-stored toolinfo.json file	In the same place the record was created. If the tool record was originally submitted through Toolhub, it can only be edited through Toolhub. If tool record data is stored externally in toolinfo.json files, it can only be edited there.
Community annotations Additional information about the tool.	Toolhub UI, API, or through tools like Toolhunt that use the API	Any authenticated user with a Wikimedia account	Toolhub UI, API, or through tools like Toolhunt that use the API

Core tool info

All tools in Toolhub have a core tool record containing basic information, such as the tool name and author. Only the owner, Administrators and Oversighters can edit the core tool info in Toolhub. The owner of a tool's core information is the user who created it within Toolhub (regardless of which method they used to create it).

For externally-stored toolinfo records, anyone with permissions to edit the crawled toolinfo file can edit the core tool info.

See Toolhub/Data model#Toolhub field reference for a full list of fields and more information about them.

Editing tool URLs

The URL for a tool is part of the core toolinfo data. This means that it can be submitted as part of a toolinfo.json file or edited through the UI & API by the owner of the toolinfo record. It cannot currently be edited by the community at large. You will only be able to edit the tool's URL if you are given the choice of selecting "Edit core toolinfo" after clicking the "edit" button. Otherwise you are seeing the form for editing the "annotations" layer of a toolinfo record -- you will not be able to edit the tool's URL.

If you are a tool maintainer and your record has been imported from https://toolsadmin.wikimedia.org, the edit form on toolsadmin displays a checkbox near the bottom of the form labeled "This is a webservice". Check this box to automatically set the toolinfo record's URL. Note that the Toolhub crawler runs once a hour, so changes to toolinfo records made through Toolsadmin take over an hour to show up.

Community annotations

After Toolhub receives a core tool record, volunteers can submit annotations to it. Annotations help make it easier to find tools by supplying additional information. Annotations cannot be stored in toolinfo.json files; they are meant to always be editable by community members.

The annotations fields are:

Icon
Whether a tool is deprecated/experimental/replaced by another tool
Tool type
For Wikis
Audiences
Content types
Tasks
Subject domains
Available UI languages
Links: API, end user docs, feedback, privacy policy, bug tracker, translations, developer docs
Wikidata QID

Details about fields that are part of the annotations layer are in the API documentation at https://toolhub.wikimedia.org/api-docs#put-/api/tools/-name-/annotations/.

See Toolhub/Data_model#Toolhub_field_reference for a full list of fields and more information about them.

Some annotations mirror fields from the core toolinfo.json specification. Toolhub only displays an annotations field for community editing if the corresponding field in the core record is empty or missing. When both the core and annotation data for a given field are populated, Toolhub displays the core data rather than the annotation data. This was chosen as a compromise between the conflicting desires for tool maintainers to have ultimate control of their data records, and for the community to be able to improve the documentation for tools.

Searching for tools

The search screen uses the Elasticsearch simple query string syntax:

signifies AND operation
| signifies OR operation
- negates a single token
" wraps a number of tokens to signify a phrase for searching
* at the end of a term signifies a prefix query
( and ) signify precedence
~N after a word signifies edit distance (fuzziness)
~N after a phrase signifies slop amount
Special characters ( , |, -, ", *, (, ), a ~) must be escaped with \ or in a quoted phrase to be searched for
Searches are case-insensitive

The autocomplete feature is designed to help you with relevant suggestions as you type a query.

Create and share lists of tools

The Your lists screen can be found from the link in the user menu available to logged-in users. Click on the user icon in the top navigation bar next to the language selector to open the user menu. Here you can create and edit lists of tools and, when you are ready, mark them as public to share with others.

Tools can also be added to (or removed from) an existing or newly created list directly from the menu button on the tool card, as well as from the menu button on the tool info page.

Veřejné a doporučené seznamy

Veřejné seznamy lze prohlížet a vyhledávat v nich tak, že v navigační zásuvce vlevo přejdete do sekce Zveřejněné seznamy. Správci mohou veřejné seznamy označit jako doporučené, což umožní jejich zobrazení na vstupní stránce Toolhubu.

Lists can be shared by copying the URL of the list from your browser's URL bar or clicking the Copy link and share with others link on the list's detail screen.

Save your favorite tools to a special list

Tools can be marked as "favorites" by logged-in users, which means they are saved to a special list only visible to the current user. This list of favorites can be accessed from the user menu in the top-right corner. To mark a tool as a favorite, click on a tool card to reach the tool info page, then click the favorite button.

User permission levels

Anonymous users

All read-only actions can be used without authenticating to Toolhub.

Users

Authenticated users can perform all read-only actions in the same way that anonymous users can. Additionally they can create new toolinfo records, edit toolinfo records that they have previously created, add annotations to tool records created by others, create new lists, and edit lists that they have previously created.

Bureaucrats

Bureaucrats can change permissions for other users, including themselves. This includes both granting and removing permissions.

Patrollers

Patrollers are able to review edits to any toolinfo records and either mark them as patrolled or leave them unpatrolled. There is currently no way for a patroller to reject an edit.

Oversighters

Oversighters are able to hide (oversight/suppress) any edit. Edits which have been previously hidden can be revealed. Oversighters are also able to edit toolinfo records and lists created by other users so that they can revert a change or make a new edit in order to remove problem content.

Administrators

Administrators have all of the abilities of bureaucrats, patrollers, and oversighters.

Patrolling changes

Patrollers and administrators can patrol changes. Patrolling rights are granted by bureaucrats or administrators.

When a change is made to a toolinfo or a tool list record, it can be patrolled from one of three places:

From the page history: click on the option "Mark as patrolled" on the logged entry
From a link to the change itself: click the "Mark as patrolled" link in the change summary information at the top of the page.
From Recent changes, accessible from the navigation drawer on the left. Here, you can search and filter recent changes by multiple criteria such as record type (tool or list), username and patrolling status.

Changes can only be accepted (patrolled) or left alone. They cannot be rejected or declined.

Changing user permissions

Administrators and bureaucrats can change permissions for themselves and other users. Permissions can be added or removed. Each individual addition or removal of permission will show in the audit logs. This means that if two permissions are changed there will be two audit log entries, one for each permission.

To add a permission

Go to the "Members" screen.
Select the user to modify. Use the search filters to find the user.
Click on the pencil icon after the user's name. A dialog will be displayed showing the current permissions of the user.
Choose the group to add from the dropdown list.
Click the "Add" button.
A notice will appear on the screen noting that the change has been successful.

To remove a permission

Go to the "Members" screen.
Select the user to modify. Use the search filters to find the user.
Click on the pencil icon after the user's name. A dialog will be displayed showing the current permissions of the user.
Identify the permission to be removed. Click on the red trash can button to remove the permission.
A notice will appear on the screen noting that the change has been successful.

Oversighting

Oversighting allows hiding an individual edit to a toolinfo record. This might be used for example when a user has mistakenly published their private information. Administrators and oversighters have the permissions needed to hide or reveal an edit.

Revisions that have been oversighted will have the date/time of the revision, the user's name, and the edit summary hidden in the toolinfo record's history view. All oversight actions are recorded in the audit log, including the name of the oversighter.

To hide a revision

Identify the content to be hidden.
Review the history to identify when that content was first added.
Ensure that the content to be hidden is no longer visible in the toolinfo record
- If it is still visible, the toolinfo record owner, an administrator, or an oversighter can edit the toolinfo record to remove the problem content.
From the toolinfo record history, identify all changes that need to be oversighted.
Click the "hide" link to hide a revision.
Repeat as required to oversight all relevant edits.

To show a hidden revision

From the toolinfo record history, identify all changes that need to be revealed.
Click the "reveal" link to show a revision.
Repeat as required to reveal all relevant edits.

Translation

Language translations on Toolhub just like other projects and tools at Wikimedia Foundation is handled by the translatewiki.net community.

Toolhub provides language selection based on list of known languages and not on translation completion, and is configured to provide translations based on a list of fallback languages in varying order of relevance, defaulting to English when there is no translation found for the string in either the selected language or other configured fallback languages. For this reason, you will frequently encounter situations where part of the translations in a page are in the selected language, while others parts are in other languages or English. You can help us fix this by volunteering to translate toolhub on translatewiki.net.