Jump to content

Projeto: Manual

From mediawiki.org
This page is a translated version of the page Project:Manual and the translation is 48% complete.
Outdated translations are marked like this.
Manual "logo"
Manual "logo"

This page is for the discussion and co-ordination of the MediaWiki Manual.

The manual is located in the Manual: namespace (starting at Manual: Conteúdos ) and is released under the GNU Free Documentation License and the Creative Commons Attribution-ShareAlike 4.0 International (CC BY-SA 4.0) license. Note that manual content must be kept completely separate from the PD Help pages located in the Help: namespace, as they are released under a different, incompatible license (see Projeto: Direitos de Autor for details).

Conteúdo

Para informação geral sobre o que deverá estar em cada espaço nominal, consulte Projeto:Espaços nominais .

  • What content should be in the Manual: namespace?
    • Information on setting up a new wiki
    • Information on moving/upgrading/exporting/importing
    • ** Documentação para Comandos (''scripts'') de manutenção
    • Information about hooks/API/Database layout etc.
  • What should not be in the Manual: namespace?
    • Basic help on using and editing. This belongs in the Help: namespace
    • Extensions and tools, that are not part of the default MediaWiki distribution. (Extension: namespace)

Estrutura

Temas

Skin documentation describes how developers and admins can use and create skins.

A documentação para temas individuais é guardada fora de Manual: espaço nominal no Tema: espaço nominal.

Extensões

Extension documentation describes how developers and admins can use and create extensions.

Documentation for individual extensions is stored outside the Manual: namespace in the Extension: namespace.

Desenvolvimento de extensão

There is a set of pages that provides information for developers about how to create and modify extensions. Some of these pages are specific to extensions, like the extension.json schema, while others also include information that is relevant to MediaWiki core developers, like the hooks documentation.

The landing page for extension development is Manual: Desenvolvimento de Extensões . All pages related to extension development should include the navigation template Template:Extension development at the end of the page, with the exception of individual hook and configuration variable pages.

Pontos de extensão

In the docs, strategies for extending MediaWiki core in extensions, skins, and user scripts/gadgets are referred to as extension points. Documentation about how to use extension points should be stored on a dedicated page in the Manual: namespace, such as Manual: Hooks . To help developers discover these extension points, the extension points available to extensions, skins, and user scripts are linked from their respective development landing pages.

Extension points used by extensions should be listed on:

Extension points used by skins should be listed on:

Extension points used by user scripts/gadgets should be listed on:

Discussão

Some discussion has been held regarding the layout of the Manual: namespace, but no formal decision has been made. The main debate is whether Manual pages should be organized in a flat hierarchy, with all pages at the root level, or with subtopics as subpages of the main topics. Here is where prior discussion has taken place:

Linhas diretrizes editoriais

Formatação

para ser discutido

Cores

para ser discutido

Capturas de ecrã

  • Screenshots should be cut to show only the relevant part of the site (no browser surroundings).

Tabelas

para ser discutido

Esquema de nomeação das páginas que não estão em inglês

Algumas discussões gerais sobre a internacionalização estão em Projeto: Política de Idioma .