Esta é uma lista de chaves de metadados de scripts de utilizador que Greasy Fork irá ler. Chaves fora desta lista podem ser incluídas nos scripts e estarão presentes no script instalado, mas não terão qualquer efeito na interface de Greasy Fork.
- §
@name - O nome do script, utilizado como cabeçalho e nos links. Obrigatório.
- §
@name:XX-YY - O nome do script num idioma específico, em que XX é um código ISO 639-1 de 2 letras e YY é um código de país ISO 3166 opcional. Substitui
@namequando o utilizador está a navegar num idioma correspondente. - §
@description - A descrição do script. Obrigatória.
- §
@description:XX-YY - A descrição do script num idioma específico, em que XX é um código ISO 639-1 de 2 letras e YY é um código de país ISO 3166 opcional. Substitui
@descriptionquando o utilizador está a navegar num idioma correspondente. - §
@namespace - Uma combinação de
@namespacee@nameé utilizada pelos gestores de scripts de utilizador para verificar se um script já está instalado. Greasy Fork exige este campo e avisará se ele for alterado numa atualização. - §
@version - Identificador de uma versão específica de um script no formato de versão Mozilla. A versão é mostrada na página de informação de um script. Greasy Fork exige este campo e avisará se o número da versão diminuir ou se o campo não estiver presente.
- §
@include,@exclude,@match - Descreve em que páginas o script será executado. Esta lista será processada, mostrada na página de informação do script e utilizada para categorizar scripts. Todos os scripts têm de ter pelo menos um
@matchou@include. Leia aqui sobre o formato. - §
@require - Inclui JavaScript externo num script. Veja as regras relativas a código que inclui scripts externos. Se utilizar hashes de integridade de subrecurso (veja a informação aqui e aqui), Greasy Fork avisá-lo-á se os seus hashes não corresponderem ao conteúdo do URL que utiliza.
- §
@resource - Inclui um recurso externo (JavaScript, CSS, imagens, etc.) num script. Veja as regras relativas a código que inclui scripts externos. Se utilizar hashes de integridade de subrecurso (veja a informação aqui e aqui), Greasy Fork avisá-lo-á se os seus hashes não corresponderem ao conteúdo do URL que utiliza.
- §
@updateURL,@installURL,@downloadURL - Descreve como os gestores de scripts de utilizador devem obter atualizações. Greasy Fork removerá estas chaves, o que faz com que qualquer script instalado a partir de Greasy Fork só atualize a partir de Greasy Fork.
- §
@license - Ao publicar o seu script em Greasy Fork, dá permissão a outras pessoas para o instalar e utilizar. A licença descreve se e como as pessoas podem modificar e distribuir o seu script. A licença é mostrada na página de informação do script.
@licensepode ser:- O nome de uma licença (por exemplo,
@license GPL3). Recomenda-se a utilização de um "Nome completo" ou "Identificador" da Lista de Licenças SPDX. - As condições em que permite a utilização (por exemplo,
@license Pode modificar desde que me atribua crédito), embora se recomende a utilização de uma licença já existente. - Uma declaração de direitos de autor (por exemplo,
@license Copyright MeuNome) se não quiser disponibilizar o script ao abrigo de uma licença. - Ser totalmente omitida, o que equivale a ter uma declaração de direitos de autor, mas é menos claro para os utilizadores.
- O nome de uma licença (por exemplo,
- §
@supportURL - URL de uma página onde os utilizadores podem obter apoio sobre um script (por exemplo, um rastreador de erros, um fórum ou um endereço de e-mail). O URL de apoio é mostrado na página de feedback do script.
- §
@contributionURL - URL de uma página onde os utilizadores podem fazer um donativo ao autor de um script. O URL de contribuição é mostrado na página de feedback de um script. Os URLs podem utilizar os protocolos http, https ou Bitcoin. Para criar um link para uma página de donativos do PayPal, utilize um URL no formato https://www.paypal.com/cgi-bin/[email protected]&item_name=Greasy+Fork+donation, substituindo o endereço de e-mail de exemplo pelo seu.
- §
@contributionAmount - Valor sugerido para donativo, utilizado em conjunto com
@contributionURL. - §
@compatible - Marca este script como compatível com um navegador. A informação de compatibilidade será mostrada na página do script. Comentários sobre compatibilidade podem ser incluídos no formato
@compatible firefox Must disable pop-up blocker. Os navegadores reconhecidos são:firefox,chrome,opera,safari,edge,brave. - §
@incompatible - Marca este script como incompatível com um navegador. A informação de compatibilidade será mostrada na página do script. Comentários opcionais sobre compatibilidade podem ser incluídos no formato
@incompatible firefox Broken since Firefox 23. Os navegadores reconhecidos são:firefox,chrome,opera,safari,edge,brave. - §
@antifeature - Divulga funcionalidades num script que existem em benefício do autor e não do utilizador. O formato desta chave é
@antifeature type description. type é obrigatório e description é opcional. Leia aqui mais informação sobre os tipos type reconhecidos por Greasy Fork. - §
@antifeature:XX-YY - Uma
@antifeaturedescrita num idioma específico, em que XX é um código ISO 639-1 de 2 letras e YY é um código de país ISO 3166 opcional. Substitui as diretivas@antifeaturedo mesmo tipo quando o utilizador está a navegar num idioma correspondente.