Wiki Community/pt-br

From Xen
Revision as of 22:38, 29 November 2011 by Msinhore (talk | contribs)
Jump to navigationJump to search

Antes que você leia este artigo, acesse o wiki registrando-se como usuário. Nós não exigimos que somente usuários registrados acessem o wiki mas, te encorajamos a registrar-se.

Por que nós precisamos de VOCÊ?

O Wiki Xen.org já existe a um bom tempo e, como diversos Wiki's contem muitos conteúdos que estão desatualizados ou não são mais relevantes. Nós decidimos migrar para o MediaWiki o que nos permite um novo inicio. Esperamos ser capazes de mobilizar os membros da comunidade Xen e estamos planejando realizar um número de atividades regulares e abordagens como:

UncleSamSmall.png

Convenções Wiki

Nós gostariamos de tornar o gerenciamento e uso tão fácil quanto possível para que os usuários utilizem e encontrem conteúdos no novo Wiki garantindo sua atualização.

Páginas Wiki internas úteis

Estas páginas auxiliam editores que precisam trabalhar.

Changes Missing Content Manage Pages
Alterações Recentes (inglês) Criar uma Página (inglês) »» Criar uma página Páginas sem categoria (inglês) »» Categorizar
Alterações Relacionadas (inglês) Upload de arquivos (inglês) »» Upload de arquivo Ações Necessárias (inglês) »» Precisa ser deletada, refeita, revisada, ...
Criar uma Categoria (inglês) »» Create category Necessidade de formatação (ingês) »» Reparo fácil para iniciantes
Criar um Template (ingês) »» Criar template TODO (ingês) »» Para fazer (TODO)

Gerenciando Páginas via Templates

Templates para ajudar a gerenciar conteúdos
Template Quando usar
Template:Needs_Archive Indica que esta página precisa ser arquivada. Favor, especificar um motivo.
Template:Needs_Additions Indica que esta página está incompleta e pode se beneficiar de adições e melhorias. Por favor, especifique o que deve ser adicionado.
Template:Needs_Delete Indica que esta página precisa ser eliminada. Por favor, especificar um motivo.
Template:Needs_Formatting Indica que esta página tem alguns problemas na formatação. Por favor, detalhe o problema.
Template:Needs_Refactor Indica que esta página precisa ser reformulada, como a fusão ou cisão. Por favor, seja concreto sobre a razão e ação proposta.
Template:Needs_Review Indica que esta página precisa ser revisada. Se partes específicas da página precisam ser revistas ou estão incorretas, indique na macro.
Template:Needs_Rewrite Indica que esta página precisa ser reescrita; em outras palavras, a página é útil mas, contém muitos erros. Por favor, forneça mais informações na macro.
Template:Needs_Recategorize Indica que esta página precisa ser categorizada. Por favor, especifique um motivo.
Template:TODO Este é um modelo genérico que indica que algo precisa ser feito para esta página. Só deve ser utilizado se os modelos mais específicos não são aplicáveis.
Outros templates mais genéricos
Template Quando usar
Template:Info Este é um box de informação generica, que destaca algumas informações sobre esta página.
Template:InfoLeft O mesmo que Info mas não centralizada.
Template:Warning Este é um box genérico de aviso, que destaca algumas informações sobre esta página que normalmente avisa o usuário sobre alguma coisa.

Veja também:

  • Ajuda com Templates (inglês)
  • Exemplo de como utilizar qualquer um dos templates acima:
    {{Info|Este é um infobox com este texto na caixa}}
  • Outro exemplo:
    {{Needs_Archive|Esta página está desatualizada: este projeto foi concluído em 2009.}}

Melhor navegação através de Categorias

Categorias Comuns

Categorias por audiência
Categoria Quando usar
Category:Users Este documento é para usuários do Xen ou qualquer projeto hospedado no Xen.org
Category:Beginners Este documento é dirigido principalmente para iniciantes. Note que esta categoria poderá ser principalmente utilizada em conjunto com Category:Users.
Category:Developers Este documento é dirigido para desenvolvedores do Xen ou para qualquer projeto hospedado no Xen.org
Category:Project Este documento é dirigido principalmente para projetos de documentação com um ROADMAP, TODO list, etc. para projetos hospedados no Xen.org
Category:Community Este documento é um documento para a comunidade que não se encaixa em outro lugar. Destina-se a informações gerais do Xen e da comunidade em geral
Categorias por tempo determinado
Categoria Quando usar
Category:Transient Este documento tem uma duração limitada (por exemplo, ele descreve um evento ou uma atividade de curta duração). Páginas nesta categoria devem ser revistas pelo menos anualmente e arquivadas de forma adequada.
Category:Archived Este documento foi arquivado.
Categorias por tipo de documento (note que estes documentos devem ser utilizados ​​em conjunto com as categorias por audiência)
Categoria Quando usar
Category:Overview Este documento contém um documento de visão global para um tópico específico. Visões Globais são tipicamente introduções e contém definições,

