diff options
Diffstat (limited to 'files/pt-pt/mdn/contribute/howto')
13 files changed, 109 insertions, 450 deletions
diff --git a/files/pt-pt/mdn/contribute/howto/como_definir_o_resumo_para_uma_pagina/index.html b/files/pt-pt/mdn/contribute/howto/como_definir_o_resumo_para_uma_pagina/index.html deleted file mode 100644 index 172aed7d5d..0000000000 --- a/files/pt-pt/mdn/contribute/howto/como_definir_o_resumo_para_uma_pagina/index.html +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: Como definir o resumo para uma página -slug: MDN/Contribute/Howto/Como_definir_o_resumo_para_uma_pagina -tags: - - Como - - Guia(2) - - Metadados MDN -translation_of: MDN/Contribute/Howto/Set_the_summary_for_a_page ---- -<div>{{MDNSidebar}}</div><p><span class="seoSummary">Pode definir-se o resumo de uma página no MDN para ser usada de várias maneiras, incluindo em resultados de motores de busca, noutras páginas MDN tais como páginas de destino de tópicos, e dicas ou sugestões de ajuda. Deverá ser um texto que faça sentido quer no contexto da página, quer quando aparece noutros contextos, sem que esteja disponível a totalidade do conteúdo.</span></p> - -<p>Um resumo pode definido explicitamente em apenas uma página. Se não estiver explicitamente definido, então normalmente usam-se as primeiras linhas, o que nem sempre é o melhor para o objectivo pretendido.</p> - -<dl> - <dt><strong>O que é uma tarefa?</strong></dt> - <dd>Identificar o texto de uma página que melhor poderia ser usado para ser o seu resumo, mesmo que apareça noutros contextos; esta tarefa poderá incluir editar o texto existente e/ou introduzir texto apropriado se necessário.</dd> - <dt><strong>Onde é que esta precisa de ser feita?</strong></dt> - <dd>Em páginas que não têm resumos ou têm um resumo menos bom.</dd> - <dt><strong>O que precisa de saber para efectuar a tarefa?</strong></dt> - <dd>Habilitação para usar o editor MDN; competência em português escrito; familiaridade suficiente com o tópico para escrever um bom resumo.</dd> - <dt><strong>Quais os passos a seguir?</strong></dt> - <dd> - <ol> - <li>Escolher uma página para colocar um resumo: - <ol> - <li>Na página <a href="https://developer.mozilla.org/pt-PT/docs/MDN/Doc_status">Estado do documento por tópico</a>, clique num tópico de que tenha algum conhecimento (por exemplo, HTML) da coluna Secções: <br> - <img alt="" src="https://mdn.mozillademos.org/files/8681/sections.png" style="height: 130px; width: 504px;"></li> - <li>Na página de Estado do documento do tópico escolhido, clicar no cabeçalho <strong><em>Pages</em></strong> da tabela <strong><em>Summary. </em></strong> Irá para um índice de todas as páginas da secção correspondente ao tópico escolhido; mostra os links das páginas na coluna esquerda, e as palavras-chave e resumos na coluna da direita:<br> - <img alt="" src="https://mdn.mozillademos.org/files/8675/pages.png" style="height: 82px; width: 361px;"></li> - <li>Escolher uma página que não tenha ou tenha um fraco resumo:<br> - <img alt="" src="https://mdn.mozillademos.org/files/8677/summary.png" style="height: 38px; width: 296px;"></li> - <li>Clicar no link para ir para essa página.</li> - </ol> - </li> - <li>Clicar em <strong>Edit</strong> para abrir a página no editor MDN.</li> - <li>Tentar encontrar uma frase ou duas que possam servir de resumo, mesmo fora de contexto. Se necessário, editar o conteúdo existente para criar ou modificar frases de modo a que estas se tornem um bom resumo.</li> - <li>Seleccionar o texto que irá ser usado como resumo.</li> - <li>Na ferramenta Estilos, da barra de ferramentas do editor, seleccionar <strong>SEO Summary</strong>. (Na página de código fonte, isto cria um elemento {{HTMLElement("span")}} com <code>class="seoSummary"</code> em volta do texto seleccionado.)<br> - <img alt="" src="https://mdn.mozillademos.org/files/8679/styles.png" style="height: 231px; width: 403px;"></li> - <li>Guardar as alterações com um comentário de revisão. O comentário é opcional, mas é encorajado pois torna mais fácil para os outros utilizadores o rastreio de alterações.</li> - </ol> - - <p> </p> - </dd> -</dl> - -<p> </p> diff --git a/files/pt-pt/mdn/contribute/howto/como_efetuar_revisao_tecnica/index.html b/files/pt-pt/mdn/contribute/howto/como_efetuar_revisao_tecnica/index.html deleted file mode 100644 index def53aa207..0000000000 --- a/files/pt-pt/mdn/contribute/howto/como_efetuar_revisao_tecnica/index.html +++ /dev/null @@ -1,65 +0,0 @@ ---- -title: Como efetuar uma revisão técnica -slug: MDN/Contribute/Howto/Como_efetuar_revisao_tecnica -tags: - - Como - - Documentação - - Guía - - Metadados MDN - - Revisão -translation_of: MDN/Contribute/Howto/Do_a_technical_review ---- -<div>{{MDNSidebar}}</div> - -<div>{{IncludeSubnav("/en-US/docs/MDN")}}</div> - -<p class="summary"><strong>'Uma revisão Técnica' </strong>consiste em rever a exatidão técnica e a integridade de um artigo e corrigi-lo, se necessário. Se um escritor de um artigo quiser que outra pessoa verifique o conteúdo técnico de um artigo, o escritor marca a caixa de seleção "Revisão técnica" durante a edição. Muitas vezes, o escritor entra em contacto com um técnico específico para realizar a revisão técnica, mas qualquer pessoa com conhecimento técnico no assunto pode efetuar uma.</p> - -<p>Este artigo descreve como realizar uma revisão técnica, ajudando a garantir que o conteúdo da MDN seja preciso<span class="seoSummary">.</span></p> - -<dl> - <dt>O que é uma tarefa?</dt> - <dd>Rever e corrigir os artigos para uma perfeição e exatidão técnica.</dd> - <dt> - <p> </p> - Onde é que esta precisa de ser efetuada?</dt> - <dd>Nos artigos específicos que são marcados como 'necessária uma <a href="/en-US/docs/needs-review/technical">revisão técnica</a>' (em inglês).</dd> - <dt>O que precisa de saber para realizar a tarefa?</dt> - <dd> - <ul> - <li> - <p>Conhecimento especializado do tópico do artigo que está a rever. Se ao ler o artigo não lhe ensina algo significativamente novo, considere-se um especialista<span style="font-size: 1rem; letter-spacing: -0.00278rem;">.</span></p> - </li> - <li>Como editar um artigo da wiki na MDN.</li> - </ul> - </dd> - <dt>Quais são os passos a seguir?</dt> - <dd> - <ol> - <li>Escolha um artigo para rever: - <ol> - <li>Vá para lista das páginas que precisam de <a href="/en-US/docs/needs-review/technical">revisões técnicas</a>. I - <p> </p> - sto lista todas as páginas para as quais uma revisão técnica foi solicitada.</li> - <li>Escolha uma página cujo tópico esteja familizarizado.</li> - <li>Clique na hiperligação do artigo para carregar a página.</li> - </ol> - </li> - <li><a id="core-steps" name="core-steps"></a>Leia o artigo, tendo em atenção os detalhes técnicos: O artigo está correto? Tem alguma coisa em falta? Não hesite em mudar para uma página diferente se a primeira que escolheu não lhe é conveniente.</li> - <li>Se não existirem erros, não precisa de editar o artigo para o marcar como revisto. Veja na caixa "revisão rápida" na barra lateral esquerda da página. Esta caixa amarela lista quaisquer revisões pendentes e deixa-o limpar a bandeira do pedido da sua revisão. Parece-se com isto se foi solicitada uma revisão técnica:<br> - <img alt="Screenshot of the sidebar's box listing reviews that have been requested and allowing the flags to be changed." src="https://mdn.mozillademos.org/files/13016/SidebarTechReviewRequested.png"></li> - <li>Desselecione a caixa <strong>Técnico</strong>, e clique em <strong>Guardar</strong>.</li> - <li>Se encontrar erros que precisam de ser corrigidos, irá ficar feliz em saber que também pode alterar o estado da solicitação de revisão no editor. Aqui tem o fluxo de trabalho: - <ol> - <li>Para editar a página, clique em <strong>Editar</strong> perto do topo da página; isto coloca-o no <a href="/pt-PT/docs/MDN/Contribute/Editor">editor da MDN</a>.</li> - <li>Corrigir qualquer informação técnica que não esteja correta, e/ou adicioanr qualquer informação importante que esteja em falta.</li> - <li>Inserir um '<strong>Comentário da Revisão'</strong> no fim do artigo. Esta é uma breve mensagem que descreve o que fez, tal como 'Revisão técnica concluída'. Se corrigiu a informação, inclua isso no seu comentário, por exemplo, 'Revisão técnica e descrições dos parâmetros corrigidos'. Isto ajuda os outros colaboradores e editores de sites a saberem o que alterou e o porquê. Também pode mencionar se existiam partes específicas que não se sentia qualificado para rever.</li> - <li>Desselecionar a caixa <strong>Técnico </strong>sob <strong>Revisão necessária?</strong>.</li> - <li>Clique em <strong>PUBLICAR</strong>.</li> - </ol> - </li> - </ol> - - <p>Parabéns! Concluiu a sua primeira revisão técnica! Obrigado pela sua ajuda!</p> - </dd> -</dl> diff --git a/files/pt-pt/mdn/contribute/howto/como_escrever_um_artigo_para_ajudar_as_pessoas_a_aprenderem_sobre_a_web/index.html b/files/pt-pt/mdn/contribute/howto/como_escrever_um_artigo_para_ajudar_as_pessoas_a_aprenderem_sobre_a_web/index.html deleted file mode 100644 index 5751a2e391..0000000000 --- a/files/pt-pt/mdn/contribute/howto/como_escrever_um_artigo_para_ajudar_as_pessoas_a_aprenderem_sobre_a_web/index.html +++ /dev/null @@ -1,114 +0,0 @@ ---- -title: Como escrever um artigo para ajudar as pessoas a aprenderem sobre a Web -slug: >- - MDN/Contribute/Howto/Como_escrever_um_artigo_para_ajudar_as_pessoas_a_aprenderem_sobre_a_Web -tags: - - Aprender - - Como - - Guia(2) - - Metadados MDN -translation_of: MDN/Contribute/Howto/Write_an_article_to_help_learn_about_the_Web ---- -<div>{{MDNSidebar}}</div> - -<p>A <strong><a href="/pt-PT/docs/Learn">Área de Aprendizagem</a></strong> da MDN é o nosso local para os artigos que introduzem os conceitos da Web para os novos programadores. Porque o seu conteúdo, principalmente, tem como alvo os principiantes, é um local excelente para partilhar os seus conhecimentos e ajudar estes a conhecer a Web. É importante certificar-se que os novos programadores podem seguir este conteúdo, por isso nós damos especial atenção a este.</p> - -<p><span class="seoSummary">Este artigo explica sobre como escrever as páginas para a <a href="/pt-PT/docs/Learn">Área de Aprendizagem</a>.</span></p> - -<h2 id="Como_escrever_um_artigo_da_Área_de_Aprendizagem">Como escrever um artigo da <u><strong>Área de Aprendizagem</strong></u></h2> - -<p>To start contributing your knowledge, simply click the big green button, then follow the five steps below. If you're looking for ideas, please take a look at the <a href="https://trello.com/b/LDggrYSV">our team Trello board</a>!</p> - -<p></p><div class="align-center"><a class="button ignore-external mega positive" href="/pt-PT/docs/new?parent=111819">Escrever um novo artigo de aprendizagem<div></div></a></div><p></p> - -<p>This article might not end up in exactly the right place, but at least it's on MDN. If you need to talk to someone about getting it moved to the right place, please <a href="/en-US/docs/Learn#Contact_us">Contact us</a>.</p> - -<h3 id="Passo_1_Write_a_two-liner">Passo 1: Write a two-liner</h3> - -<p>Your article's first sentence needs to summarize what subject you're going to cover, and the second one should go into a few more specifics of the items that you'd put in the article. For example:</p> - -<div class="summary"> -<p>Whereas {{glossary("HTML")}} files contain structured content, {{Glossary("CSS")}}, another major Web technology, makes the content look the way you want. In this article we are going to cover how this technology works, and how to write your own basic example.</p> -</div> - -<p>Note how the example briefly explains that CSS is a core Web technology used to style pages. That's enough for the reader to get a pretty good idea what the article covers.</p> - -<p>Because Learning Area articles primarily target beginners, each article should cover one straightforward topic so as not to overwhelm the reader with too much new information. If you can't summarize the article in one sentence, you might be trying to do too much in one article!</p> - -<h3 id="Passo_2_Add_a_top_box">Passo 2: Add a top box</h3> - -<p>Then add a<strong> top box</strong> to help readers get their bearings as to where they are in the learning process. Here's an example of a top box from <a href="/en-US/docs/Learn/Understanding_URLs">"Understanding URLs and their structure"</a>. You can use this article as an model when writing your own.</p> - -<table class="learn-box standard-table"> - <tbody> - <tr> - <th scope="row">Pré-requisitos:</th> - <td>You need to first know <a class="new" href="https://developer.mozilla.org/en-US/docs/Learn/How_the_Internet_works">how the Internet works</a>, <a class="new" href="https://developer.mozilla.org/en-US/docs/Learn/What_is_a_Web_server">what a Web server is</a>, and <a class="new" href="https://developer.mozilla.org/en-US/docs/Learn/Understanding_links_on_the_web">the concepts behind links on the web</a>.</td> - </tr> - <tr> - <th scope="row">Objetivo:</th> - <td>You will learn what a URL is and how it works on the Web.</td> - </tr> - </tbody> -</table> - -<dl> - <dt>Pré-requisitos</dt> - <dd>What must the reader already know to follow the article? When possible, make each prerequisite a link to another Learning Area article covering the concept (unless it's a really basic article that doesn't require prior knowledge).</dd> - <dt>Objetivos</dt> - <dd>This section briefly states what the reader will learn over the course of the article. This is a bit different than the one-liner; the one-liner summarizes the topic of the article, while the objectives section specifically lays out what the reader can expect to accomplish over the course of the article.</dd> -</dl> - -<div class="note"> -<p><strong>Nota:</strong> To create this table, you can either copy and paste the example table above, or use MDN's editor's <a href="/en-US/docs/MDN/Contribute/Editor/Tables">table tool</a>. If you choose to use the table tool, you need to specifically add the <code>learn-box</code> CSS class in addition to the default <code>standard-table</code> class. To do this, when you create or edit the table's properties,, go to the "Advanced" panel and set the <strong>Stylesheet Classes</strong> field to "<code>standard-table learn-box</code>".</p> -</div> - -<h3 id="Passo_3_Write_a_full_description">Passo 3: Write a full description</h3> - -<p>Next, write a longer description that provides a more thorough overview of the article highlighting the most important concepts. Don't forget to explain why the reader should take the time to learn this topic and read your article!</p> - -<h3 id="Passo_4_Dig_deeper">Passo 4: Dig deeper</h3> - -<p>When you're done with all that, you can finally dive deeply into the topic. You can structure this part of your article however you like (although feel free to consult our <a href="/en-US/docs/MDN/Contribute/Style_guide">style guide</a>). This is your chance to shine! Go into detail explaining the topic you're writing about. Provide links to the full reference documentation, explain how the technology works in detail, provide syntax and usage details, and so forth. It's up to you!</p> - -<p>As a guide, here are some writing tips for beginners:</p> - -<ul> - <li>Focus on a single topic. If you feel like you need to cover other topics, it means either you're missing a prerequisite article, or you need to break up your article into more than one.</li> - <li>Use simple English. Avoid technical terms when you can, or at least define them and <a href="https://developer.mozilla.org/en-US/docs/MDN/Contribute/Howto/Write_a_new_entry_in_the_Glossary#How_to_use_the_.7B.7BGlossary.7D.7D_macro">link to their glossary entries</a> where applicable.</li> - <li>Include straightforward examples to make the theoretical concepts easier to grasp. Many people learn best by example. Rather than writing academic papers, we want beginners to follow the text readily.</li> - <li>Visual aids often can make things easier to digest and carry extra information, so feel free to use images, diagrams, videos, and tables. If you're using diagrams or charts that include text, we encourage you to use {{Glossary("SVG")}} so our translation teams can localize the text.</li> -</ul> - -<p>Have a look at the first few sections of our <a href="/en-US/docs/Learn/JavaScript/Building_blocks/Functions">Functions — reusable blocks of code</a> article for some good descriptive sections.</p> - -<h3 id="Passo_5_Provide_active_learning_material">Passo 5: Provide "active learning" material</h3> - -<p>To illustrate the article and help the reader better understand what they're learning, be sure to provide exercises, tutorials, and tasks to accomplish. By having them actively and practically using and experimenting with the concepts your article explains, you can help "lock" the information into their brains.</p> - -<p>You can choose to include the examples directly in the page as <a href="/en-US/docs/MDN/Contribute/Structures/Live_samples">live samples</a>, or <a href="/en-US/docs/MDN/Contribute/Editor/Links">link to them</a> if they don't really work as a live sample. If you're interested in helping create these valuable materials, please read the article <a href="https://developer.mozilla.org/en-US/docs/MDN/Contribute/Howto/Create_an_interactive_exercise_to_help_learning_the_web">Create an interactive exercise to help learning the Web</a>.</p> - -<p>If you can't provide links to existing active learning materials (you don't know of any or don't have time to create them), you should add the tag {{Tag("NeedsActiveLearning")}} to the article. That way other contributors can find articles that need active learning materials and perhaps help you come up with them.</p> - -<p>Have a look at <a href="/en-US/docs/Learn/CSS/Introduction_to_CSS/Simple_selectors#Active_learning_Selecting_different_elements">Active learning: selecting different elements</a> for a live interactive learning exercise, or <a href="/en-US/docs/Learn/JavaScript/Building_blocks/Functions#Active_learning_Playing_with_scope">Active learning: Playing with scope</a> for a different style of exercise that calls upon them to download a template locally and modify it following the provided steps.</p> - -<h3 id="Passo_6_Get_the_article_reviewed_and_put_into_the_Learning_Area_navigation_menu">Passo 6: Get the article reviewed, and put into the Learning Area navigation menu</h3> - -<p>After you've written your article, let us know so we can have a look at it, do a review, and suggest improvements. Again, see our <a href="/en-US/docs/Learn#Contact_us">Contact us</a> section for the best ways to get in touch.</p> - -<p>Another part finalizing your article is to put it in the Learning Area main navigation menu. This menu is generated by the <a href="/en-US/docs/Template:LearnSidebar">LearnSidebar macro</a>, which you need special privileges to edit, so again, talk ot one of our team about getting it added.</p> - -<p>You should at least add it to your page — this is done by adding the macro call \{{LearnSidebar}} into a paragraph at the top of your page.</p> - -<ul> -</ul> - -<h2 id="Artigos_sugeridos">Artigos sugeridos</h2> - -<p>So you want to contribute but you're not sure what to write about?</p> - -<p>The Learning Area team maintains <a href="https://trello.com/b/LDggrYSV">a Trello board with ideas of articles</a> to write. Feel free to pick one and get to work!</p> - -<p> </p> - -<p> </p> diff --git a/files/pt-pt/mdn/contribute/howto/como_converter_exemplos_de_codigo_para_ficarem_live/index.html b/files/pt-pt/mdn/contribute/howto/convert_code_samples_to_be_live/index.html index e0f16cc514..e0f16cc514 100644 --- a/files/pt-pt/mdn/contribute/howto/como_converter_exemplos_de_codigo_para_ficarem_live/index.html +++ b/files/pt-pt/mdn/contribute/howto/convert_code_samples_to_be_live/index.html diff --git a/files/pt-pt/mdn/contribute/howto/criar_e_editar_paginas/index.html b/files/pt-pt/mdn/contribute/howto/create_and_edit_pages/index.html index e4d8572fe3..e4d8572fe3 100644 --- a/files/pt-pt/mdn/contribute/howto/criar_e_editar_paginas/index.html +++ b/files/pt-pt/mdn/contribute/howto/create_and_edit_pages/index.html diff --git a/files/pt-pt/mdn/contribute/howto/criar_uma_conta_mdn/index.html b/files/pt-pt/mdn/contribute/howto/criar_uma_conta_mdn/index.html deleted file mode 100644 index 058456953e..0000000000 --- a/files/pt-pt/mdn/contribute/howto/criar_uma_conta_mdn/index.html +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: Como criar uma conta MDN -slug: MDN/Contribute/Howto/Criar_uma_conta_MDN -tags: - - Como - - Documentação - - Guía - - Metadados MDN - - Principiante -translation_of: MDN/Contribute/Howto/Create_an_MDN_account ---- -<div>{{MDNSidebar}}</div> - -<p><span class="seoSummary">Para editar conteúdo na MDN precisa de um perfil MDN. Não precisa de um perfil se só pretende ler e pesquisar documentos na MDN. Este guia irá ajudá-lo a configurar o seu perfil na MDN.</span></p> - -<div class="standardSidebar" style="width: 280px;"><strong>Porque é que a MDN precisa do meu endereço de e-mail?</strong><br> -<br> -O seu endereço de e-mail é utilizado para a recuperação da conta e, se necessário, pelos administradores da MDN para o contactar sobre a sua conta ou atividade no site.<br> -<br> -Adicionalmente, pode registar-se para receber notificações (tais como, <a href="/pt-PT/docs/MDN/Contribute/Tools/Vigiar_pagina">quando são alteradas páginas especificas</a>) e mensagens (por exemplo, se optar por aderir à nossa equipa de testes beta, poderá receber mensagens sobre as novas funcionalidades que precisam de ser testadas).<br> -<br> -O seu endereço de e-mail nunca é exibido na MDN e será utilizado apenas de acordo com a nossa <a href="https://www.mozilla.org/privacy/websites/">politica de privacidade</a> (EN).</div> - -<div class="note">Se iniciou a sessão na MDN via GitHub, e utiliza um endereço de e-mail "não responder" no GitHub, <em>não irá receber</em> mensagens (incluindo as notificações quando subecrever páginas) na MDN.</div> - -<ol> - <li>No topo de cada página na MDN irá encontrar um botão nomeado "Iniciar sessão". Clique com o seu rato (ou toque no mesmo, se estiver a utilizar um dispositivo móvel) para exibir uma lista de serviços de autenticação que nós suportamos para iniciar a sessão na MDN.</li> - <li>Selecione um serviço para iniciar a sessão. Atualmente, apenas está disponível o GitHub. Note que se selecionar o GitHub, será incluída uma hiperligação para o seu perfil do GitHub na página pública do seu perfil da MDN.</li> - <li>Siga os avisos do GitHub para entrar na sua conta MDN.</li> - <li>Assim que o serviço de autenticação volta para o seu MDN, ser-lhe-á pedido para inserir um nome de utilizador e um endereço de e-mail<strong>. </strong><em>O seu nome de utilizador será exibido publicamente para creditar o seu trabalho realizado. Não utilize o seu endereço de e-mail como o seu nome de utilizador</em><strong>.</strong></li> - <li>Clique em <strong>Criar o meu perfil MDN</strong>.</li> - <li>Se o endereço de e-mail especificado no passo 4 não for o mesmo que utilizou no serviço de autenticação, por favor, verifique o seu e-mail e clique na hiperligação na mensagem de confirmação que nós lhe enviamos.</li> -</ol> - -<p>E é tudo! Agora tem uma conta MDN, e pode editar as páginas imediatamente!</p> - -<p>Pode clicar no seu nome no topo de qualquer página da MDN para ver o seu perfil público. Lá, pode clicar em <strong>Editar</strong> para efetuar alterações ou adições ao seu perfil.</p> - -<div class="note"> -<p>Os novos nomes de utilizador não podem conter espaços ou o caráter "@". Lembre-se que o seu nome de utilizador será exibido publicamente para identificar o seu trabalho realizado!</p> -</div> diff --git a/files/pt-pt/mdn/contribute/howto/fazer_revisão_editorial/index.html b/files/pt-pt/mdn/contribute/howto/fazer_revisão_editorial/index.html deleted file mode 100644 index d2902a8bb6..0000000000 --- a/files/pt-pt/mdn/contribute/howto/fazer_revisão_editorial/index.html +++ /dev/null @@ -1,56 +0,0 @@ ---- -title: Como efetuar uma revisão editorial -slug: MDN/Contribute/Howto/fazer_revisão_editorial -tags: - - Como - - Documentação - - Guía - - Metadados MDN - - Revisão Editorial -translation_of: MDN/Contribute/Howto/Do_an_editorial_review ---- -<div>{{MDNSidebar}}</div> - -<div>{{IncludeSubnav("/pt-PT/docs/MDN")}}</div> - -<p class="summary">As<strong> </strong><strong>revisões editoriais</strong> consistem em corrigir erros de digitação, ortografia, gramática, utilização ou erros textuais num artigo. Não é preciso ser um especialistas em linguagem para efetuar contribuições úteis para a documentação técnica da MDN, mas os artigos continuam a precisar de edição de cópia e revisão de provas. Isto é efetuado numa revisão editorial.</p> - -<p><span class="seoSummary">Este artigo descreve como efetuar uma revisão editorial, que ajuda a assegurar que o conteúdo na MDN é preciso e bem escrito.</span></p> - -<dl> - <dt>O que é a tarefa?</dt> - <dd>Copy-editing and proof-reading of articles that are marked as requiring an editorial review.</dd> - <dt>Onde é que esta tem de ser efetuada?</dt> - <dd>Within specific articles that are marked as requiring an editorial review.</dd> - <dt>O que precisa de saber para efetuar a tarefa?</dt> - <dd>You need to have good English grammar and spelling skills. An editorial review is about ensuring that the grammar, spelling, and wording are correct and make sense, and that the <a href="/en-US/docs/MDN/Contribute/Guidelines/Writing_style_guide">MDN writing style guide</a> is followed.</dd> - <dt>Quais os passos a seguir?</dt> - <dd> - <ol> - <li>Escolha um artigo para rever: - <ol> - <li>Go to the list of <a href="/en-US/docs/needs-review/editorial">articles needing editorial review</a>. This lists all the pages for which an editorial review has been requested.</li> - <li>Click on the article link to load the page.<br> - <strong>Nota: </strong>This listing is generated automatically but infrequently, so some articles appear on the list that no longer need editorial review. If the article you picked does <em>not</em> display a banner that says "This article needs an editorial review", skip that article and pick a different one.</li> - </ol> - </li> - <li><a id="core-steps" name="core-steps"></a>Read the article, paying close attention for typos, spelling, grammar, or usage errors. Don't hesitate to switch to a different page if the first one you choose doesn't suit you.</li> - <li>If there are no errors, you don't need to edit the article to mark it as reviewed. Look for the "quick review" box in the left sidebar of the page:<br> - <img alt="Screenshot of the editorial review request sidebar box" src="https://mdn.mozillademos.org/files/13018/SidebarReviewBoxEditorial.png"></li> - <li>Deselect the <strong>Editorial</strong> box and click <strong>Save</strong>.</li> - <li>If you find errors that need to be corrected: - <ol> - <li>Click the <strong>Edit</strong> button near the top of the page; this brings you into the <a href="/en-US/docs/Project:MDN/Contributing/Editor_guide">MDN editor</a>.</li> - <li>Correct any typos and spelling, grammar, or usage errors you find. You don't have to fix everything to be useful, but be sure to leave the editorial review request in place if you don't feel reasonably sure that you've done a complete review of the entire article.</li> - <li>Enter a <strong>Revision Comment</strong> at the bottom of the article; something like '<em>Editorial review: fixed typos, grammar & spelling.</em>' This lets other contributors and site editors know what you changed and why.</li> - <li>Deselect the <strong>Editorial</strong> box under <strong>Review Needed?</strong>. This is located just below the Revision Comment section of the page.</li> - <li>Click the <strong>Publish</strong> button.</li> - </ol> - </li> - </ol> - - <div class="note"> - <p>Depois de guardar, as suas alterações poderão não ser visíveis de imediato; existe um pequeno atraso enquanto a página é processada e guardada.</p> - </div> - </dd> -</dl> diff --git a/files/pt-pt/mdn/contribute/howto/marcar_paginas_javascript/index.html b/files/pt-pt/mdn/contribute/howto/marcar_paginas_javascript/index.html deleted file mode 100644 index e7c610347c..0000000000 --- a/files/pt-pt/mdn/contribute/howto/marcar_paginas_javascript/index.html +++ /dev/null @@ -1,75 +0,0 @@ ---- -title: Como marcar páginas de JavaScript -slug: MDN/Contribute/Howto/Marcar_paginas_JavaScript -tags: - - Como - - Guia(2) - - JavaScript - - Metadados MDN -translation_of: MDN/Contribute/Howto/Tag_JavaScript_pages ---- -<div>{{MDNSidebar}}</div><p class="summary">A <strong><u>marcação</u> </strong>consiste na adição de informação-metadados às páginas, e assim o conteúdo relacionado pode ser agrupado, por exemplo, na ferramenta de pesquisa.</p> - -<dl> - <dt>Onde é que isso precisa ser feito<strong>?</strong></dt> - <dd>Nas <a href="/pt-PT/docs/MDN/Doc_status/JavaScript">páginas relacionadas com JavaScript especificas sem marcações (tags)</a></dd> - <dt>O que precisa de saber para efetuar a tarefa<strong>?</strong></dt> - <dd>Conhecimento de codificação JavaScript básico, tal como saber o que é um 'método' ou uma 'propriedade'.</dd> - <dt>Quais são os passos a efetuar<strong>?</strong></dt> - <dd> - <ol> - <li>Escolha uma das páginas na lista acima.</li> - <li>Clique na hiperligação do artigo para carregar a página.</li> - <li>Assim que a página esteja carregada, clique em "<strong>EDITAR"</strong> perto do seu topo; isto leva-o para o editor da MDN.</li> - <li>Deverá ser adicionada pelo menos uma etiqueta de <code>JavaScript</code>. Aqui tem algumas das etiquetas possíveis para adicionar:</li> - <li> - <table class="standard-table"> - <thead> - <tr> - <th scope="col">Etiqueta</th> - <th scope="col">Que páginas para a utilizar</th> - </tr> - </thead> - <tbody> - <tr> - <td><code>Method</code></td> - <td>methods</td> - </tr> - <tr> - <td><code>Property</code></td> - <td>properties</td> - </tr> - <tr> - <td><code>prototype</code></td> - <td>prototypes</td> - </tr> - <tr> - <td>Object type name</td> - <td>methods of an object; for example String.fromCharCode should have the tag <code>String</code></td> - </tr> - <tr> - <td><code>ECMAScript6 </code>and <code>Experimental</code></td> - <td>features added in a new ECMAScript version</td> - </tr> - <tr> - <td><code>Deprecated</code></td> - <td>deprecated features (whose use is discouraged but still supported)</td> - </tr> - <tr> - <td><code>Obsolete</code></td> - <td>obsolete features (which are no longer supported in modern browsers)</td> - </tr> - <tr> - <td>others</td> - <td>See <a href="/en-US/docs/Project:MDN/Contributing/Tagging_standards">MDN tagging standards</a> for other possible tags to apply</td> - </tr> - </tbody> - </table> - </li> - <li>Guarde com um comentário.</li> - <li>E concluiu!</li> - </ol> - </dd> -</dl> - -<p> </p> diff --git a/files/pt-pt/mdn/contribute/howto/participar_testes_beta/index.html b/files/pt-pt/mdn/contribute/howto/participar_testes_beta/index.html deleted file mode 100644 index ec68693a32..0000000000 --- a/files/pt-pt/mdn/contribute/howto/participar_testes_beta/index.html +++ /dev/null @@ -1,52 +0,0 @@ ---- -title: Como participar nos testes "beta" -slug: MDN/Contribute/Howto/Participar_testes_beta -tags: - - MDN Meta - - Metadados MDN -translation_of: MDN/Contribute/Howto/Be_a_beta_tester ---- -<div>{{MDNSidebar}}</div><p>De vez em quando, à medida que os programadores da plataforma Kuma da MDN fazem alterações no site, nós oferecemos acesso antecipado a essas novas funcionalidades aos membros que optaram por participar nos testes "beta". Como é típico com qualquer teste "beta", as funcionalidades podem não funcionar corretamente em algumas situações.</p> - -<h2 id="Participar_nos_testes_beta">Participar nos testes "beta"</h2> - -<ol> - <li>Depois de iniciar a sessão na MDN, clique no seu nome de utilizador na barra de navegação no topo.<br> - <img alt="Shows location of the user's profile link in the top navigation" src="https://mdn.mozillademos.org/files/15099/profile_link.png" style="box-shadow: 2px 2px 7px 1px #9e9e9e; height: 59px; width: 383px;"><br> - This takes you to your profile page.</li> - <li>Clique no botão "<strong>Edit</strong>".<br> - <img alt="Shows location of the button to edit a user's profile (which may vary depending on window dimensions" src="https://mdn.mozillademos.org/files/15093/profile_edit_link.png" style="box-shadow: 2px 2px 7px 1px #9e9e9e; height: 144px; width: 387px;"><br> - This opens the profile page in edit mode.</li> - <li>Selecione a caixa para <em><strong>Beta tester</strong></em>.<br> - <img alt="Shows the location of the Beta Tester checkbox" src="https://mdn.mozillademos.org/files/15095/profile_beta_checkbox.png" style="box-shadow: 2px 2px 7px 1px #9e9e9e; height: 139px; width: 305px;"></li> - <li>Clique no botão "<strong>Publicar" </strong>no fim da página de perfil.<br> - <img alt="Shows the location of the Publish button on a user's profile page" src="https://mdn.mozillademos.org/files/15097/profile_publish_button.png" style="box-shadow: 2px 2px 7px 1px #9e9e9e; height: 218px; width: 477px;"></li> -</ol> - -<h2 id="Cancelar_participação_nos_testes_beta">Cancelar participação nos testes "beta"</h2> - -<ol> - <li>While logged in to MDN, click your user name in the top navigation bar. This takes you to your profile page.</li> - <li>Click the <strong>Edit</strong> button. This opens the profile page in edit mode.</li> - <li>Clear the checkbox for <strong>Beta tester</strong>.</li> - <li>Click the <strong>Publish</strong> button.</li> -</ol> - -<h2 id="Dê_a_sua_opiniãocomentário_sobre_os_testes_beta">Dê a sua opinião/comentário sobre os testes "beta"</h2> - -<p>There are two ways you can give feedback about a beta test:</p> - -<ul> - <li>Share qualitative feedback on the MDN discussion forum. Add a post to the <a href="https://discourse.mozilla-community.org/t/beta-redesign-feedback/16544">Beta feedback thread</a>. Or,</li> - <li>File a bug, using the following steps:</li> -</ul> - -<ol> - <li><a href="https://bugzilla.mozilla.org/createaccount.cgi">Create an account on Bugzilla</a> if you don't already have one.</li> - <li>Open a <a href="https://bugzilla.mozilla.org/form.mdn#h=detail%7Cbug">bug report in Bugzilla for MDN</a>.</li> - <li>Include the word "beta" in the Summary field to help MDN developers filter and triage incoming bugs.</li> - <li>Fill out the bug report form to the best of your ability. Be as detailed as possible.</li> - <li>Click the <strong>Submit</strong> button.</li> -</ol> - -<p> </p> diff --git a/files/pt-pt/mdn/contribute/howto/comunicar_um_problema/index.html b/files/pt-pt/mdn/contribute/howto/report_a_problem/index.html index 764d3fca0c..764d3fca0c 100644 --- a/files/pt-pt/mdn/contribute/howto/comunicar_um_problema/index.html +++ b/files/pt-pt/mdn/contribute/howto/report_a_problem/index.html diff --git a/files/pt-pt/mdn/contribute/howto/etiqueta/index.html b/files/pt-pt/mdn/contribute/howto/tag/index.html index 2d0ca3d1d6..2d0ca3d1d6 100644 --- a/files/pt-pt/mdn/contribute/howto/etiqueta/index.html +++ b/files/pt-pt/mdn/contribute/howto/tag/index.html diff --git a/files/pt-pt/mdn/contribute/howto/como_escrever_uma_nova_entrada_no_glossario/index.html b/files/pt-pt/mdn/contribute/howto/write_a_new_entry_in_the_glossary/index.html index 105853672c..105853672c 100644 --- a/files/pt-pt/mdn/contribute/howto/como_escrever_uma_nova_entrada_no_glossario/index.html +++ b/files/pt-pt/mdn/contribute/howto/write_a_new_entry_in_the_glossary/index.html diff --git a/files/pt-pt/mdn/contribute/howto/write_an_api_reference/sidebars/index.html b/files/pt-pt/mdn/contribute/howto/write_an_api_reference/sidebars/index.html new file mode 100644 index 0000000000..8e28e33556 --- /dev/null +++ b/files/pt-pt/mdn/contribute/howto/write_an_api_reference/sidebars/index.html @@ -0,0 +1,109 @@ +--- +title: Barras laterais de referência da API +slug: MDN/Structures/API_references/Barras_laterais_de_referencia_da_API +tags: + - API + - Guía + - Referencia + - barras laterais + - groupdata + - onboarding +translation_of: MDN/Structures/API_references/API_reference_sidebars +--- +<div>{{MDNSidebar}}</div><p class="summary">Pode incluir uma barra lateral personalizada nas páginas de referência da API para exibir as hiperligações para as 'Interfaces' relacionadas, tutoriais, e outros recursos relevantes, apenas para essa API. Este artigo explica como.</p> + +<h2 id="O_que_precisa_de_fazer">O que precisa de fazer?</h2> + +<p>You need to take the following three steps to create your API sidebar:</p> + +<ol> + <li>Create your API reference pages.</li> + <li>Add an entry for your particular API into the <a href="https://github.com/mdn/kumascript">KumaScript repo</a>'s GroupData.json data file.</li> + <li>Use the \{{APIRef}} macro to insert the sidebar into each page you want to display it on.</li> +</ol> + +<p>Let's run through each of these steps in turn. The example we'll refer to in this article is the <a href="/en-US/docs/Web/API/Fetch_API">Fetch API</a>.</p> + +<h3 id="Criar_páginas_de_referência_da_sua_API">Criar páginas de referência da sua API</h3> + +<p>Before you can add sidebars to your pages, you'll need to create the pages themselves (see our <a href="/en-US/docs/MDN/Contribute/Structures/API_references/What_does_an_API_reference_need">What does an API reference need?</a> guide for more guidance).</p> + +<h3 id="Adicionar_uma_entrada_para_GroupData.json">Adicionar uma entrada para GroupData.json</h3> + +<p>The <a href="https://github.com/mdn/kumascript/blob/master/macros/GroupData.json">GroupData.json</a> file holds all the data relating to what links should appear in API reference sidebars. When invoked, the \{{APIRef}} macro takes an API name given to it as a parameter, looks up that name in GroupData.json, builds a sidebar as appropriate, and inserts it in the page.</p> + +<p>To add an entry to GroupData.json, you need to:</p> + +<ol> + <li>Make sure you have a <a href="https://github.com/">GitHub</a> account.</li> + <li>Fork the KumaScript repo, create a new branch to contain your changes, and clone the repo locally.</li> + <li>Checkout your new branch before starting work, and make sure you push changes to it after finishing.</li> + <li>Create a pull request so that the MDN team can review your work, and ask for changes if necessary.</li> +</ol> + +<p>If you need help with using GitHub, a more detailed guide can be found at our <a href="/en-US/docs/MDN/Contribute/Structures/Compatibility_tables#The_new_way_The_browser_compat_data_repo_and_dynamic_tables">compatibility tables guide</a>.</p> + +<p>The <a href="https://github.com/mdn/kumascript/blob/master/macros/GroupData.json">GroupData.json</a> file can be found inside the macros directory of the KumaScript repo. Looking at it, you'll see a giant JSON structure, with each API having its own member. The name is the API name, and the value is an object containing several submembers defining the sidebar links to be created.</p> + +<p>For example, look at the <a href="/en-US/docs/Web/API/Fetch_API">Fetch API</a> page on MDN. The corresponding entry in GroupData.json looks like this:</p> + +<pre class="brush: json notranslate">"Fetch API": { + "overview": [ "Fetch API"], + "interfaces": [ "Body", + "Headers", + "Request", + "Response", + "FetchController", + "FetchObserver", + "FetchSignal", + "ObserverCallback" ], + "methods": [ "WindowOrWorkerGlobalScope.fetch()" ], + "properties": [], + "events": [] +},</pre> + +<p>As you can see, we've used "Fetch API" for the name, and inside the object value we include a number of submembers.</p> + +<h4 id="Submembers_to_include_inside_a_GroupData_entry">Submembers to include inside a GroupData entry</h4> + +<p>This section lists all the submembers you could include in a GroupData entry.</p> + +<p>Note that Most of the values included inside the listed submembers equate to both the link text, and slugs appended to the end of the main API index page — https://developer.mozilla.org/<em><language-code></em>/docs/Web/API — to create the final URL for the displayed link. So for example, "Body" will result in a link being created like so in the <em>en-US</em> locale:</p> + +<pre class="brush: html notranslate"><li><a href="https://developer.mozilla.org/en-US/docs/Web/API">Body</a></li></pre> + +<p>There are a few exceptions. For example the "guides" submember contains one or more sets of link information (title and slug) that defines links to associated guides/tutorials. In this case the slugs are appended to the end of the MDN docs root — https://developer.mozilla.org/<em><language-code></em>/docs — allowing an article anywhere on MDN to be included.</p> + +<p>Here are the available members. In each case, an example is included that assumes that the local is <em>en-US</em>.</p> + +<ol> + <li> + <p>"overview" — the value is an array, inside of which you include the slug of the API overview page, if there is one. "Fetch API" results in a link being made to <a href="/en-US/docs/Web/API/Fetch_API">https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API</a>.</p> + </li> + <li> + <p>"interfaces" — the value is an array in which you should list all of the interfaces that form part of that API. "Body" results in a link being made to <a href="/en-US/docs/Web/API/Body">https://developer.mozilla.org/en-US/docs/Web/API/Body</a>.</p> + </li> + <li> + <p>"methods" — the value is an array that should contain all of the methods associated with the API. This can include methods that are members of interfaces defined in the API spec, and methods the API defines on other interfaces. If there are a huge number of methods, you might want to consider only listing the most popular ones, or putting them first in the list. "WindowOrWorkerGlobalScope.fetch()" results in a link being made to <a href="/en-US/docs/Web/API/WindowOrWorkerGlobalScope/fetch">https://developer.mozilla.org/en-US/docs/Web/API/WindowOrWorkerGlobalScope/fetch</a>.</p> + </li> + <li> + <p>"properties" — the value is an array that should contain all of the properties associated with the API. This can include properties that are members of interfaces defined in the API spec, and properties the API defines on other interfaces. If there are a huge number of properties, you might want to consider only listing the most popular ones, or putting them first in the list. "Headers.append" results in a link being made to <a href="/en-US/docs/Web/API/Headers/append">https://developer.mozilla.org/en-US/docs/Web/API/Headers/append</a>.</p> + </li> + <li> + <p>"events" — the value is an array that should contain all of the events associated with the API, defined in the API spec, or elsewhere. If there are a huge number of events, you might want to consider only listing the most popular ones, or putting them first in the list. "animationstart" results in a link being made to <a href="/en-US/docs/Web/Events/animationstart">https://developer.mozilla.org/en-US/docs/Web/Events/animationstart</a>.</p> + </li> + <li> + <p>"guides" — the value is an array containing one or more objects that define links to guides explain how to use the API. Each object contains two submembers — "url", which contains the partial URL pointing to the guide article, and "title", which defines the link test for the link. As an example, the following object:</p> + + <pre class="brush: json notranslate">{ "url": "/docs/Web/API/Detecting_device_orientation", +"title": "Detecting device orientation" }</pre> + + <p>Creates a link with the title "Detecting device orientation", which points to <a href="/en-US/docs/Web/API/Detecting_device_orientation">https://developer.mozilla.org/en-US/docs/Web/API/Detecting_device_orientation</a>.</p> + </li> +</ol> + +<h3 id="Inserir_a_barra_lateral_nas_suas_páginas">Inserir a barra lateral nas suas páginas</h3> + +<p>Once you've added an entry for your API into GroupData.json, submitted it as a pull request and had the change accepted into the main repo, you can include it in your API reference pages using the \{{APIRef}} macro, which takes the name you used for your API in GroupData as a parameter. As an example, the <a href="/en-US/docs/Web/API/WebVR_API">WebVR API</a>'s sidebar is included in its pages with the following:</p> + +<p>\{{APIRef("WebVR API")}}</p> |