MoodleDocs:Guidelines for contributors: Difference between revisions

Latest revision as of 20:42, 15 March 2011

A sua colaboração é bem vinda na documentação do Moodle (Docs). Quando encontrar algo que possa ser melhorado, tanto no conteúdo como na gramática ou no formato, ajude a comunidade melhorando o texto. Esta página lhe dará algumas idéias e diretrizes.

Introdução

Você é bem vindo a contribuir com o Moodle Docs. Encontre algo que possa ser melhorado, tanto em conteúdo, gramática ou formatação, e corrija!
Se você ainda não o fez, por favor autentique-se.
Por favor, note que todas as contribuições publicadas aqui estão sob a GNU General Public License.
A partir do Moodle 1.6, toda página do moodle tem uma página correspondente no Moodle Docs. Você pode ver isso em moodle.org e, da perspectiva de um administrador, no Moodle demo site.
Por favor, perceba que os Arquivos de ajuda do Moodle permanecerão em cada pacote de idioma, logo seus textos não precisam ser incluídos nesta documentação, no entanto não há problema em um pouco de informação duplicada.
Você é encorajado a ilustrar a documentação com screenshots. Por favor, veja o guia de estilo para mais informações.
Existem tags que você pode incluir para pedir a outros colaboradores alguma ajuda na edição. Isto inclui pedidos de exclusão, atualização e notação de rascunho

Criando novas páginas

Você é bem vindo a criar novas páginas para documentação adicional. Simplesmente digite o nome da sua nova página entre duplos colchetes [[Nome da nova página]] em uma página existente e siga o link par começar a editar a nova página. Alternativamente, você pode digitar na barra de endereços do seu navegador: https://docs.moodle.org/pt_br/Nome_da_nova_pagina (substitua os espaços no nome da nova página por "underscores", "_" )
Por favor, escolha um nome curto e use apenas a primeira letra maiúscula (com pouca exceções, como a palavra Moodle).
Nova documentação de desenvolvedor deve ser adicionado ao Development namespace digitando Development: antes do nome da página, por exemplo [[Development:Nova página]]
Por favor, siga o guia de estilo. Categorizar as novas páginas pode deixar mais fácil para os usuários achá-las, mas o mais importante é colocar bom conteúdo na página.
Títulos de páginas podem ser alterados no futuro, redirecionando/movendo páginas, como parte de reestruturação da documentação

Tipos de páginas

Como o Moodle Docs cresceu com o passar do tempo, diversos tipos de estilos para páginas com suas próprias orientações informais emergiram. Conforme você olhar para as páginas você provavelmente reconhecerá algumas destas. Entretanto, a regra básica é que se não há conteúdo na página, não há nada para achar e certamente nada para a comunidade editar e considerar. Assim, por favor, sinta-se livre para adicionar conteúdo e não se preocupe com os refinamentos abaixo.

Páginas gerais - as mais comuns e variadas. O Guia de estilos dá uma boa idéia do potencial. Esta página mesmo é um exemplo de uma página geral.

Páginas de introdução. Estas servem quase como uma tabela do conteúdo sobre um assunto, com links para páginas com informação mais detalhada. Diversas técnicas são utilizadas. Algumas vezes, links são colocados em uma lista de marcadores. Ou pequenas sentenças podem ser utilizadas para dar contexto aos links para páginas. Você pode notar que algumas das principais páginas de introdução são protedigas.

Páginas de FAQ. FAQs são similares a páginas de introdução. Neste tipo de página, cada título tem algo sobre uma pergunta que é frequentemente respondida, a resposta tipicamente é curta. A resposta fornece links para páginas ou links para uma sessão específica que deve expandir a resposta para a questão. É legal incluir um item que tenha particularmente frustrado você, junto com a descrição da solução. Como qualquer coisa no Moodle Docs, isto pode ser editado. Frequentemente os leitores encontram estas páginas em links nos fórums do moodle.org. O FAQ do módulo Lição (em inglês) é um exemplo.

Páginas de código contribuído. Estas tendem a ter links para a base de downloads do moodle.org e para o fórum que discute questões relacionadas. É claro que existirá uma breve descrição dos propósitos do código, uma lista de funcionalidades, talvez algumas dicas sobre como instalar e configurações úteis. Um exemplo é o módulo Book.