This document contains an Overview document for a specific topic. Overviews are typically introductory and contain definitions, trade-offs, conceitos básicos, etc.

Category:FAQ Este documento contém uma ou mais perguntas frequentes incluindo respostas
Category:HowTo Este documento contém um artigo HOWTO (como fazer), que é geralmente um pequeno tutorial
Category:Tutorial Este documento contém um tutorial passo-a-passo para um caso de uso complexo
Category:Example Este documento contém principalmente exemplos de arquivos de configuração, configurações, scripts, etc.
Category:Compatibility Este documento contém informações de compatibilidade de um determinado software com outro, de um determinado software com um hardware e outras compatibilidades.
Category:Index Este documento é em grande parte index de outras páginas.
Category:Glossary Este documento é uma definição de termos utilizados na comunidade Xen ou termos genéricos
Categorias por projetos ou tecnologia
Categoria Quando usar
Category:Xen This document is related to the Xen Hypervisor project or technology. This category may be used for user, developer as well as project categories.
Category:XCP This document is related to the XCP project or technology. This category may be used for user, developer as well as project categories.
Category:PVOPS This document is related to the PVOPS project or technology, which is about upstreaming and maintining Xen support in Linux. This category may be used for user, developer as well as project categories.
Category:XenARM This document is related to the XenARM project or technology. This category may be used for user, developer as well as project categories.

Other Categories

These are more specialised categories. Please ensure that these are used in conjunction with

Project type: Categories that relate to a specific project
Category When to use
Category:OCaml This document is related to the OCaml language, in which most of XCP is implemented.
Document type: Categories that are mainly relevant to developers
Category When to use
Category:Development Process This document describes a process or technique relates to projects on Xen.org. Documents in this category are mainly relevant for developers.
Category:Design Document This category contains design documents, architecture descriptions, and so on: in short it contains documents that describe how parts of the codebase work. Documents in this category are mainly relevant for developers.
Document type: Categories that are mainly relevant to users
Category When to use
Category:Release Notes This document describes Release Notes for a specifc project or product hosted on Xen.org.

Improving Accessibility of topics with Trails

Trails are sequences of documents (or indeed sections of documents) that are suggested to be read in a certain order. Note that trails are automatically added to the Category:Trail.

Usage of Trails

Archiving Pages

Pages are archived in the following way:

  • Add [[Category:Archived]] to the page
  • Rename the page from <pagename> to Archived/<pagename>
  • Ensure you do the same with all sub-pages and translations
  • Keep all categories as they are
  • If you cannot rename the page, then mark it with {{Needs_Archive|Reason why}}, such that a wiki adminstrator can rename the page

Multi-language Help and Conventions

Icon Info.png Also see Category:Languages!


The Languages Template

Pages and categories which exist in multiple translations must have the {{Languages}} template at the bottom of the page. This allows user to see the translations that are available for that page.

If you use multiple languages, the {{Languages}} template must be on every page in that language.

The English page contains:

<!-- The content of the actual page is here. -->
<!-- The {{Languages}} template must be at the bottom of the page! -->
<!-- There should be NO empty lines after {{Languages}}  -->
{{Languages}}

The translated page contains:

<!-- The content of the actual page is here. -->
<!-- The {{Languages}} template must be at the bottom of the page! -->
<!-- There should be NO empty lines after {{Languages}}  -->
{{Languages|<name of English page>|<language code>}}

For example [[Main Page/pt]] contains

{{Languages|Main Page|pt}}

The English version of a page is always the main version of a page, with all other languages as sub-pages, named using the appropriate language code (see below).

Naming conventions for translated pages

Translated pages need to follow the following naming conventions.

<My Page Name>/<2 Letter Language Code>

The two letter language code must be one of the codes shown in the supported languages table, for example

