Toolhub

This page is a translated version of the page Toolhub and the translation is 31% complete.
Outdated translations are marked like this.
Other languages:

Toolhub community logo.svg

O Toolhub é um catálogo gerenciado pela comunidade de ferramentas digitais utilizadas pelo movimento Wikimedia. Voluntários técnicos podem usar a Toolhub para documentar suas ferramentas criadas ou mantidas. Qualquer wikimedista pode usar a Toolhub para pesquisar ferramentas que ajudem seus trabalhos nas wikis ou para criar listas de ferramentas úteis e compartilhá-las com seus amigos.

O que é uma “ferramenta”?

No Toolhub, “ferramenta” é o termo usado para aplicativos/softwares que interagem com os projetos da Wikimedia mas que não estão implementados por padrão no MediaWiki. Isso inclui scripts, gadgets, robôs, predefinições, módulos Lua, aplicativos web e aplicativos móveis. O catálogo pretende ser inclusivo e não exclusivo, desde que as coisas nele documentadas sejam úteis para melhorar o trabalho e as experiências dos usuários ao interagirem com os projetos do movimento Wikimedia.

Licença do conteúdo

Dados do toolinfo.json e outros dados estruturados coletados no Toolhub estão licenciados sob a Creative Commons CC0 Dedicação ao Domínio Público (CC0). Pedimos que reutilizações forneçam atribuição com uma referência para a Toolhub, embora isso não seja obrigatório segundo a licença. É responsabilidade dos mantenedores de arquivos toolinfo.json hospedados externamente que indiquem aos seus contribuidores acerca da obrigatoriedade da licença CC0. Dados do toolinfo.json copiados de wikis de conteúdo da Wikimedia ou outras documentações sob licenças que não a CC0 deverão restringir o conteúdo da descrição para até 50 palavras ou 250 caracteres, de forma a limitar as reivindicações de potenciais obrigações de licença de direitos autorais, como a atribuição. Esse limite de palavras e caracteres apenas se aplica a conteúdo copiado. Descrições com o CC0 original podem ter qualquer comprimento.

Contas de usuários

A Toolhub utiliza a autenticação OAuth para permitir que usuários se autentiquem no Toolhub utilizando suas contas da Wikimedia. Não são necessárias contas ou senhas novas.

Qualquer ferramenta pode ser adicionada ao catálogo ao ser lida pelo URL de um arquivo toolinfo.json registrado ou se os dados forem diretamente enviados à API do catálogo.

Publicando um arquivo toolinfo e registrando-o no rastreador

Um arquivo toolinfo consiste num documento em JSON utilizando o esquema toolinfo. Essa padronização é uma extensão da especificação toolinfo desenvolvida originalmente por Husky como parte de sua ferramenta chamada Hay's Directory.

  1. Crie um arquivo JSON que esteja conforme com o esquema
  2. Publique o arquivo em um endereço na web
  3. Registre o URL do arquivo no rastreador do Toolhub

O Toolhub confere os URLs registrados a cada 60 minutos aproximadamente, e atualizará o catálogo com a mudança.

Usando a interface de usuário para criar ou editar registros

A tela Adicionar ou remover ferramentas > Criar nova ferramenta no Toolhub pode ser utilizada para criar um novo registro toolinfo diretamente no catálogo. Se houverem informações adicionais que não foram coletadas durante o formulário de criação, elas podem ser adicionadas em edições subsequentes utilizando-se da tela Editar ferramenta.

Usando a API para criar ou editar registros

O endpointPOST /api/tools/” da API do Toolhub pode ser utilizado para criar um novo registro toolinfo diretamente no catálogo. Essa API é a mesma utilizada “por trás das cenas” pela interface de usuário. Veja a documentação da API do Toolhub para mais informações sobre inputs e outputs esperados pelo endpoint.

Editing tool info

Some of the information contained in the toolinfo record is editable by anyone by clicking the edit tool button on the tool info page. The fields that are currently editable are:

  • Icon
  • Tool type
  • Available UI languages
  • For Wikis
  • Wikidata QID
  • Links: API, translations, bug tracker, docs, etc.
  • Whether a tool is deprecated/experimental/replaced by another tool

It is likely that more fields will be added in the future. Filling out missing tool info is a great way to help keep the Wikimedia tool ecosystem healthy and thriving by ensuring the information is up-to-date and complete.

Pesquisando ferramentas

A tela de pesquisa utiliza a sintaxe do Elasticsearch:

  • + para o operador AND
  • | para o operador OR
  • - para negar um atributo
  • " abrange atributos para que se tornem uma frase
  • * no fim de um termo para um prefixo de busca
  • ( e ) para precedência
  • ~N após uma palavra significa distância (fuzziness)
  • ~N após uma frase significa inclinação (slop amount)
  • Caracteres especiais (+, |, -, ", *, (, ) e ~) devem ser escapados com \ ou estar envolvidos com aspas para serem pesquisados.
  • As pesquisas não diferem maiúsculas de minúsculas.

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.

Public and featured lists

Public lists can be viewed and searched by navigating to the Published lists section from the navigation drawer on the left. Administrators can mark public lists as featured, which will allow them to be shown on the Toolhub landing page.

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, 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.