Difference between revisions of "Template:Extension/doc"
no edit summary
>Lil devil m (Fixed typos.) |
|||
Line 1: | Line 1: | ||
<noinclude> | <noinclude> ((Documentação subpágina)) | ||
((Timw | Prorrogação)) | |||
</ | </ Noinclude> | ||
<!----> | <!----> | ||
== | == Propósito == | ||
Este modelo deve ser adicionado à página principal de todas as extensões documentadas neste wiki (e apenas a página principal). Ele irá adicionar uma infobox útil com base nas informações fornecidas (veja abaixo) e adiciona automaticamente a extensão para [[: Categoria: Todas as extensões]], além da adequada [[: Categoria: Extensões por estado | Estado]] e [[: Categoria: Extensões por tipo de aplicação | tipo de implementação]] categorias. | |||
== | == Uso == | ||
(| Width = "100%" | |||
|- | | - | ||
! width=40% | | ! width = 40% | | ||
! width=60% | | ! width = 60% | | ||
|- | | - Valign = "top" | ||
| | | Align = "left" | | ||
<span id="CutAndPaste"> | <span id="CutAndPaste"> Recortar e colar: </ span> | ||
<pre> | <pre> ((Extensão | templatemode = | ||
| | | Nome = | ||
| | | Status = | ||
| | | Type1 = | ||
| | | Tipo2 = | ||
| | | Hook1 = | ||
| | | Hook2 = | ||
| | | Username = | ||
| | | Autor = | ||
| | | Description = | ||
| | | Imagem = | ||
| | | Imagesize = | ||
| | | Versão = | ||
| | | Atualização = | ||
| | | Mediawiki = | ||
| | | Php = | ||
| | | Licença = | ||
| | | Baixar = | ||
| | | Readme = | ||
| | | Changelog = | ||
| | parâmetros = | | ||
tags = | | |||
| | direitos = | | ||
| | | = Exemplo | ||
| | | Compatibilidade = | ||
)) </ Pre> | |||
Para ajudar com os valores dos parâmetros, veja [[# parâmetros Conteúdo | abaixo.]] | |||
| | | Align = "right" | ((Extensão | templatemode = nocats | ||
| | | Name = (((nome))) | ||
| | | Status = (((estado))) | ||
| | | Type1 = (((type1))) | ||
| | | Tipo2 = (((type2))) | ||
| | | Hook1 = hook1 | ||
| | | Hook2 = hook2 | ||
| | | Username = SomeUser | ||
| | | Autor = SomeAuthor | ||
| | | Imagem = Placeholder.png | ||
| | | Versão = (((version))) | ||
| | | Atualização = (((update))) | ||
| | | Mediawiki = (((MediaWiki))) | ||
| | | Php = (((php))) | ||
| | | Licença = (((licença))) | ||
| | | Baixar = (((download))) | ||
| | | Readme = (((readme))) | ||
| | | Changelog = (((changelog))) | ||
| | | Description = (((description))) | ||
| | parâmetros = (((parâmetros))) | | ||
tags = (((tags))) | | |||
| | direitos = ((())) direitos | | ||
| | | Exemplo = (((exemplo))) | ||
| | | Compatibilidade = (((compatibilidade))) | ||
)) | |||
| | |) | ||
style="clear:both"/> <br | |||
== | == Conteúdo == parâmetros | ||
Esta seção descreve os parâmetros que controlam o conteúdo infobox. Para ajudar com'''templatemode''' e outros parâmetros de controlo, consulte os parâmetros''[[# Controle | Os parâmetros de controle ]]''. | |||
<! | <- Antes de editar PRESENTE!: | ||
ids extensão em cada parâmetro são usados pelo código no modelo: Extensão. | |||
Eles permitem que cada etiqueta na caixa de informações para link de sua documentação. | |||
Se você mudar um id, por favor, atualize o código no modelo: Extensão em conformidade | |||
-> | |||
(| | |||
| | | | ||
(| Border = "1" | |||
|+ ''' | | +'''Parâmetros de conteúdo''' | ||
|- | | - | ||
|<span | |''<span Id="name"> 'nome'''</ span> | |''' nome da extensão''' | ||
|- | | - | ||
'Status'''</ span> |''|''' id="status"> <span | status versão atual''' | |||
Um dos seguintes: | |||
* ''[[: | *''[[: Categoria: extensões Instável | instáveis]]''(quebrado - não use esta extensão) | ||
* ''[[: | *''[[: Categoria: extensões Experimental |] experimental]''(. Estágios iniciais de desenvolvimento, pode mudar drasticamente) | ||
* ''[[: | *''[[: Categoria: extensões status Beta | beta]]''(estável, mas não totalmente testado) | ||
* ''[[: | *''[[: Categoria: extensões Estável | estáveis]]''(versão estável) | ||
* ''[[: | *''[[: Categoria: Extensões com status desconhecido |] desconhecido]''(padrão) | ||
Se o status for diferente do acima exposto, ele será ignorado eo valor padrão de 'desconhecido' será exibido em vez do modelo. Nos casos em que o valor for omitido, será classificado como [[: categoria: extensões com estatuto desconhecido |] desconhecido]. Nos casos em que o valor é inválido, ele será colocado em um [[: categoria: extensões com status inválido |] categoria especial] para que o erro pode ser detectado e corrigido. | |||
|- | | - | ||
'''Type1'''''<br/> type2 <br/>''''''type3 <br/> type4''''''<br/> type5 <br/>''''| type6 <br/>''| |''<span id="type"> "implementação'''</ span ><!-- tipo ID aqui, no topo da documentação -> | |||
A estratégia de implementação (s) empregado na construção deste ramal. Este parâmetro é usado para criar categorias que ajudam os programadores a encontrar exemplos de vários MediaWiki estratégias de implementação ou padrões específicos. Embora os valores deste parâmetro, por vezes, coincide com o caso de uso ou finalidade de uma extensão, que não é razão para este parâmetro. Se os valores que você escolheu para este parâmetro não identificar adequadamente o [[w: Requisitos |] propósito] ou [[w: caso de uso | caso de uso]] é possível, recomendamos que você adicionar outros [[Help: Categorias | Categorias links]] se necessário. | |||
Valores válidos para a'''type1''',''' type2''',... parâmetros são: | |||
* '''''[[: | *'''''[[: Categoria: extensões Parser | ]]''''' analisador - ilude uncategorized [[Manual: Estendendo marcação wiki | extensões analisador.]] Se você tiver escrito um analisador de extensão, use um dos seguintes tipos mais específicos: | ||
** ''[[: | **''[[: Categoria: extensões de marcação Link | link]]''- personalizado [[Manual: Estendendo marcação wiki | marcação link]], por exemplo, <code> <nowiki> [[</ nowiki código >...]]</> | ||
** ''[[: | **''[[: Categoria: extensões função Parser | analisador função]]''- personalizado [[Manual: funções Parser | parametrizados modelo de marcação]], por exemplo, <code> <nowiki> ((</ nowiki>''# nome:''... )) </ Code> | ||
** ''[[: | **''[[: Categoria: extensões Tag | tag]]''- [[Manual: extensões Tag | Personalizar tag marcação XML]], por exemplo, <code> <nowiki> <</ nowiki>''tagname''>...< nowiki ></</ nowiki>''tagname> Código''></ | ||
** ''[[: | **''[[: Categoria: extensões variável | variáveis]]''- personalizado [[Manual: Variáveis | unparameterized modelo de marcação]], por exemplo, <code> <nowiki> ((NOME)) </ nowiki> </ code> | ||
** ''[[: | **''[[: Categoria: extensões prolongado sintaxe | prorrogado sintaxe]]''- Extensões que adicionam não-padrão sintaxe wiki (ie <em> não </ em> [[Manual: extensões Tag | tags]], [ [Manual: funções Parser | Funções analisador]] ou [[Manual: Variáveis | variáveis]]). | ||
*: | *: | ||
* [[: | * [[: Categoria: extensões para o acesso do usuário |'''''''''']] acesso - ilude [[Manual: extensões para o acesso do usuário | extensões para o acesso do usuário]], ou seja, extensões que criam, autenticar, conceder permissões, revogar as permissões, ou monitorar a atividade dos usuários. Se você tiver escrito um ramal de acesso, por favor, use um dos seguintes tipos mais específicos: | ||
** [[: | ** [[: Categoria: extensões atividade do usuário |''atividade do usuário'']] - extensões que monitoram a atividade do usuário (logins, logouts, criação de novo usuário, etc) | ||
** [[: | ** [[: Categoria: extensões de identidade do usuário |''identidade do usuário'']] - extensões que criar e apagar usuários e / ou verificar a identidade de um usuário | ||
** [[: | ** [[: Categoria: extensões de direitos de utilização | direitos de usuário'''']] - extensões para o sistema de gestão de direitos, por exemplo, alterações na forma como são atribuídos direitos, APIs, ferramentas de manutenção (não inclui apenas as extensões que definem os direitos necessários para utilizar os recursos de que a prorrogação Para isso use o [[# direitos |. parâmetro direitos ]].). | ||
*: | *: | ||
* [[: | * [[: Categoria: extensões da interface do usuário |'''''''''']] interface - catchall para extensões uncategorized interface do usuário. | ||
** ''[[: | **''[[: Categoria: extensões manipulação Mídia | mídia]]''- extensões que permitem a incorporação de conteúdos multimédia em páginas wiki, registrando uma extensão de arquivo com [[Manual: $ wgMediaHandlers | $ wgMediaHandlers.]] | ||
** ''[[: | **''[[: Categoria: extensões Personalização | mywiki]]''- extensões que fornecem infra-estrutura para que os usuários podem personalizar a sua experiência MediaWiki e / ou auxiliar na gestão dessa infra-estrutura | ||
** [[: | ** [[: Categoria: extensões Notificação |''notificação'']] - extensões que os usuários de e-mail, mensagens de difusão e proporcionar outras formas de comunicação da comunidade | ||
** ''[[: | **''[[: Categoria: extensões ação Página |''ação página'']]'' - extensões que melhorar ou modificar [[Manual: ação página | ação]] s. Isto inclui qualquer coisa que implementa uma ação que lê, escreve, busca, cria, renomeia, apaga, redireciona ou discute uma página. Ele não inclui direitos (direitos de utilização do usuário'''') ou registros (uso''''a atividade do usuário). | ||
** [[: | ** [[: Extensões Pesquisa |''pesquisa'']: Categoria] - extensões que pesquisar e selecionar artigos para os usuários. | ||
** [[: | ** [[: Extensões de pele |''pele'']: Categoria] - adicionando extensões [[w: CSS | CSS]] ou [[w: JavaScript | JavaScript]], ou implementar funções de gancho para alterar o look and feel do MediaWiki através da estrutura das peles. | ||
** [[: | ** [[: Extensões Ajax | ajax'''']: Categoria] - extensões que uso [[w: Ajax | Ajax]] técnicas de programação. | ||
** [[: | ** [[: Extensões página especial |''especial'']: Categoria] - extensões que subclasse de [[Manual: SpecialPage classe | classe SpecialPage]], use um dos seus ganchos, ou funções de um patch ou mais em [http : / /] SpecialPage.php svn.wikimedia.org/doc/SpecialPage_8php-source.html. Veja [[Manual: Páginas especiais]] para mais informações. | ||
'''Outros' *'' | |||
** [[: | ** [[: Categoria: extensões API | API'''']] - extensões que adicionar um módulo de nova API ou estender um módulo API núcleo. | ||
** [[: | ** [[: Categoria: extensões Hook |''gancho'']] - extensão Hook - define uma nova <em> </ em> gancho - ver hook1, etc abaixo se você deseja definir ganchos <<em> utilizados / em> pela sua extensão | ||
* ''[[: | *''[[: Categoria: extensões função Parser | pfunc]]''- o mesmo que''''a função do analisador | ||
<div style="border: | <div style="border: blue"> sólida fina Estamos no processo de revisão dos valores desta página. Tipos abaixo deste ponto são susceptíveis de ser preterido ou redefinição. Pedimos desculpas pelo inconveniente. Veja [[Discussão: Prorrogação # Tipo taxonomia]] para mais informações </ div>. | ||
* ''[[: | *''[[: Categoria: extensões Banco de dados | banco de dados]]''- adiciona tabelas e / ou campos para o banco de dados de apoio a instalação MediaWiki | ||
* ''[[: | *''[[: Categoria: Extensões de Banco de Dados | db]]''- mesmo que o banco de dados'''' | ||
* ''[[: | *''[[: Categoria: extensões de extração de dados | extração de dados]]''- Extração de dados | ||
* ''[[: | *''[[: Categoria: exemplos de Extensão | exemplo]]''- Não é uma extensão do real, mas um exemplo de como escrever um | ||
Qualquer outro valor para 'tipo' é inválido, e fará com que a extensão a ser colocado em [[: Categoria: Extensões com tipo inválido ou ausente.]] | |||
Nota: Muitas extensões têm mais de um tipo, se isso se aplica ao seu, substituir <code> <nowiki> | tipo = </ nowiki> </ code> com <code> <nowiki> | type1 = | tipo2 = | = type3 ...</ nowiki> </ code>. Você pode definir até seis tipos de prorrogação. | |||
|- | | - | ||
''span id="hook"> <span 'hook1'''</> <br/> hook2''''''<br/> hook3 <br/>''''''hook4 <br / | >...< br />''''hook30 | |||
| | | Valign = "top" | "nome de cada um gancho usado pela extensão''''' | ||
Introduzir os valores neste campo é uma boa maneira de começar a exposição para a sua extensão e ajudar outros desenvolvedores. Cada gancho documentado irá adicionar automaticamente a extensão de uma categoria anúncio extensões que usam esse gancho. Esta categoria é Vinculado automaticamente em cada artigo gancho de modo que os programadores podem facilmente encontrar exemplos de extensões que uso um gancho particular. | |||
Para built-in anzóis: | |||
* | * Usar o nome de gancho sozinho. Por favor, veja [[Manual: Ganchos]] para os valores (mas omitir introdutória'/'). | ||
Por costume ganchos definido por extensões: | |||
* | * Usar''''extensionName''/'' hookName. Para uma lista parcial de costume ganchos, ver [[gancho Extensão Registro.]] | ||
Para vários ganchos, atribuir o primeiro gancho para'''hook1''', o segundo'''hook2''' e assim por diante. | |||
|- | | - | ||
| <span | |''<span Id="username"> 'username'''</ span> | | nome do autor em MediaWiki.org (se tiver). Pode ser omitido, mas se presente que será usado para ligar para o usuário do autor e página Usuário Discussão. | ||
|- | | - | ||
| <span id="author"> | | <span Autor id="author"> </ span> | | O nome do autor de extensão, se for diferente do seu nome de usuário MediaWiki.org. Texto livre. Se omitido, então o campo 'username' será usado (se houver). | ||
|- | | - | ||
| | breve descrição |'''descrição'''</ span> |''''|''<span id="description"> | ||
|- | | - | ||
| <span | | <span Id="image"> imagem </ span> | | imagem ou o logotipo da extensão | ||
|- | | - | ||
| <span | | <span Id="imagesize"> imagesize </ span> | |''''facultativa, o tamanho da imagem (tamanho padrão é de 220px) | ||
|- | | - | ||
| <span id="version"> | | <span Versão id="version"> </ span> | | última versão | ||
|- | | - | ||
| <span | | <span Id="update"> atualização </ span> | | data da última atualização | ||
|- | | - | ||
| <span | | <span Id="mediawiki"> mediawiki </ span> | versão necessária do MediaWiki | | ||
|- | | - | ||
| <span | | <span Id="php"> php </ span> | | necessária versão do PHP | ||
|- | | - | ||
| <span | | <span Id="license"> licença </ span> | | licença (s) que regem o uso desta extensão, por exemplo, GPL | ||
|- | | - | ||
| <span | |''<span Id="download"> 'download'''</ span> | |''' link para o download''': [http://svn.wikimedia.org/svnroot/mediawiki/trunk/ extensões / SVN] ou outro. Se você colocar o código na página no wiki MediaWiki, link para ele usando um nome de página inteira e nome da seção, por exemplo, <code> <nowiki> [[Extensão: Example/version_1.22a # Code]] </ nowiki> </ code> (que deve ser válida quando bot-copiado em outros lugares) | ||
|- | | - | ||
| <span | | <span Id="readme"> readme </ span> | | link para o arquivo readme: [http://svn.wikimedia.org/svnroot/mediawiki/trunk/extensions/Sort/Sort README] ou outros | ||
|- | | - | ||
| <span | | <span Id="changelog"> changelog </ span> | | link para o arquivo changelog: [http://svn.wikimedia.org/svnroot/mediawiki/trunk/extensions/Sort/Sort Changelog] ou outros | ||
|- | | - | ||
| <span | | <span Id="parameters"> parâmetros </ span> | | parâmetros disponíveis para LocalSettings.php | ||
|- | | - | ||
| <span id="tags"> | | <span Tags id="tags"> </ span> | | todas as tags usa a sua extensão (por exemplo, <tag1>, <tag2>). | ||
|- | | - | ||
| | direitos | | | <span id="rights"> direitos </ span> acrescentados. '''Não deve ser confundida com a licença!''' Os direitos são tais como''[[Extensão: MakeBot | makebot]]''ou''[[Extensão: Desysop | desysop não ]]'', como a GFDL ou LGPL ou GPL - estes são certificados! | ||
|- | | - | ||
| <span | | <span Id="example"> exemplo </ span> | | website exemplo, ou a imagem do trabalho de extensão | ||
|- | | - | ||
| <span | | <span Id="compatibility"> compatibilidade </ span> | | Tabela de compatibilidade, por exemplo, [Modelo [: Extensão Testes]] | ||
|- | | - | ||
| <span | | <span Id="CheckUsageNameOverride"> CheckUsageNameOverride </ span> | | substituir o nome da página usado para o link o uso dos cheques. | ||
| | |) | ||
== | Os parâmetros de controle == == | ||
(| Border = "1" | |||
|+ ''' | | +'''Parâmetros de controle''' | ||
|- | | - | ||
'''Templatemode''' | | |'''Controles de auto-categorização da página de acolhimento.''' | |||
Normalmente deixado em branco. valores alternativos são: | |||
* '' | *''''Nocats - categorização suprime. Use esse valor se você está adicionando este modelo para [[Help: Subpágina | subpáginas]] de uma extensão ou como fazer documentação de ramais. Por exemplo, o uso da imagem acima define templatemode <code> nocats = </ code>, porque esta não é uma página de extensão real e não queremos adicionar esta página para qualquer categoria por conta do mesmo. | ||
Se este for deixado em branco, este modelo irá adicionar a página host para [[: Categoria: Todas as extensões]] e para uma ou mais categorias adicionais, dependendo dos valores atribuídos à [[# parâmetros Conteúdo | Conteúdo parâmetros.]] | |||
| | |) | ||
== | == Usando o infobox == | ||
=== | === === Existentes páginas de extensão | ||
Se você quiser adicionar a infobox para uma página existente, copiar e colar o código no [[# CutAndPaste | topo da página]]. | |||
=== | === Criar uma nova extensão === artigo | ||
Se você quiser criar uma página nova extensão, digite o nome abaixo e clique no botão. Uma nova página será criada com o modelo infobox já em vigor. | |||
((Extensão / CreateExtensionInputBox)) | |||
== | == Reforçar este modelo == | ||
Se você gostaria de melhorar este modelo, obrigado! Este é um modelo complicado isso aqui é de alguma ajuda ao longo do caminho: | |||
=== | === === Documentação Fixação | ||
Se você gostaria de corrigir a documentação, por favor, esteja ciente de que a documentação eo código é dividido em dois arquivos: | |||
* '''[[ | *'''[[ Usuário: Extensão / Doc ]]''' - lojas de toda a documentação. | ||
* '''[[ | *'''[[ Usuário: Extensão ]]''' - armazena somente o código do modelo e uma pequena quantidade de material não incluído (links da categoria, link documentação transcluída). | ||
Além disso, [[Predefinição: Extensão / exemplo]] armazena a placa de caldeira, que é pré-carregado em páginas recém-criado e contém alguma documentação básica sobre como preencher os parâmetros do modelo. Ela precisa ser mantido em sincronia com [[Predefinição: Extensão / Doc.]] | |||
=== | === O botão Criar === extensão | ||
Para melhorar o comportamento do botão criar extensão: | |||
* '''[[ | *'''[[ Usuário: Extensão / Amostra ]]:''' A extensão do clichê que é pré-carregado em páginas recém-criado. | ||
* '''[[ | *'''[[ Usuário: Extensão / CreateExtensionInputBox ]]:''' uma caixa de entrada que pode ser inserido onde você deseja que os usuários facilmente criar extensões. Para documentação sobre o <nowiki> <inputbox> <code> </ nowiki> </ code>, por favor consulte [[Extensão: InputBox.]] | ||
* '''[[ | *'''[[ Extensão: MyExtension ]]:''' - Define um espaço reservado, no caso de um usuário acidentalmente bate na tecla criar, sem alterar o nome da extensão. | ||
=== | === === Parâmetros Infobox | ||
Em geral: | |||
* | * Para tornar este modelo fácil de usar, cada etiqueta no infobox está ligada à documentação sobre o parâmetro do modelo (s) que ele exibe. Se você adicionar um parâmetro, por favor não se esqueça de acrescentar também que a [[Predefinição: Extensão / Doc parâmetros Conteúdo # | conteúdo do parâmetro documentação]] e link seu rótulo para essa documentação. | ||
Para alterar / corrigir / adicionar aos parâmetros de tipo de aplicação: | |||
* | * Verifique se o [[Template_talk: Extensão |] página de discussão] - tem havido alguns debates aprofundados sobre esta matéria. | ||
* '''[[ | *'''[[ Usuário: Extensão / TypeSwitch ]]:''' Armazena os valores possíveis para o tipo de campo. Vários valores são implementadas, chamando este modelo com [[Predefinição: Foreach.]] | ||
* '''[[ | *'''[[ Usuário: Extensão / TypeSwitchNoCats ]]:''' usado em vez de [[Predefinição: Extensão / TypeSwitch]] quando este modelo é usado em templatemode <code> nocats = </ code>. Modelos usados com [[Predefinição: Foreach]] só pode ter um parâmetro para isso precisamos envolver a chamada [[Predefinição: / Extensão TypeSwitch]] com um outro modelo que define o modo. | ||
* '''[[ | *'''[[ Usuário: Extensão / Doc ]]:''' Documentação para este modelo deve ser mantido em sincronia com as alterações à taxonomia tipo de implementação. | ||
Para alterar o comportamento dos parâmetros do gancho: | |||
* '''[[ | *'''[[ Usuário: Extensão / HookInUse ]]:''' Adiciona links e categorias para um gancho em uso. Vários ganchos em uso são implementados, chamando este modelo com [[Predefinição: Foreach.]] | ||
* '''[[ | *'''[[ Usuário: Extensão / HookInUseNoCats ]]:''' usado em vez de [[Predefinição: Extensão / HookInUse]] quando este modelo é usado em templatemode <code> nocats = </ code>. Modelos usados com [[Predefinição: Foreach]] só pode ter um parâmetro para isso precisamos envolver a chamada [[Predefinição: / Extensão HookInUse]] com um outro modelo que define o modo. | ||
== | == == Caso de teste | ||
Veja se as seguintes páginas ainda estão ok, depois de editado este modelo. | |||
* [[ | * [[Extensão: Descrição]] | ||
* [[User: | * [[User: ANS / ((FULLPAGENAME }}#{{ FULLPAGENAME))]] | ||
#REDIRECT[[]] |