Links entre idiomas

Você é bem vindo a incluir links inter-idiomas entre páginas de diferentes idiomas. Simplesmente digite, por exemplo [[es:Título da página correspondente em Espanhol]] no MoodleDocs em português, ou [[pt_br:Título da página correspondente em Português]] no MoodleDocs em Espanhol, no fim da página, abaixo do link da categoria. Links inter-idiomas aparecerão automaticamente no bloco "Outras línguas". Com exceção do Inglês, apenas idiomas relacionados são interligados. (Se você acredita que um idioma relacionado não está incluído, contate o administrador do Docs.)

Indicadores de versões do Moodle

Quando adicionando documentação sobre uma nova funcionalidde, por favor inclua o template da versão do Moodle, digitando, por exemplo {{Moodle 1.9}}.
Além de realçar diferenças nas versões do Moodle, os templates de versão do Moodle automaticamente categorizam artigos em categorias de versão, por exemplo Category:Moodle 1.9.
Templates para versões do Moodle que não estão mais disponíveis em Moodle downloads podem ser removidos e substituídos por texto simples, por exemplo "A partir do Moodle 1.5, ...".

Comentários de páginas

Para comentário sobre uma página em particular, e/ou pequenas discussões, use a respectiva página de discussão (clique na aba discussão). Por favor, autentique-se e coloque uma data na sua contribuiçção na página de discussão digitando quatro tios ~~~~. Existe também um ícone para assinatura na barra de ferramentas do campo de edição Imagem:Signature Icon.png
Para discussões mais longas sobre a documentação, utilize o fórum de Documentação.
Se você encontrar um comentário não assinado, você pode utilizar o Template:Unsigned, como {{Unsigned|Username}} que será mostrado um (The preceding comment was added by Username)

Proteção de páginas

Algumas páginas são protegidas de edição. Para estas páginas, tente contribuir através da respectiva página de discussão.
- Dica: Copie o conteúdo de uma página protegida, cole em uma nova página, então edite a nova página. Na aba "discussão" da nova página, dê as razões para a edição. Então, na aba "discussão" da página protegida, chame atenção para a nova página com o link e um resumo dos seus motivos para alteração.
Para uma lista das páginas protegidas veja Category:Protected pages.

Veja também

@@ Line 1: / Line 1: @@
-Colabore com a documentação do Moodle (Docs). Quando encontrar algo que possa ser melhorado, tanto no conteúdo como na gramática ou no formato, ajude a comunidade melhorando o texto. Esta página lhe dará algumas idéias e diretrizes.
+A sua colaboração é bem vinda na documentação do Moodle (Docs). Quando encontrar algo que possa ser melhorado, tanto no conteúdo como na gramática ou no formato, ajude a comunidade melhorando o texto. Esta página lhe dará algumas idéias e diretrizes.
 ==Introdução==
-* You are welcome to contribute to Moodle Docs. Find something that can be improved, either in content, grammar or formatting, and fix it!
-* If you've not done so already, please [[Special:Userlogin|login]].
+* Você é bem vindo a contribuir com o Moodle Docs. Encontre algo que possa ser melhorado, tanto em conteúdo, gramática ou formatação, e corrija!
-* Please note that all contributions are released here under [[License|GNU General Public License]].
+* Se você ainda não o fez, por favor [[Special:Userlogin|autentique-se]].
-* From Moodle 1.6 onwards, every page in Moodle has a link to a corresponding page in Moodle Docs. You can see this on [http://moodle.org moodle.org] and, from an administrator's perspective, on the [http://demo.moodle.com/ Moodle demo site].
+* Por favor, note que todas as contribuições publicadas aqui estão sob a [[License|GNU General Public License]].
-* Please note that the [http://moodle.org/help.php?file=index.html Moodle help files] will remain in each language pack and so their text need not be included in this documentation, though a small amount of duplicate information is ok.
+* A partir do Moodle 1.6, toda página do moodle tem uma página correspondente no Moodle Docs. Você pode ver isso em [http://moodle.org moodle.org] e, da perspectiva de um administrador, no [http://demo.moodle.com/ Moodle demo site].
-* You are encouraged to illustrate documentation with screenshots. Please refer to the [[MoodleDocs:Style guide|style guide]] for further information.
+* Por favor, perceba que os [http://moodle.org/help.php?file=index.html Arquivos de ajuda do Moodle] permanecerão em cada pacote de idioma, logo seus textos não precisam ser incluídos nesta documentação, no entanto não há problema em um pouco de informação duplicada.
-* There are tags you can place to ask for [[MoodleDocs:Style_guide#MoodleDoc_editing_tags|editing help]] from other contributors. These include requests for page [[MoodleDocs:Deletion|deletion]], [[MoodleDocs:Update|updating]] and [[MoodleDocs:Stub|stub notations]].
+* Você é encorajado a ilustrar a documentação com screenshots. Por favor, veja o [https://docs.moodle.org/en/MoodleDocs:Style_guide guia de estilo] para mais informações.
+* Existem tags que você pode incluir para pedir a outros colaboradores alguma [https://docs.moodle.org/en/MoodleDocs:Style_guide#MoodleDoc_editing_tags ajuda na edição]. Isto inclui pedidos de [https://docs.moodle.org/en/MoodleDocs:Deletion exclusão], [https://docs.moodle.org/en/MoodleDocs:Update atualização] e [https://docs.moodle.org/en/MoodleDocs:MoodleDocs:Stub notação de rascunho]
 ==Criando novas páginas==
-* You are welcome to create pages for additional documentation. Simply type the name of your new page between double brackets <code><nowiki>[[New page name]]</nowiki></code> on an existing page and follow the link to start editing the new page. Alternatively, you may type in your browser address bar: <code><nowiki>https://docs.moodle.org/en/New_page_name</nowiki></code> (i.e. replace spaces in the new page name with underscores).
+* Você é bem vindo a criar novas páginas para documentação adicional. Simplesmente digite o nome da sua nova página entre duplos colchetes <code><nowiki>[[Nome da nova página]]</nowiki></code> em uma página existente e siga o link par começar a editar a nova página. Alternativamente, você pode digitar na barra de endereços do seu navegador: <code><nowiki>https://docs.moodle.org/pt_br/Nome_da_nova_pagina</nowiki></code> (substitua os espaços no nome da nova página por "underscores", "_" )
-* Please choose a short name and capitalize the first word only (with a few exceptions, such as the word ''Moodle'').
+* Por favor, escolha um nome curto e use apenas a primeira letra maiúscula (com pouca exceções, como a palavra ''Moodle'').
-* New developer documentation pages should be added to the ''Development namespace'' by typing <code>Development:</code> before the new page name i.e. <code><nowiki>[[Development:New page name]]</nowiki></code>.
+* Nova documentação de desenvolvedor deve ser adicionado ao ''Development namespace'' digitando <code>Development:</code> antes do nome da página, por exemplo <code><nowiki>[[Development:Nova página]]</nowiki></code>
-* Please follow the [[MoodleDocs:Style guide|style guide]]. If you categorize new pages it can make it easier for users to find, but the important thing is to put good content into the page.
+* Por favor,  siga o [https://docs.moodle.org/en/MoodleDocs:Style_guide guia de estilo]. Categorizar as novas páginas pode deixar mais fácil para os usuários achá-las, mas o mais importante é colocar bom conteúdo na página.
-* Page titles may be changed in the future by redirecting/moving pages, as part of documentation restructuring.
+* Títulos de páginas podem ser alterados no futuro, redirecionando/movendo páginas, como parte de reestruturação da documentação
 ==Tipos de páginas==
-As Moodle Docs has grown over time, several general page style types with their own informal guidelines have emerged.  As you look at pages you will probably recognize some of these.  However, the basic rule is that if there is no page content, there is nothing to find and certainly nothing for the community to edit and consider.  Thusly, please feel free to add content and not worry about the refinements below.
-*'''General pages''' - the most common and most varied. The [[MoodleDocs:Style guide]] gives a good idea of the potential.  This page itself is an example of a general page.
+Como o Moodle Docs cresceu com o passar do tempo, diversos tipos de estilos para páginas com suas próprias orientações informais emergiram. Conforme você olhar para as páginas você provavelmente reconhecerá algumas destas. Entretanto, a regra básica é que se não há conteúdo na página, não há nada para achar e certamente nada para a comunidade editar e considerar. Assim, por favor, sinta-se livre para adicionar conteúdo e não se preocupe com os refinamentos abaixo.
-*'''Introduction pages'''.  These serve almost as table of contents on a subject to pages with more detailed information. Several techniques are used.  Some times [[Help:Editing#Page_links|links]] are placed in a [[Help:Editing#Lists|bulleted list]]. Or short sentences maybe used to give context for the embedded [[Help:Editing#Page_links|page links]]. You may notice some of the major subject introduction pages are protected, such as [[Administrator_documentation]].
+*'''Páginas gerais''' - as mais comuns e variadas. O [[:en:MoodleDocs:Style_guide|Guia de estilos]] dá uma boa idéia do potencial. Esta página mesmo é um exemplo de uma página geral.
-*'''FAQ pages'''. [[:Category:FAQ|FAQs]] are similar to introduction pages. In this kind of page, each heading has something about a frequently asked question, the typical answer is short.  The answer provides links to pages, or links to a specific page section that should expand the answer to the question. It is OK to put in a particular item that may have frustrated you, along with a description of the solution.  Like anything in Moodle Docs it maybe edited.  Often readers reach these pages from a moodle.org forum link. [[Lesson module FAQ]] is an example.
+*'''Páginas de introdução'''. Estas servem quase como uma tabela do conteúdo sobre um assunto, com links para páginas com informação mais detalhada. Diversas técnicas são utilizadas. Algumas vezes, [[:en:Help:Editing#Page_links|links]] são colocados em uma [[:en:Help:Editing#Lists|lista de marcadores]]. Ou pequenas sentenças podem ser utilizadas para dar contexto aos [[:en:Help:Editing#Page_links|links para páginas]]. Você pode notar que algumas das principais páginas de introdução são protedigas.
-*'''Contributed code pages'''. These tend to have links to the moodle.org download database, to the forum that discusses issues.  Of course there will be a brief description of its purpose, a list of features, maybe some hints about installing and useful settings. [[Book module]] is an example.
+*'''Páginas de FAQ'''. [[:Category:FAQ|FAQs]] são similares a páginas de introdução. Neste tipo de página, cada título tem algo sobre uma pergunta que é frequentemente respondida, a resposta tipicamente é curta.  A resposta fornece links para páginas ou links para uma sessão específica que deve expandir a resposta para a questão. É legal incluir um item que tenha particularmente frustrado você, junto com a descrição da solução. Como qualquer coisa no Moodle Docs, isto pode ser editado. Frequentemente os leitores encontram estas páginas em links nos fórums do moodle.org. O [[:en:Lesson module FAQ|FAQ do módulo Lição]] (em inglês) é um exemplo.
+*'''Páginas de código contribuído'''. Estas tendem a ter links para a base de downloads do moodle.org e para o fórum que discute questões relacionadas. É claro que existirá uma breve descrição dos propósitos do código, uma lista de funcionalidades, talvez algumas dicas sobre como instalar e configurações úteis. Um exemplo é o [[:en:Book module|módulo Book]].
 ==Links entre idiomas==
-* You are welcome to add inter-language links between pages in different languages. Simply type, for example, <code><nowiki>[[es:Corresponding page title in Spanish]]</nowiki></code> in the English MoodleDocs, or <code><nowiki>[[en:Corresponding page title in English]]</nowiki></code> in the [[:es:Portada|Spanish MoodleDocs]], at the bottom of the page, below the category link. Inter-language links will appear automatically in the "In other languages" block. With the exception of English, only related languages are interlinked. (If you feel that a related language is not included contact the Docs administrator).
+* Você é bem vindo a incluir links inter-idiomas entre páginas de diferentes idiomas. Simplesmente digite, por exemplo <code><nowiki>[[es:Título da página correspondente em Espanhol]]</nowiki></code> no MoodleDocs em português, ou <code><nowiki>[[pt_br:Título da página correspondente em Português]]</nowiki></code> no [[:es:Portada|MoodleDocs em Espanhol]], no fim da página, abaixo do link da categoria. Links inter-idiomas aparecerão automaticamente no bloco "Outras línguas". Com exceção do Inglês, apenas idiomas relacionados são interligados. (Se você acredita que um idioma relacionado não está incluído, contate o administrador do Docs.)
 ==Indicadores de versões do Moodle==
-* When adding documentation about a new feature, please add a Moodle version template by typing, for example, <code><nowiki>{{Moodle 1.9}}</nowiki></code>.
+* Quando adicionando documentação sobre uma nova funcionalidde, por favor inclua o template da versão do Moodle, digitando, por exemplo <code><nowiki>{{Moodle 1.9}}</nowiki></code>.
-* In addition to highlighting differences in Moodle versions, Moodle version templates automatically categorize articles into version categories, for example [[:Category:Moodle 1.9]].
+* Além de realçar diferenças nas versões do Moodle, os templates de versão do Moodle automaticamente categorizam artigos em categorias de versão, por exemplo [[:Category:Moodle 1.9]].
-* Templates for Moodle versions no longer available from [http://download.moodle.org/ Moodle downloads] can be removed and replaced with ordinary text, for example "From Moodle 1.5 onwards, ...".
+* Templates para versões do Moodle que não estão mais disponíveis em [http://download.moodle.org/ Moodle downloads] podem ser removidos e substituídos por texto simples, por exemplo "A partir do Moodle 1.5, ...".
 == Comentários de páginas ==
-* For comments about a particular page, and/or short discussions, please use the corresponding talk page (click on the page comments tab). Please sign and date your talk page contribution by typing four tildes <nowiki>~~~~</nowiki>. There's also a handy button for signing in the toolbar of the editing field: [[Image:Signature Icon.png]]
+* Para comentário sobre uma página em particular, e/ou pequenas discussões, use a respectiva página de discussão (clique na aba discussão). Por favor, autentique-se e coloque uma data na sua contribuiçção na página de discussão digitando quatro tios <nowiki>~~~~</nowiki>. Existe também um ícone para assinatura na barra de ferramentas do campo de edição [[Imagem:Signature Icon.png]]
+* Para discussões mais longas sobre a documentação, utilize o [http://moodle.org/mod/forum/view.php?id=5838 fórum de Documentação].
-* For longer discussions about the documentation, please use the Using Moodle [http://moodle.org/mod/forum/view.php?id=5838 Documentation forum].
+* Se você encontrar um comentário não assinado, você pode utilizar o Template:Unsigned, como <nowiki>{{Unsigned|Username}}</nowiki> que será mostrado um <small>(''The preceding comment was added by'' [[User:Username]])</small>
-* If you find an unsigned comment you can use the Template:Unsigned like so <nowiki>{{Unsigned|Username}}</nowiki> which will show as <small>(''The preceding comment was added by'' [[User:Username]])</small>
 ==Proteção de páginas==
-* Some pages are protected from editing. For these pages, try contributing via the associated talk page.
-**Tip: Copy the contents of a protected page, paste it in a new page, then edit the new page.  On the new page's "page comment" tab give reasons for the edit.  Then on the protected page's "Page comment" tab, call attention to the new page with a link and a summary of your reasons for change.
-* For a list of protected pages, see [[:Category:Protected pages]].
+* Algumas páginas são protegidas de edição. Para estas páginas, tente contribuir através da respectiva página de discussão.
+** Dica: Copie o conteúdo de uma página protegida, cole em uma nova página, então edite a nova página. Na aba "discussão" da nova página, dê as razões para a edição. Então, na aba "discussão" da página protegida, chame atenção para a nova página com o link e um resumo dos seus motivos para alteração.
+* Para uma lista das páginas protegidas veja [[:Category:Protected pages]].
 ==Veja também==
 *[[Moodle documentation FAQ]]
 *[http://moodle.org/mod/forum/view.php?id=5838 Moodle Documentation forum]
@@ Line 61: / Line 62: @@
 [[es:MoodleDocs:Normas para colaboradores]]
 [[fr:MoodleDocs:Recommandations pour contributeurs]]
-[[ja:MoodleDocs:寄稿のガイドライン]]
-[[ru:MoodleDocs:Путеводитель_для_разработчиков_документации]]
-[[zh:MoodleDocs:贡献者指引]]
-[[sv:MoodleDocs:Riktlinjer för bidrag]]