Page Name Language
Main Page English
Main Page/de German
Main Page/es Spanish
Main Page/fr French
Main Page/ja Japanese
Main Page/ko Korean
Main Page/pt Portuguese
Main Page/pt-br Brazilian Portuguese
Main Page/zh Chinese

Examples

Examples of valid page names are:

[[Category:Xen/ja]]
[[Frontend_Driver/de]]
[[Archived/XCI Getting Started/pt]]
[[Template:Fmbox/doc/zh]]

Languages Category

Translated pages must be Categorized: they must contain a category of the form

[[Category:Languages/<Language code>]]

such that it is possible to find all pages of a specific language.

Examples

Examples of valid category names are:

[[Category:Languages/ja]]
[[Category:Languages/pt]]

Links for translated pages

You have to be careful when linking to other pages. Say you want to link to

[[DomU_Install_with_Virt-Manager]]

If you use the page above, you will go to the English page. If you want to go to a translated page, the link must look as follows

[[DomU_Install_with_Virt-Manager/<language code>]]

E.g.

[[DomU_Install_with_Virt-Manager/es]]

If you keep links to English documents in a translation, it is a good idea to use the following convention

[[DomU_Install_with_Virt-Manager]] (English)

such that people see, that the document is in English.

Examples & Testing

Example Page

Note that it is important to follow the conventions as outlined here. If not followed, the language templates do not work properly and users will find it hard to find translated content.

Page Foo must contain

{{Languages}}

Page Foo/es must contain

{{Languages|Foo|es}}

The following notation also works, but is harder to use

[[Category:Languages/es]]
{{Languages|Foo}}

Example Category

Page Category:Foo must contain

{{Languages}}

Page Category:Foo/es must contain

{{Languages|:Category:Foo|es}}

Testing whether you have done OK

You should be able to see the following:

  • A box called 'Languages on the English and translated page (see bottom of Main Page as an example)
  • A box called 'Languages on the English and translated category
  • The 'Languages box should show: English, The Language You added, languages somebody else added. If it doesn't, you probably used the wrong language macro on the English page.
  • Translated pages should be in the Language/<your language> category, e.g. Language/es. You should go to the category for your language and check whether all pages are in this category.

Language Policy

Languages

This page describes the current multi-lingual policy on wiki.xen.org.


The main page

The English version of our front page is located at Main Page. Translated versions are located at MediaWiki/code, where code is the language code (e.g. Main Page/fr).

Importantly, the rules about language codes (see below) should be followed here as well.

Other namespaces

Apart from the Main Page, no policy has yet been decided about other namespaces. For the time being, if you would like to create translations for pages in other namespaces then please do so as described for the Help: namespace, however content may be moved or deleted depending on the policy that is eventually adopted.

Note that the rule that English content should not be placed in sub-pages does not apply to other namespaces. This is one of the issues that needs resolving.

Language codes

Throughout wiki.xen.org you should use the language codes specified by the MediaWiki software when creating language-specific content (see Names.php for the full and up-to-date list).

Please also bear the following in mind:

  • If the language code is not found in Names.php then we should not host pages in that language.
  • If MediaWiki uses the 'incorrect' code for a language then you should also (for consistency) use that incorrect code here. If you think a code is incorrect you should discuss it on MediaWiki Bugzilla, and if this results in it being changed we will move the pages to match.
  • Note that some language codes in Names.php are now deprecated (e.g. zh-yue has been replaced with yue). In these cases only the most recent code should be used.
Languages Language: [[::Wiki Community/pt-br|English]]

Use of Discussions: Talk pages

Every wiki page has an associated talk page which can be used for discussion and communicating with other users. Talk pages can be accessed by clicking the “discussion” tab at the top of the page. Simply edit the page as normal to add your comment.

We encourage the use of talk pages. However, it would be good if you followed these Guidelines What to discuss:

  • Keep focused on the task of building a wiki article: remember that editing the article itself is often a more effective means of communicating.
  • Use discussion pages only to support this process: the topic of conversation should generally revolve around what needs to be done to make the associated article better.
  • Talk pages are good in particular, if you suspect something is wrong with the content, but you do not quite know how to fix the page.

Conventions:

  • Start a new discussion with a ==level 2 heading== at the bottom of the page (or use the “+” tab)
  • Always sign your name after your comments. Use the four tildes “~~~~” wiki syntax (or the signature button signature button in the toolbar above the editing textbox). For more information see Help:Signatures.
  • Indent replies with colons (:) at the beginning of the line.


Also See: