diff options
| author | Peter Bengtsson <mail@peterbe.com> | 2020-12-08 14:42:52 -0500 |
|---|---|---|
| committer | Peter Bengtsson <mail@peterbe.com> | 2020-12-08 14:42:52 -0500 |
| commit | 074785cea106179cb3305637055ab0a009ca74f2 (patch) | |
| tree | e6ae371cccd642aa2b67f39752a2cdf1fd4eb040 /files/pt-pt/mdn | |
| parent | da78a9e329e272dedb2400b79a3bdeebff387d47 (diff) | |
| download | translated-content-074785cea106179cb3305637055ab0a009ca74f2.tar.gz translated-content-074785cea106179cb3305637055ab0a009ca74f2.tar.bz2 translated-content-074785cea106179cb3305637055ab0a009ca74f2.zip | |
initial commit
Diffstat (limited to 'files/pt-pt/mdn')
46 files changed, 5690 insertions, 0 deletions
diff --git a/files/pt-pt/mdn/comunidade/conversações/index.html b/files/pt-pt/mdn/comunidade/conversações/index.html new file mode 100644 index 0000000000..2112b63562 --- /dev/null +++ b/files/pt-pt/mdn/comunidade/conversações/index.html @@ -0,0 +1,58 @@ +--- +title: Conversações da comunidade MDN +slug: MDN/Comunidade/Conversações +tags: + - Comunidade + - Guia(2) + - MDN Meta +translation_of: MDN/Community/Conversations +--- +<div>{{MDNSidebar}}</div><p class="summary">O "trabalho" da MDN ocorre no site da MDN, mas a "comunidade" também produz através da discussão (assíncrona), conversação on-line (síncrona) e encontros.</p> + +<h2 id="Discussões_assíncronas">Discussões assíncronas</h2> + +<p>Para partilhar a informação e ter discussões em curso, a <a href="/pt-PT/docs/MDN/Comunidade/Conversações">MDN tem a sua própria categoria ("MDN") , no fórum da Mozilla Discourse. </a>Utilize esta categoria para todos os tópicos relacionados com a MDN, incluindo a criação de conteúdo da documentação, tradução, e manutenção; desenvolvimento da plataforma MDN; planeamento, definição de metas, e acompanhamento do progresso.</p> + +<ul> + <li>Para aderir a Mozilla Discourse, consulte <a href="https://discourse.mozilla-community.org/t/signing-up-and-logging-in/16017">Registar e iniciar sessão</a> (EN); se tiver uma conta Mozilla LDAP, pode-a utilizar em vez de "Iniciar a sessão com e-mail".</li> + <li>Para subscrever a categoria da MDN, consulte <a href="https://discourse.mozilla-community.org/t/subscribing-to-categories-and-topics/16024">Subscrição de categorias e tópicos</a> (EN).</li> + <li>(Opcional) Se preferir interagir com <em>Discourse</em> principalmente por e-mail, consulte <a href="https://discourse.mozilla-community.org/t/mailman-mode/15279">Configurar uma lista de endereços para si mesmo</a>. Pode iniciar uma discussão em <em>Discourse, </em>enviando uma mensagem por e-mail para: <a href="mailto://mdn@mozilla-community.org">mdn@mozilla-community.org</a>. Se utilizar <em>Discourse</em> via e-mail, pode responder a uma mensagem, respondendo à mensagem de notificação que recebe. Se deseja interpolar comentários em linha dentro de uma resposta, por favor, coloque dois retornos antes e depois das suas partes em linha, e assim <em>Discourse</em> analisa-as corretamente.</li> +</ul> + +<h3 id="Arquivos_históricos">Arquivos históricos</h3> + +<p>Antes de junho de 2017, as discussões relacionadas com a MDN ocorriam nas listas de endereços que eram acedidas e arquivadas com os grupos Google. Se desejar pesquisar essas discussões anteriores, pode consultar os grupos Google correspondentes às listas de endereços antigas. (Sim, nós sabemos que esses nomes são sobrepostos e confusos. Acidente histórico. Desculpe por isso.)</p> + +<dl> + <dt><a href="https://groups.google.com/forum/#!forum/mozilla.dev.mdc">mozilla.dev.mdc</a> a.k.a. <strong>dev-mdc</strong></dt> + <dd>Esta lista era para discussões sobre conteúdo de documentação na MDN.</dd> + <dt><a href="https://groups.google.com/forum/#!forum/mozilla.dev.mdn">mozilla.dev.mdn </a>a.k.a. <strong>dev-mdn</strong></dt> + <dd>Esta lista era sobre o trabalho de desenvolvimento na plataforma subjacente <a href="/pt-PT/docs/MDN/Kuma">Kuma</a> da MDN.</dd> + <dt><a href="https://groups.google.com/forum/#!forum/mozilla.mdn">mozilla.mdn </a>a.k.a. <strong>mdn@</strong></dt> + <dd>Este fórum era para discussões de alto nível de planeamento e priorização, para o site da Web da MDN e outras iniciativas relacionadas.</dd> +</dl> + +<p> </p> + +<h2 id="Conversação_no_IRC">Conversação no IRC</h2> + +<p>Internet Relay Chat (IRC) is our preferred method for day-to-day chat and real-time discussions among community members. We use a few channels on the server irc.mozilla.org for discussions related to MDN.</p> + +<dl> + <dt><a href="irc://irc.mozilla.org/mdn" title="irc://irc.mozilla.org/mdn">#mdn</a></dt> + <dd>This channel is our primary channel for discussing the content of MDN. We talk about writing, organization of content, and so on. We also have "water cooler" conversations here—it's a way our community can keep in touch and just hang out. This is also the place to talk about other aspects of MDN (other than development of the platform), such as Demo Studio, profiles, and so on.</dd> + <dt><a href="irc://irc.mozilla.org/mdndev" title="irc://irc.mozilla.org/mdndev">#mdndev</a></dt> + <dd>This channel is where our development team—the people that write the code that makes MDN work—hangs out and discusses their day-to-day work. You're welcome to join in and either participate in the development or simply ask questions about issues you see with the software.</dd> +</dl> + +<p>Estes canais são mais prováveis de estarem ativos durante a semana na América do Norte.</p> + +<p>You may want to <a href="http://wiki.mozilla.org/IRC" title="http://wiki.mozilla.org/IRC">learn more about IRC</a> (EN) and use an installable IRC client such as <a href="https://addons.mozilla.org/pt-PT/firefox/addon/chatzilla/" title="https://addons.mozilla.org/en-US/firefox/addon/chatzilla/">ChatZilla</a> (PT). It is implemented as a Firefox add-on, which makes it quick and easy to install and use. If you're not familiar with IRC, an easy way to join is using a web-based IRC client such as <a href="http://web.scrollback.io/">Scrollback</a>, which is pre-configured with the <a href="http://scrollback.io/mozdn/">mdn</a> and <a href="http://scrollback.io/mdndev/">mdndev</a> channels.</p> + +<h2 id="Junte-se_aos_nossos_encontros_(e_outros_eventos)">Junte-se aos nossos encontros (e outros eventos)</h2> + +<p>A equipa da MDN realiza vários encontros regulares abertos para a comunidade MDN. Consulte a página de Encontros da MDN na <em>wiki</em> da Mozilla para obter detalhes dos agendamentos, agendas e notas, e informação sobre como participar.</p> + +<p>Consulte o calendário de <a href="https://calendar.google.com/calendar/embed?src=mozilla.com_2d35383434313235392d323530@resource.calendar.google.com" title="https://wiki.mozilla.org/MDN/Community_meetings">Eventos da MDN</a> (EN) para estes e outros encontros, local de encontros, e outros eventos.</p> + +<p>Se vir um encontro que ocorre no canal "mdn", no nosso sistema de videoconferência Vidyo, pode<a href="https://v.mozilla.com/flex.html?roomdirect.html&key=gMM1xZxpQgqiQFNkUR3eBuHgxg"> juntar-se à conversação na Web</a>.</p> diff --git a/files/pt-pt/mdn/comunidade/doc_sprints/index.html b/files/pt-pt/mdn/comunidade/doc_sprints/index.html new file mode 100644 index 0000000000..fcfaac9236 --- /dev/null +++ b/files/pt-pt/mdn/comunidade/doc_sprints/index.html @@ -0,0 +1,125 @@ +--- +title: Doc sprints +slug: MDN/Comunidade/Doc_sprints +tags: + - Comunidade + - Guía + - Metadados MDN +translation_of: MDN/Community/Doc_sprints +--- +<div>{{MDNSidebar}}</div> + +<p>{{ draft() }}</p> + +<div class="note"> +<p><strong>Nota: </strong>a comunidade da MDN realizou frequentemente <em>sprints</em> de documentação durante o período de 2010 a 2013. A partir de 2014, estes eventos foram ampliados para os eventos "<a href="https://blog.mozilla.org/community/2015/04/17/a-highly-productive-hack-on-mdn-weekend-in-berlin/">Hack na MDN</a>" que incluem <em>hacking</em> de código, bem como projetos de documentação. A maioria dos conselhos abaixo aplicam-se igualmente aos <em>sprints</em> de "Hack" e <em>sprints</em> de documentação.</p> +</div> + +<p><span class="seoSummary">Este é um guia para organizar um <em>sprint</em> de documentação. Este contém conselhos e dicas de pessoas que organizaram os <em>sprints</em> de documentos, para ajudá-lo a organizar um também. Este guia também se baseia nas idéias do livro</span><a class="external" href="http://write.flossmanuals.net/book-sprints/introduction/" rel="external" title="http://write.flossmanuals.net/book-sprints/introduction/">FLOSS Manuals Book Sprints</a>.</p> + +<h2 id="O_que_é_um_sprint_de_documento">O que é um <em>sprint</em> de documento?</h2> + +<p>A doc sprint is a short period when a group of people come together, virtually or actually, to collaborate on writing documentation on a given topic or related topics.</p> + +<h2 id="Tipos_de_sprints">Tipos de <em>sprints</em></h2> + +<p>Sprints can be virtual or in-person, or some combination. For a virtual sprint, everyone participates from wherever they happen to be located, communicating solely through mediated channels. For an in-person sprint, participants gather in the same location for the duration of the sprint, so that they can communicate face-to-face. Hybrid sprints can be mostly-in-person with some remote participants, or mostly-virtual with some local gatherings. In-person sprints require more logistical planning, to secure a meeting location, to get everybody there, and to house and feed them during the sprint.</p> + +<p>Another way to categorize sprints is by topical focus. For example, a sprint might focus on a particular subject area, such as Web development, or translation into a particular language.</p> + +<h2 id="Planear_um_sprint">Planear um <em>sprint</em></h2> + +<h3 id="Determinar_os_objetivos">Determinar os objetivos</h3> + +<p>Have a clear idea of what the goals are for the sprint, for both content and community. This helps drive your planning of lower-level details.</p> + +<ul> + <li>Do you want to document a particular topic area?</li> + <li>Do you want to create a particular type of documents or resources? For example, tutorials, code examples, or translations in a particular language.</li> + <li>Do you want to attract new people to contribute to MDN?</li> + <li>Do you want to increase cohesion among existing community members?</li> +</ul> + +<h3 id="Decidir_o_tipo_e_âmbito">Decidir o tipo e âmbito</h3> + +<p>Based on your goals, decide on the type of sprint (virtual, in-person, or combination) and the scope (what participants will focus on).</p> + +<p>For example, if you want to attract new community members, a local in-person sprint would be a good choice, because no travel is involved, but participants get to meet each other. If you want to focus on a specific subject area, where the content contributors are geographically distributed, and already know each other, then a virtual sprint may make sense.</p> + +<h3 id="Escolher_datas_e_horas">Escolher datas e horas</h3> + +<p>For in-person sprints that require travel, we've found that three days (such as two weekend days and a weekday) is enough time to get some significant work done, without taking too much time away from everyone's normal lives. For public, local, in-person sprints, one day is the most you can expect most people to commit. For virtual sprints, we typically run for two days: a weekday and a weekend day. As an alternative example, in the past there has been mini-sprint for writing and translating docs, every Wednesday evening in the Mozilla Paris office; it was primarily in-person for locals, but also got remote participation from Montreal (where it was at lunch time).</p> + +<p>Attaching a sprint to the end of a conference that everyone attended worked well; trying to run a sprint <em>during</em> a conference that everyone attended did not work so well. Make sure that participants know about the sprint when they make their conference plans, so that they allow extra days for the sprint.</p> + +<p>Consider the time zones that virtual participants are in; be sure that you allow enough working time in each time zone, and have some overlap when multiple zones (such as Europe and Americas, or Americas and Asia) are awake. However, it's just reality that no one time is good for everyone everywhere.</p> + +<p>For virtual sprints, the dates can be set as little as 2-3 weeks in advance. For in-person sprints, you need to decide further in advance, in order to allow time for people to decide and make travel arrangements.</p> + +<h3 id="Promoter_o_sprint">Promoter o <em>sprint</em></h3> + +<p>You can make the sprint open, and invite the world, but you should have a few key people that you know for sure will participate. Work with them when selecting dates, to ensure that they are available during the chosen dates. If the sprint is not open, then you need only extend invitations; make sure that each invitation is personal, explaining why that person has been specificallly invited.</p> + +<p>For public sprints, identify existing groups that have an interest in the topic, for example: local Web developer meetup groups for a local in-person sprint. Send an announcement through whatever channel is appropriate for that group. Be sure to provide a link to a web page with more details, and include a call-to-action for people to sign up for the sprint. <a href="https://www.eventbrite.com/" title="https://www.eventbrite.com/">Eventbrite </a>and <a href="http://lanyrd.com" title="http://lanyrd.com">Lanyrd</a> are two services that support sign-ups. For Mozilla developer events, we have found that about half the people who sign up actually show up.</p> + +<p>Use the social media channels that are appropriate to reach your target attendees. We have found that for Web developers, this means Twitter, followed by Google Plus, more than Facebook or LinkedIn. However, popular channels can vary geographically (such as Orkut in Brazil). Reach out to a few well-connected people who have a large following among your target audience, and ask them to re-share your posts.</p> + +<h3 id="Logística_para_sprints_em_pessoa">Logística para <em>sprints</em> em pessoa</h3> + +<p>Logistics for in-person sprints are greater for longer sprints and those where sprinters travel to attend. A short or locals-only sprint need relatively little logistical support.</p> + +<h4 id="Orçamento_e_financiamento">Orçamento e financiamento</h4> + +<p>You need to figure out how much the event is going to cost, and where the money is going to come from.</p> + +<p>Costs to consider in your budget include:</p> + +<ul> + <li>Travel</li> + <li>Lodging</li> + <li>Food</li> + <li>Meeting space</li> +</ul> + +<p>Some of these costs can be self-funded by participants, meaning that they pay for their own costs. There are a variety of ways to save money, which are mentioned in the following sections.</p> + +<p>It may be possible to get sponsorship from Mozilla to fund some of the costs of your event. It helps to have a clear focus for your event, and a specific plan and budget. If there is a <a href="https://reps.mozilla.org/people/#/">Mozilla Rep</a> in your area, work with them to request budget and swag through the Reps program. Otherwise, you can submit a <a href="https://bugzilla.mozilla.org/form.dev-engagement-event">developer events request</a> in Bugzilla.</p> + +<dl> + <dt>Ponto de encontro</dt> + <dd>There are lots of options for meeting space. If you are in a city with a Mozilla office, you can use the community space in that office. Elsewhere, options include meeting rooms in libraries, churches, coffee shops, or businesses where you have contacts. Many cities now have coworking spaces that rent their conference rooms for a reasonable fee.</dd> + <dt>Recursos</dt> + <dd>Be sure that your venue has good chairs and tables, and reliable power and Internet access. Sitting all day on a bad chair is not just uncomfortable; it can lead to injury. Make sure that the number of sprinters and their computers and devices does not overwhelm the power supply and available Internet bandwidth. Be generous (but not dangerous) with extension cords, and if necessary, international plug adapters. A projector for shared viewing can be very helpful. Whiteboards and sticky notes are great for brainstorming and planning.</dd> + <dt>Viagens</dt> + <dd>Travel is relevant only if the sprinters do not all live close to the sprint venue. The usual strategies for saving on travel apply, and are not specific to doc sprints.</dd> + <dt>Acomodação</dt> + <dd>Where sprinters stay should not be inconveniently far from the meeting venue. It can be cheaper (and possibly more fun) to split the cost of a vacation house or flat, rather than paying for individual hotel rooms. If you have a mix of visitors and (willing) locals, the visitors can stay in the homes of local community members.</dd> + <dt>Alimentação</dt> + <dd>Sprinters need to eat! Make arrangements for food during the sprint, and inform sprinters if certain meals will not be arranged. If the group is staying in a home, you can save money by buying and cooking food rather than going out to eat. Even if food is self-funded, it can reduce hassle to pitch into a common fund for food, rather than splitting every restaurant bill. If your venue allows, have snacks (some healthy and some not) available between meals.</dd> + <dt>Diversão</dt> + <dd>Make time for non-writing social activities. These can be informal, like going for a hike together, or more formal, like a tourist excursion. Going out for beer (at the end of the day, of course) is usually a winner. On the other hand, don't plan every hour of every day. Everybody needs some down time, especially introverts.</dd> +</dl> + +<h2 id="Durante_o_sprint">Durante o <em>sprint</em></h2> + +<h3 id="Planear_o_trabalho">Planear o trabalho</h3> + +<p> </p> + +<h3 id="Monitorizar_tarefas">Monitorizar tarefas</h3> + +<p>Have a way to track what tasks need to be worked on, who is doing what, and what has been completed. For MDN doc sprints, we use a wiki page for advance planning, and an etherpad for tracking work during the sprint.</p> + +<p>Often, people want to help but don't know where to start, and deciding among many options takes too much mental effort. For any given participant, give them a couple of possible tasks ("you could do A, or B"); this simplifies their choice, without making them feel like they're being bossed around.</p> + +<h3 id="Colaboração">Colaboração</h3> + +<p>One of the benefits of in-person sprints is that people can work together in ways that they might not be able to when they're not in the same place, for example, by working out ideas together on a whiteboard or by brainstorming with sticky notes. Still, there are opportunities for collaboration and camaraderie in any type of sprint. Chatting via IRC is essential for virtual sprints, and still very helpful for in-person sprints (for example, for sharing links). For a greater sense of "virtual presence", consider using a video conferencing service, such as Google Hangout.</p> + +<p>As an organizer, look for common interests among the participants and for ways that they can work together.</p> + +<h3 id="Celebrar_realizações">Celebrar realizações</h3> + +<p>Be sure to take time to celebrate accomplishments at the end of the sprint. This gives participants a better feeling than when the sprint just ends without any summary. If possible, have people "demo" what they have done, even if it is just showing a new article page.</p> + +<p>Also, share the sprint accomplishments via a blog post, to celebrate publicly as well. This is important for any kind of sprint, but especially for virtual sprints, where the participants might not all be online at the official end of the sprint for a wrap-up session.</p> diff --git a/files/pt-pt/mdn/comunidade/funcoes/index.html b/files/pt-pt/mdn/comunidade/funcoes/index.html new file mode 100644 index 0000000000..ea11472f80 --- /dev/null +++ b/files/pt-pt/mdn/comunidade/funcoes/index.html @@ -0,0 +1,12 @@ +--- +title: Funções da comunidade +slug: MDN/Comunidade/Funcoes +tags: + - Comunidade + - Landing + - Metadados MDN +translation_of: MDN/Community/Roles +--- +<div>{{MDNSidebar}}</div><p>Aqui tem algumas funções dentro da comunidade da MDN que têm responsabilidades específicas.</p> + +<p>{{LandingPageListSubPages()}}</p> diff --git a/files/pt-pt/mdn/comunidade/index.html b/files/pt-pt/mdn/comunidade/index.html new file mode 100644 index 0000000000..1969fd94e1 --- /dev/null +++ b/files/pt-pt/mdn/comunidade/index.html @@ -0,0 +1,56 @@ +--- +title: Aderir à Comunidade da MDN +slug: MDN/Comunidade +tags: + - Comunidade + - Guía + - Landing + - Metadados MDN +translation_of: MDN/Community +--- +<div>{{MDNSidebar}}</div> + +<div>{{IncludeSubnav("/pt-PT/docs/MDN")}}</div> + +<div class="summary"> +<p>Os <strong>Documentos da Web<em> </em>da MDN</strong> é mais do que uma <em>wiki</em>:</p> + +<p>É uma comunidade de programadores a trabalhar em conjunto para tornar a MDN num recurso marcante para os programadores que utilizam as tecnologias abertas da Web.</p> +</div> + +<p>Nós adoraríamos se contribuísse para a MDN, mas nós ainda iríamos adorar mais se participasse na comunidade da MDN. Aqui tem como ligar-se, em três passos fáceis:</p> + +<ol> + <li><a href="/pt-PT/docs/MDN/Contribute/Howto/Criar_uma_conta_MDN">Criar uma conta na MDN</a>.</li> + <li><a href="/pt-PT/docs/MDN/Comunidade/Conversações">Juntar-se às conversações</a>.</li> + <li><a href="/pt-PT/docs/MDN/Comunidade/O_que_está_a_acontecer">Seguir o que está a acontecer</a>.</li> +</ol> + +<h2 id="Como_é_que_a_comunidade_funciona">Como é que a comunidade funciona</h2> + +<p>O seguinte são mais artigos que descrevem a comunidade da MDN.</p> + +<div class="row topicpage-table"> +<div class="section"> +<dl> + <dt class="landingPageList"><a href="/pt-PT/docs/MDN/Comunidade/Funcoes">Regras da comunidade</a></dt> + <dd class="landingPageList">Há várias funções dentro da comunidade da MDN que possuem responsabilidades específicas.</dd> + <dt class="landingPageList"><em><a href="/pt-PT/docs/MDN/Comunidade/Doc_sprints">Doc sprints</a></em></dt> + <dd class="landingPageList">Este é um guia para organizar um <em>sprint</em> de documentação. Este contém conselhos e dicas de pessoas que organizaram <em>sprints</em> de documentos, para ajudá-lo a organizar um também.</dd> + <dt class="landingPageList"><a href="/pt-PT/docs/MDN/Comunidade/O_que_está_a_acontecer">Seguir o que está a acontecer</a></dt> + <dd class="landingPageList">A MDN é trazida para si pela <a class="external" href="https://wiki.mozilla.org/MDN">comunidade da Rede de Desenvolviemtno da Mozilla</a>. Aqui tem algumas maneiras, e assim nós partilhamos a informação sobre o que estamos a fazer.</dd> +</dl> + +<dl> +</dl> +</div> + +<div class="section"> +<dl> + <dt class="landingPageList"><a href="/pt-PT/docs/MDN/Comunidade/Conversações">Conversações da comunidade da MDN</a></dt> + <dd class="landingPageList">O "trabalho" da MDN acontece no site da MDN, mas a "comunidade" também acontece através de discussões (assíncronas) e conversação e reuniões on-line (síncrono).</dd> + <dt class="landingPageList"><a href="/pt-PT/docs/MDN/Comunidade/Trabalhar_em_comunidade">Trabalhar em comunidade</a></dt> + <dd class="landingPageList">Uma parte importante da contribuição para a documentação da MDN em qualquer escala significativa é saber como trabalhar como parte da comunidade da MDN. Este artigo oferece dicas para ajudá-lo a aproveitar ao máximo as interações com os outros escritores e com as equipas de desenvolvimento.</dd> +</dl> +</div> +</div> diff --git a/files/pt-pt/mdn/comunidade/o_que_está_a_acontecer/index.html b/files/pt-pt/mdn/comunidade/o_que_está_a_acontecer/index.html new file mode 100644 index 0000000000..6f53451020 --- /dev/null +++ b/files/pt-pt/mdn/comunidade/o_que_está_a_acontecer/index.html @@ -0,0 +1,42 @@ +--- +title: Seguir o que está a acontecer +slug: MDN/Comunidade/O_que_está_a_acontecer +tags: + - Comunidade + - Guia(2) + - Metadados MDN + - Principiante +translation_of: MDN/Community/Whats_happening +--- +<div>{{MDNSidebar}}</div><p>MDN is brought to you by the <a href="https://wiki.mozilla.org/MDN">Mozilla Developer Network community</a>. Here are some ways to that we share information about what we're doing.</p> + +<h2 id="Blogues">Blogues</h2> + +<dl> + <dt><a href="https://hacks.mozilla.org/" title="https://hacks.mozilla.org/">Mozilla Hacks</a></dt> + <dd>News about and in-depth coverage of Web and Mozilla technologies and features.</dd> + <dt><a href="https://blog.mozilla.org/community/category/developer-engagement/">Engaging Developers</a></dt> + <dd>Promoting activity and discussion amongst the community involved in MDN at Mozilla.</dd> +</dl> + +<h2 id="Emissões_de_ephemera">Emissões de ephemera</h2> + +<ul> + <li><a href="https://twitter.com/mozhacks" title="https://twitter.com/mozhacks"><span id="cke_bm_286S" style="display: none;"> </span></a><a href="http://twitter.com/MozDevNet">@MozDevNet</a>: Curated feed of new pages, significant updates, and other news about Mozilla Developer Network.</li> + <li><a href="https://twitter.com/mozhacks" title="https://twitter.com/mozhacks">@MozHacks</a>: Tweets about new web technologies, great HTML5 apps, and Firefox features.</li> + <li><a href="http://www.youtube.com/user/mozhacks" title="http://www.youtube.com/user/mozhacks">Mozilla Hacks (YouTube)</a></li> +</ul> + +<h2 id="Estado_das_informações_e_painéis">Estado das informações e painéis</h2> + +<p>The MDN documentation team maintains a <a href="https://trello.com/b/HAhl54zz/status">Trello board</a> on which our projects are tracked. This board is read-only but will let you see what's being worked on and what we hope to do soon, and may help you figure out where you can help. <a href="/en-US/docs/MDN/Contribute/Community/Trello">This article</a> explains how this board is used.</p> + +<p>In addtion, take a look at the <a href="/en-US/docs/MDN/Doc_status">Documentation status</a> pages to see what's going on across the full breadth of MDN content. You'll be able to see what articles need to be written or updated, what topics need the most help, and much, much more.</p> + +<h2 id="Encontros_da_MDN">Encontros da MDN</h2> + +<p>There are a number of regular meetings for tracking and sharing progress on various MDN-related projects and processes. These are described on the <a href="https://wiki.mozilla.org/MDN/Meetings">MDN meetings wiki page</a>.</p> + +<p>To get a general sense of what's happening, the best meeting to attend is the MDN Community meeting, which occurs every two weeks on Wednesdays, 10:00 US Pacific time (UTC-0800 October-March, UTC-0700 in March-October), in the <a href="irc://irc.mozilla.org/mdn" title="irc://irc.mozilla.org/devmo">#mdn</a> <a href="http://wiki.mozilla.org/IRC" title="http://wiki.mozilla.org/IRC">IRC</a> channel. See the <a href="https://wiki.mozilla.org/MDN/Meetings/Community" title="https://wiki.mozilla.org/MDN/Community_meetings">MDN community meetings</a> wiki page for agendas and notes from past meetings.</p> + +<p>The <a class="external text" href="https://www.google.com/calendar/embed?src=mozilla.com_2d35383434313235392d323530%40resource.calendar.google.com" rel="nofollow">Public MDN Events</a> calendar contains MDN community meetings, doc sprints, and other MDN-related events.</p> diff --git a/files/pt-pt/mdn/comunidade/trabalhar_em_comunidade/index.html b/files/pt-pt/mdn/comunidade/trabalhar_em_comunidade/index.html new file mode 100644 index 0000000000..f2c9116d03 --- /dev/null +++ b/files/pt-pt/mdn/comunidade/trabalhar_em_comunidade/index.html @@ -0,0 +1,102 @@ +--- +title: Trabalhar em comunidade +slug: MDN/Comunidade/Trabalhar_em_comunidade +translation_of: MDN/Community/Working_in_community +--- +<div>{{MDNSidebar}}</div> + +<p>TA major part of contributing to MDN documentation on any significant scale is knowing how to work as part of the MDN community. This article offers tips to help you make the most of your interactions with both other writers and with development teams.</p> + +<h2 id="Guias_gerais_de_etiqueta">Guias gerais de etiqueta</h2> + +<p>Here are some general guidelines for conduct when working in the Mozilla community.</p> + +<ul> + <li>Be polite! Even in disagreement, we all have the same mission: the betterment of the Web.</li> + <li>Ask, don't demand. People are far more likely to be helpful and responsive when you politely request help rather than demand it. While the documentation work is important, and our development community knows it, human instinct tends to cause people to be abrasive and difficult if you don't treat them with due respect.</li> + <li>Balance your need for information with the urgency of the documentation and the time the others in your discussion have to devote to helping you. Don't keep pushing for more and more details if it's not absolutely necessary right away, to the point of driving the others involved in the conversation crazy.</li> + <li>Keep in mind that your request takes valuable time from the people you're contacting, so be sure to use their time well.</li> + <li>Be considerate of cultural differences. Mozilla is a multinational and multicultural team, so when talking to someone whose culture is, or may be, different from your own, be sure to keep that in mind while communicating.</li> + <li>Start a new conversation instead of highjacking an existing conversation. Don't inject your questions into an unrelated conversation just because the people you need to talk to are paying attention to it. While convenient for you, this can irritate the people you're trying to talk to, and result in a less than ideal outcome.</li> + <li>Avoid {{interwiki("wikipedia", "bikeshedding")}}. Don't let your enthusiasm become annoying pedantry. It makes conversations cumbersome and unfocused.</li> +</ul> + +<h2 id="Seja_delicado">Seja delicado</h2> + +<p>Always be tactful and respectful when communicating with others.</p> + +<h3 id="Politely_pointing_out_mistakes">Politely pointing out mistakes</h3> + +<p>If your purpose in contacting someone is to ask them to do something differently, or to point out a mistake they've been making (especially if they repeatedly do it), start your message with a positive comment. This softens the blow, so to speak, and it demonstrates that you're trying to be helpful, rather than setting you up as the bad guy.</p> + +<p>For example, if a new contributor has been creating lots of pages without tags, and you'd like to point out this problem, your message to them might look like this (the stuff you'd need to change for each case us underlined):</p> + +<blockquote> +<p>Hi, <u>MrBigglesworth</u>, I've been noticing your contributions to <u>the Wormhole API documentation</u>, and it's fantastic to have your help! I particularly like <u>the way you balanced your level of detail with readability</u>. That said, though, you could make these articles even better and more helpful if you <u>added the correct tags to the pages</u> as you go.</p> + +<p><u>See the MDN tagging guide (https://developer.mozilla.org/en-US/docs/MDN/Contribute/Howto/Tag) for details.</u></p> + +<p>Thanks again, and I look forward to your future contributions!</p> +</blockquote> + +<h2 id="Partilhar_conhecimento">Partilhar conhecimento</h2> + +<p>As you participate in the MDN project, it's useful to know what's going on, and to interact with other members of our community. By talking with others in our community, you can get—and share—ideas, status updates, and more. We also have tools and informational resources that can help you know what's being done, by whom.</p> + +<h3 id="Communication_channels">Communication channels</h3> + +<p>There are several ways you can engage with community members (either developers or writers), each of which has some of its own particular rules of etiquette.</p> + +<h4 id="Bugzilla">Bugzilla</h4> + +<p>When writing documentation to cover changes implemented as a result of a bug in Bugzilla, you'll often interact with people involved in those bugs. Be sure to keep the <a href="https://bugzilla.mozilla.org/page.cgi?id=etiquette.html" title="https://bugzilla.mozilla.org/page.cgi?id=etiquette.html">Bugzilla Etiquette</a> guide in mind at all times!</p> + +<h4 id="Correio_eletrónico">Correio eletrónico</h4> + +<p>Sometimes, a private email exchange between you and one or more other people is the way to go, if you have their email address.</p> + +<div class="note"> +<p><strong>Note:</strong> As a general rule, if someone has posted their email address on documents about the technology you're documenting, has given you their email address personally, or generally has a well-known email address, email is an acceptable "first contact" approach. If you have to dig for it, you probably should try to get permission in IRC or a mailing list first, unless you've exhausted all other attempts at getting in touch.</p> +</div> + +<h3 id="Ferramentas_de_estado_de_conteúdo">Ferramentas de estado de conteúdo</h3> + +<p>We have several useful tools that provide information about the status of documentation content.</p> + +<dl> + <dt><a href="/dashboards/revisions">Revision dashboard</a></dt> + <dd>The revision dashboard provides a fantastic tool to review changes made to MDN content. You can see recent history, choose a range of time to view, and filter based on things like locale, contributor's name, and topic. Once you're looking at a set of revisions, you can view the changes made in each revision, quickly open the page, see a full history, or even revert the changes (if you have those privileges).</dd> + <dt><a href="https://developer.mozilla.org/en-US/docs/MDN/Doc_status/Overview">Documentation status overview</a></dt> + <dd>Our <a href="https://developer.mozilla.org/en-US/docs/MDN/Doc_status/Overview">documentation status overview</a> page provides a list of all the areas of MDN that have been configured for status tracking, with information about how many pages therein need different types of work done. Click through to a particular topic area to see detailed lists of content that needs work, such as pages that have no tags, or are tagged with indicators that certain types of work need to be done. You can even see lists of pages that haven't been updated in a long time and may be out of date, as well as a list of bugs that have been flagged as impacting the documentation in that area.</dd> + <dt><a href="/en-US/docs/MDN/Plans">Documentation project plans</a></dt> + <dd>We have a number of writing projects that are in the planning stages, or are large and ongoing, for which we have written planning documents to help us keep track of what we need to get done.</dd> + <dt><a href="https://tree.taiga.io/project/viya-mdn-durable-team">MDN Taiga</a></dt> + <dd>The MDN staff writers use a tool called Taiga to manage current and future documentation projects. You can take a look to see what we're doing and how it's going, and you can see what projects we'd like to see happen soon. Some of those will be taken on by staff writers, but you should feel free to take one over if you like! For more information about the agile processes followed by the MDN team, see our <a href="https://wiki.mozilla.org/Engagement/MDN_Durable_Team/Processes">Process page on the Mozilla wiki</a>.</dd> +</dl> + +<h2 id="A_comunidade_de_desenvolvimento">A comunidade de desenvolvimento</h2> + +<p>Possibly the most important relationships to develop and maintain, as a member of the MDN writing community, are those you develop and sustain with the developers. They create the software we're developing, but they're also the most useful source of information we have. It's crucial that we maintain good relations with developers—the more they like you, the more likely they are to answer your questions quickly, accurately, and thoroughly!</p> + +<p>In addition, you represent the MDN writing community. Please help ensure we keep our excellent working relationship with the dev team by making every interaction they have with the writing team be a good one.</p> + +<p>On a related note, a great way to find the right person to talk to is to look at the <a href="https://wiki.mozilla.org/Modules">module owners lists</a>.</p> + +<h2 id="A_comunidade_de_escrita">A comunidade de escrita</h2> + +<p>The writing community is a large one. While the number of extremely frequent, or large-scale contributors is relatively small, there are many dozens or hundreds of people who contribute at least now and then. Fortunately, these are by and large awesome people with a genuine love of the Web, Mozilla, and/or documentation, and interacting with them is almost always pretty easy.</p> + +<p>See the article <a href="/en-US/docs/MDN/Community" title="/en-US/docs/Project:MDN/Contributing/Join_the_community">Join the community</a> for more information about the MDN community.</p> + +<p>The most frequent place you'll directly interact with other writers is in the {{IRCLink("mdn")}} channel on IRC. This channel is specifically reserved for discussing documentation. For IRC-specific etiquette tips, see the Mozilla Support article "<a href="https://quality.mozilla.org/docs/misc/getting-started-with-irc/" title="https://quality.mozilla.org/docs/misc/getting-started-with-irc/">Getting Started with IRC</a>." You'll also have discussions with us on the <a href="https://discourse.mozilla-community.org/c/mdn">MDN discussion forum</a>. In general, IRC tends to be used for quick, more in-person-like discussions, while the discussion forum is typically used for longer-duration conversation.</p> + +<p>By keeping in mind the {{anch("General etiquette guidelines")}}, you'll find that usually things go very smoothly.</p> + +<h2 id="Consultar_também">Consultar também</h2> + +<ul> + <li><a href="/en-US/docs/Project:MDN/Contributing" title="/en-US/docs/Project:MDN/Contributing">Contributing to MDN</a></li> + <li><a href="/en-US/docs/Project:MDN/Contributing/Join_the_community" title="/en-US/docs/Project:MDN/Contributing/Join_the_community">MDN community</a></li> + <li><a href="http://matt.might.net/articles/how-to-email/" title="http://matt.might.net/articles/how-to-email/">How to send and reply to email</a></li> + <li><a href="http://blog.gerv.net/2012/10/how-to-be-a-mozillia/">How to be a Mozillian</a></li> +</ul> diff --git a/files/pt-pt/mdn/contribute/feedback/index.html b/files/pt-pt/mdn/contribute/feedback/index.html new file mode 100644 index 0000000000..a4e88f36f8 --- /dev/null +++ b/files/pt-pt/mdn/contribute/feedback/index.html @@ -0,0 +1,59 @@ +--- +title: Enviar opinião sobre a MDN +slug: MDN/Contribute/Feedback +tags: + - Documentação + - Guía + - MDN + - Metadados MDN +translation_of: MDN/Contribute/Feedback +--- +<div>{{MDNSidebar}}</div> + +<div>{{IncludeSubnav("/pt-PT/docs/MDN")}}</div> + +<p>Bem-vindo à MDN! Se tiver sugestões, ou tiver problemas ao utilizar a MDN, este é o lugar certo para estar. O simples facto de estar interessado em oferecer a sua opinião/comentário faz com que faça parte da comunidade da Mozilla e nós agradecemos antecipadamente pelo seu interesse.</p> + +<p>Tem várias opções para oferecer a sua visão; este artigo irá ajudá-lo a fazer isso.</p> + +<h2 id="Atualizar_a_documentação">Atualizar a documentação</h2> + +<p>First of all, if you've seen a problem with the documentation, you should always feel free to correct it yourself. Simply <a href="/en-US/docs/MDN/Contribute/Howto/Create_an_MDN_account">sign in</a> using <a href="https://github.com/">Github</a>, then click any blue <strong>Edit</strong> button to open the <a href="/en-US/docs/MDN/Contribute/Editor">editor</a> and enter the world of contributing to MDN documentation. The documentation here is in a wiki, and is curated by a team of volunteers and paid staff, so don't be shy—your grammar doesn't have to be perfect. We'll clean it up if you make a mistake; no harm done!</p> + +<p>Para mais informação sobre a contribuição para a documentação da MDN, consulte:</p> + +<ul> + <li><a href="/pt-PT/docs/MDN/Intrudu%C3%A7%C3%A3o" title="/en-US/docs/Project:Getting_started">Iniciação na MDN</a></li> + <li><a href="/pt-PT/docs/MDN/Contribute">Contribuir para a MDN</a></li> + <li><a href="/pt-PT/docs/MDN/Contribute/Editor" title="/en-US/docs/Project:MDN_editing_interface">A interface de edição da MDN</a></li> +</ul> + +<h2 id="Junte-se_à_conversação">Junte-se à conversação</h2> + +<p>Fale connosco! Existem algumas maneiras para entrar em contacto com outras pessoas que trabalham com conteúdo na MDN.</p> + +<h3 id="Conversação_Síncrono">Conversação (Síncrono)</h3> + +<p> + </p><h3 id="Discussões_Assíncrono">Discussões (Assíncrono)</h3> + + +<p>Longer-term discussions happen on our <a href="https://discourse.mozilla-community.org/c/mdn">MDN discussion forum</a>. You can post to the forum via email to <a href="mailto://mdn@mozilla-community.org">mdn@mozilla-community.org</a>. If you join the forum, you can choose to have notifications about discussions sent to you via email as well.</p> + +<h2 id="Comunicar_um_problema">Comunicar um problema</h2> + +<h3 id="Problemas_na_documentação">Problemas na documentação</h3> + +<p>Se encontrar um problema na documentação e não conseguir corrigí-lo por qualquer motivo, poderá <a href="https://github.com/mdn/sprints/issues/new?template=issue-template.md&projects=mdn/sprints/2&labels=user-report">comunicar o problema</a>! Pode utilziar este formulário para qualquer problema da documentação, por exemplo:</p> + +<ul> + <li>uma correção simples</li> + <li>um pedido para uma parte completa de conteúdo</li> + <li>comunicar conteúdo inapropriado (incluindo "spam" e traduções erradas)</li> +</ul> + +<p>Como mencionado anteriormente, nós convidamo-lo para contribuir com as suas alterações, mas esta opção também está disponível para si.</p> + +<h3 id="Problemas_no_site">Problemas no site</h3> + +<p>Se encontrar problemas com o site da <em>Web</em> da MDN, ou tiver ideias para novas características para o site, pode <a href="https://bugzilla.mozilla.org/form.mdn">submeter um pedido à equipa de desenvolvimento da MDN</a>.</p> diff --git a/files/pt-pt/mdn/contribute/getting_started/index.html b/files/pt-pt/mdn/contribute/getting_started/index.html new file mode 100644 index 0000000000..315613f49c --- /dev/null +++ b/files/pt-pt/mdn/contribute/getting_started/index.html @@ -0,0 +1,116 @@ +--- +title: Iniciação na MDN +slug: MDN/Contribute/Getting_started +tags: + - Beginner + - Guía + - Iniciação + - Introdução + - Metadados MDN +translation_of: MDN/Contribute/Getting_started +--- +<div> +<div>{{MDNSidebar}}</div> +</div> + +<p><span class="seoSummary">Nós somos uma comunidade aberta de programadores e autores que criam recursos para uma Web melhor, independentemente da marca, navegador, ou plataforma. Qualquer pessoa pode contribuir e cada uma que o faz, torna-nos mais fortes. Juntos, nós podemos continuar a inovar na Web para o bem de todos. Isso começa aqui, consigo.</span></p> + +<p>Cada parte da MDN (desde o site até à documentação, amostras de código, e demonstrações) é criada por uma comunidade de programadores e autores. Por favor considere colaborar também!</p> + +<h2 id="3_passos_simples_para_a_MDN"><span>3 passos simples para a MDN</span></h2> + +<div class="pt" id="OutputArea" style="direction: ltr; text-align: left;"> +<div class="Wrap" id="OutputText" style="direction: ltr; text-align: left;"> +<div><span id="noHighlight_0.47920148300743626">A MDN </span><span id="ouHighlight__4_5TO4_4">é</span><span id="noHighlight_0.5491344717821757"> </span><span id="ouHighlight__7_7TO6_7">uma</span><span id="noHighlight_0.8750513674493037"> </span><em><span id="ouHighlight__9_12TO9_12">wiki</span></em><span id="noHighlight_0.7850095290312931">,</span><span id="noHighlight_0.5182284369975565"> </span><span id="ouHighlight__15_19TO15_18">onde</span><span id="noHighlight_0.018006826884430893"> </span><strong><span id="ouHighlight__21_26TO20_34">qualquer pessoa</span></strong><span id="noHighlight_0.4040337194597289"> </span><span id="ouHighlight__28_30TO36_39">pode</span><span id="noHighlight_0.9747336392889395"> </span><span id="ouHighlight__32_34TO41_49">adicionar</span><span id="noHighlight_0.7066487403238145"> </span><span id="ouHighlight__36_38TO51_51">e</span><span id="noHighlight_0.5446518252479879"> </span><span id="ouHighlight__40_43TO53_58">editar</span><span id="noHighlight_0.6426048314610565"> </span><span id="ouHighlight__45_51TO60_67">conteúdo</span><span id="noHighlight_0.8453660300988101">.</span><span id="noHighlight_0.055925875247653134"> </span><span id="ouHighlight__54_56TO70_73">N</span><span id="ouHighlight__58_62TO75_77">ão</span><span id="noHighlight_0.8092718734331236"> </span><span id="ouHighlight__64_70TO79_85">precisa</span><span id="noHighlight_0.22724740936320986"> de </span><span id="ouHighlight__72_73TO87_89">ser</span><span id="noHighlight_0.1843562915821374"> </span><span id="ouHighlight__75_75TO91_92">um</span><span id="noHighlight_0.3592619006001544"> </span><span id="ouHighlight__77_86TO94_104">programador</span><span id="noHighlight_0.285547875523669"> </span><span id="ouHighlight__88_89TO106_107">ou</span><span id="noHighlight_0.9061669056755919"> </span><span id="ouHighlight__91_94TO109_112">saber</span><span id="noHighlight_0.19684376567211204"> </span><span id="ouHighlight__98_100TO114_118">muito</span><span id="noHighlight_0.5675302021548134"> </span><span id="ouHighlight__102_106TO120_124">sobre</span><span id="noHighlight_0.11138225174850647"> </span><span id="ouHighlight__108_119TO126_136">tecnologia</span><span id="noHighlight_0.8834602769538198">.</span><span id="noHighlight_0.28454983315849447"> </span><span id="ouHighlight__122_130TO139_145">Existem várias</span><span id="noHighlight_0.8598458374371334"> </span><span id="ouHighlight__142_147TO154_159">coisas</span><span id="noHighlight_0.34892750513629345"> </span><span id="ouHighlight__149_152TO161_163">que</span><span id="noHighlight_0.9874443798556571"> </span><span id="ouHighlight__154_160TO165_172">precisam</span><span id="noHighlight_0.34244235656099486"> </span><span id="ouHighlight__162_163TO174_176">ser</span><span id="noHighlight_0.25841029026007567"> </span><span id="ouHighlight__165_168TO178_183">feitas</span><span id="noHighlight_0.32790348607369335">,</span><span id="noHighlight_0.0754749662753087"> </span><span id="ouHighlight__171_174TO186_187">desde</span><span id="noHighlight_0.45034184896804075"> </span><span id="ouHighlight__183_187TO189_195">tarefas</span><span id="noHighlight_0.889982282033675"> </span><span id="ouHighlight__176_181TO197_203">simples</span><span id="noHighlight_0.874949287144007">, tal como a </span><span id="noHighlight_0.17301975604090902">revisão de </span><span id="ouHighlight__197_208TO221_226">textos</span><span id="noHighlight_0.6149690455375806"> </span><span id="ouHighlight__210_212TO228_228">e</span><span id="noHighlight_0.9289231957504542"> </span><span id="ouHighlight__214_223TO230_239">correção de</span><span id="noHighlight_0.5040134767190689"> </span><span id="ouHighlight__225_229TO241_258">erros ortográficos</span><span id="noHighlight_0.5764830231422348"> até </span><span id="ouHighlight__231_232TO260_261">às</span><span id="noHighlight_0.31222671666655055"> mais </span><span id="ouHighlight__238_244TO263_271">complexas,</span><span id="noHighlight_0.14560557587044287"> </span><span id="ouHighlight__251_257TO273_281">tal como</span><span id="noHighlight_0.2685463990562986"> </span><span id="ouHighlight__259_265TO283_290">escrever</span><span id="noHighlight_0.19633858312747077"> </span><span id="ouHighlight__271_283TO292_303">documentação</span><span id="noHighlight_0.9021550954525854"> </span><span id="ouHighlight__267_269TO308_310">API</span><span id="noHighlight_0.34762725714498666">.</span></div> + +<div></div> +</div> +</div> + +<div class="pt" id="OutputArea" style="direction: ltr; text-align: left;"> +<div class="Wrap" id="OutputText" style="direction: ltr; text-align: left;"> +<div><span id="noHighlight_0.6939304266497809">Contribuir </span><span id="ouHighlight__13_14TO11_11">é</span><span id="noHighlight_0.754432452620986"> </span><span id="ouHighlight__16_19TO13_17">fácil</span><span id="noHighlight_0.12677613373170482"> </span><span id="ouHighlight__21_23TO19_19">e</span><span id="noHighlight_0.9169567677650025"> </span><span id="ouHighlight__25_28TO21_26">seguro</span><span id="noHighlight_0.35895146514742815">.</span><span id="noHighlight_0.11298517990296342"> </span><span id="ouHighlight__31_34TO29_33">Mesmo</span><span id="noHighlight_0.22314055925593745"> </span><span id="ouHighlight__36_37TO35_36">que cometa um erro</span><span id="noHighlight_0.4559037862176293">,</span><span id="ouHighlight__59_62TO60_64"> este é facilmente corrigido</span><span id="ouHighlight__76_76TO81_81">.</span><span id="noHighlight_0.40627264171417155"> </span><span id="ouHighlight__78_79TO83_84">Se</span><span id="noHighlight_0.2985670129310918"> não sabe ao certo qual deverá ser o aspeto final </span><span id="ouHighlight__128_129TO139_140">ou o seu vocabulário não é o mais rico</span><span id="noHighlight_0.5033058561197279">,</span><span id="noHighlight_0.03342360750842488"> </span><span id="ouHighlight__166_170TO171_173">não</span><span id="noHighlight_0.8750742285474321"> se </span><span id="ouHighlight__172_182TO178_185">preocupe</span><span id="noHighlight_0.14456605310738102">!</span><span id="noHighlight_0.7159356526709744"> </span><span id="ouHighlight__188_194TO188_192">Nós temos</span><span id="noHighlight_0.8891478782467954"> </span><span id="ouHighlight__196_196TO194_196">uma</span><span id="noHighlight_0.34570799241183214"> </span><span id="ouHighlight__198_201TO198_203">equipa</span><span id="noHighlight_0.4175451730392493"> </span><span id="ouHighlight__203_204TO205_206">de</span><span id="noHighlight_0.8630305052430338"> </span><span id="ouHighlight__206_211TO208_214">pessoas</span><span id="noHighlight_0.91504254606562"> </span><span id="ouHighlight__213_217TO216_219">cujo</span><span id="noHighlight_0.8103854016751867"> </span><span id="ouHighlight__219_221TO221_228">trabalho</span><span id="noHighlight_0.65601862530836"> </span><span id="ouHighlight__226_227TO230_230">é</span><span id="noHighlight_0.5841048903172054"> </span><span id="ouHighlight__232_235TO232_234">ter</span><span id="noHighlight_0.28754000201425867"> </span><span id="ouHighlight__229_230TO236_236">a</span><span id="noHighlight_0.8118269900735291"> </span><span id="ouHighlight__237_240TO238_244">certeza</span><span id="noHighlight_0.708513780871264"> de </span><span id="ouHighlight__242_245TO249_251">que</span><span id="noHighlight_0.9875258576783718"> o </span><span id="ouHighlight__253_260TO255_262">conteúdo</span><span id="noHighlight_0.22787459205105864"> </span><span id="ouHighlight__247_251TO264_269">da MDN</span><span id="noHighlight_0.32694403655209914"> </span><span id="ouHighlight__262_264TO271_271">é</span><span id="noHighlight_0.43821525588932086"> </span><span id="ouHighlight__266_267TO273_275">tão</span><span id="noHighlight_0.37403813332407077"> </span><span id="ouHighlight__269_272TO277_279">bom</span><span id="noHighlight_0.38391309247561567"> </span><span id="ouHighlight__274_275TO281_286">quanto</span><span id="noHighlight_0.03257742151312082"> </span><span id="ouHighlight__277_284TO288_295">possível</span><span id="noHighlight_0.10488359575747619">.</span><span id="noHighlight_0.7375956492335589"> </span><span id="ouHighlight__287_293TO298_303">Alguém</span><span id="noHighlight_0.7339586828005976"> </span><span id="ouHighlight__312_320TO310_319">certificar</span><span id="noHighlight_0.7685186939234422">-se-á de que o </span><span id="ouHighlight__322_325TO331_333">seu</span><span id="noHighlight_0.2158936316841401"> </span><span id="ouHighlight__327_330TO335_342">trabalho</span><span id="noHighlight_0.44200265413885365"> </span><span id="ouHighlight__332_333TO344_344">está</span><span id="noHighlight_0.7824145304173619"> </span><span id="ouHighlight__335_338TO346_353">conciso</span><span id="noHighlight_0.8205113491988623"> </span><span id="ouHighlight__340_342TO355_355">e</span><span id="noHighlight_0.2967837506349432"> </span><span id="ouHighlight__344_355TO357_367">bem escrito</span><span id="noHighlight_0.1417488745865505">.</span><span id="noHighlight_0.7186922743172103"> P</span><span id="ouHighlight__358_362TO370_381">artilhe</span><span id="noHighlight_0.31150297125971427"> </span><span id="ouHighlight__364_367TO383_387">o que</span><span id="noHighlight_0.25179450598587694"> </span><span id="ouHighlight__373_376TO389_392">sabe</span><span id="noHighlight_0.4558381673714762">,</span><span id="noHighlight_0.6630645323624911"> </span><span id="ouHighlight__382_387TO396_399">siga o seu instinto </span><span id="noHighlight_0.16705133535882088"> </span><span id="ouHighlight__405_407TO420_420">e</span><span id="noHighlight_0.7738893383584872"> </span><span id="ouHighlight__409_413TO422_428">confie</span><span id="noHighlight_0.8909652779069059"> </span><span id="ouHighlight__415_416TO430_431">no</span><span id="noHighlight_0.047160979487215204"> </span><span id="ouHighlight__422_425TO433_437">resto</span><span id="noHighlight_0.3498706762716407"> </span><span id="ouHighlight__427_428TO439_440">da</span><span id="noHighlight_0.4435827843376339"> </span><span id="ouHighlight__430_442TO442_451">comunidade</span><span id="noHighlight_0.423638827999702"> para o ajudar a melhorar o seu trabalho.</span></div> +</div> +</div> + +<h3 id="Passo_1_Criar_uma_conta_na_MDN">Passo 1: Criar uma conta na MDN</h3> + +<p>Para começar a contribuir na MDN precisa de ter uma conta na MDN. Para mais detalhes, por favor, consulte <a href="/pt-PT/docs/MDN/Contribute/Howto/Criar_uma_conta_MDN">como criar uma conta</a>.</p> + +<h3 id="Passo_2_Escolher_uma_tarefa">Passo 2: Escolher uma tarefa</h3> + +<div class="pt" id="OutputArea" style="direction: ltr; text-align: left;"> +<div class="Wrap" id="OutputText" style="direction: ltr; text-align: left;"> +<div><span id="ouHighlight__4_7TO6_8">Agora que</span><span id="noHighlight_0.7397612230677483"> </span><span id="noHighlight_0.8224719251874061">iniciou a sessão</span><span id="noHighlight_0.07721447543089255">,</span><span id="noHighlight_0.20180178040099794"> </span><span id="ouHighlight__28_31TO28_31">leia</span><span id="noHighlight_0.1347259088605407"> </span><span id="ouHighlight__33_35TO33_34">as</span><span id="noHighlight_0.1550906597924332"> </span><span id="ouHighlight__37_48TO36_45">descrições</span><span id="noHighlight_0.5936187806451623"> </span><span id="ouHighlight__50_51TO47_49">das</span><span id="ouHighlight__68_72TO51_55"> tarefas diferentes </span><span>em</span><span id="noHighlight_0.9921036450111824"> </span>{{anch("Tarefas disponíveis", "a lista abaixo")}},<span id="noHighlight_0.3056672720834265"> </span><span id="ouHighlight__128_130TO136_136">e</span><span id="noHighlight_0.644837387548433"> </span><span id="ouHighlight__132_137TO138_144">decid</span><span id="ouHighlight__154_160TO166_171">a qual é a mais apelativa para si</span><span id="noHighlight_0.34950865963617184">.</span><span id="noHighlight_0.23952518307785142"> </span><span id="ouHighlight__170_172TO174_177">Pode</span><span id="noHighlight_0.4532969186995154"> </span><span id="ouHighlight__178_181TO184_191">escolher</span><span id="noHighlight_0.31003284659874975"> </span><span id="ouHighlight__183_185TO193_200">qualquer</span><span id="noHighlight_0.17357587947915787"> </span><span id="ouHighlight__187_190TO202_207">tarefa que lhe agrade e comece a contribuir</span><span id="noHighlight_0.470803195280464">.</span></div> +</div> +</div> + +<h3 id="Passo_3_Executar_a_tarefa">Passo 3: Executar a tarefa</h3> + +<p>Assim que decidir que tarefa é que pretende fazer, procure uma página específica, exemplo de código, etc., para trabalhar, e comece!</p> + +<p>Não se preocupe em ser perfecionista; outros colaboradores da MDN estão aqui para ajudar a corrigir eventuais erros. Para quem quiser experimentar com a edição na MDN antes de fazer algo "a sério", nós temos a página <em><strong><a href="/en-US/docs/Sandbox">Sandbox</a></strong></em> onde poderá testar livremente. Se entretanto tiver dúvidas, consulte a página da <a href="/en-US/docs/MDN/Community">Comunidade</a> para informação sobre contactos e canais de conversação onde poderá obter as suas respostas.</p> + +<p>Quando tiver terminado a tarefa escolhida, sinta-se livre para escolher outro item, ou consulte abaixo <a href="#Other_things_you_can_do_on_MDN">outras coisas que pode fazer na MDN.</a></p> + +<h2 id="Tarefas_disponíveis">Tarefas disponíveis</h2> + +<p>Existem várias formas possíveis para que possa contribuir para a MDN, dependendo do seu conjunto de habilidades e interesses. Mesmo que algumas tarefas possam ser assustadoras, nós temos muitas atividades simples disponíveis. Algumas delas apenas precisam de cinco minutos (ou menos!) do seu tempo. Abaixo, com a tarefa e respetiva breve descrição, encontrará o tempo aproximado que cada tarefa normalmente demora.</p> + +<h3 id="Opção_1_Eu_gosto_de_palavras">Opção 1: Eu gosto de palavras</h3> + +<p>Pode ajudar-nos a rever ou a editar documentos existentes, e aplicar as etiquetas corretas para os mesmos.</p> + +<ul> + <li><a href="/pt-PT/docs/MDN/Contribute/Howto/Como_definir_o_resumo_para_uma_pagina">Definir o resumo para uma página </a>(5 a 15 minutos)</li> + <li><a href="/pt-PT/docs/MDN/Contribute/Howto/fazer_revisão_editorial">Efetuar revisões editoriais</a> (5 a 30 minutos)</li> + <li><a href="/pt-PT/docs/MDN/Contribute/Howto/Como_escrever_uma_nova_entrada_no_Glossario">Escrever uma nova entrada no Glossário </a>(15 minutos a 1 hora)</li> + <li><a href="/pt-PT/docs/MDN/Contribute/Howto/Como_escrever_um_artigo_para_ajudar_as_pessoas_a_aprenderem_sobre_a_Web">Como escrever um artigo para ajudar as pessoas a aprenderem sobre a Web</a> (1 a 3 horas)</li> +</ul> + +<div class="note"><strong>Nota</strong>: se estiver a rever ou a escrever novos artigos, nós pedimos-lhe para, por favor, rever o '<a href="/pt-PT/docs/MDN/Contribute/linhas_diretrizes/Guia_de_estilo_de_escrita">Guia de Estilo</a>'. Isto irá ajudar a assegurar que os artigos sejam consistentes.</div> + +<h3 id="Opção_2_Eu_gosto_de_código">Opção 2: Eu gosto de código</h3> + +<p>Nós precisamos de mais exemplos de código! Também pode ajudar a criar a plataforma do nosso site, <a href="/en-US/docs/MDN/Kuma">Kuma</a>!</p> + +<ul> + <li><a href="/pt-PT/docs/MDN/Contribute/Howto/Como_converter_exemplos_de_codigo_para_ficarem_live">Converter exemplos de código para ficarem <em>live</em></a> (30 minutos)</li> + <li><a href="https://wiki.mozilla.org/Webdev/GetInvolved/developer.mozilla.org">Read the Getting Involved Guide</a> (30 minutes)</li> + <li><a href="http://kuma.readthedocs.org/en/latest/installation.html">Set up a Kuma build environment</a> (1 hour)</li> + <li><a href="https://github.com/mozilla/kuma#readme">Send your code patch to the Kuma codebase</a> (1 hour)</li> +</ul> + +<h3 id="Opção_3_Eu_gosto_de_palavras_e_código">Opção 3: Eu gosto de palavras e código</h3> + +<p>Nós temos tarefas que requerem competências técnicas e linguísticas, tais como escrever novos artigos, rever para uma correção técnica, ou adaptar documentos.</p> + +<ul> + <li><a href="/en-US/docs/MDN/Contribute/Howto/Tag_JavaScript_pages">Marcar páginas de JavaScript</a> (5 minutos)</li> + <li><a href="/en-US/docs/MDN/About/Promote">Promover a MDN na sua própria página web</a> (5 minutos)</li> + <li><a href="/en-US/docs/MDN/Contribute/Howto/Do_a_technical_review">Revisões técnicas</a> (30 minutos)</li> + <li><a href="/en-US/docs/MDN/Contribute/Howto/Create_and_edit_pages">Escrever um novo artigo sobre um tema com o qual se sente familiarizado</a> (1 hora ou mais)</li> + <li><a href="/en-US/docs/MDN/Contribute/Howto/Create_an_interactive_exercise_to_help_learning_the_web">Criar um exercício interativo para ajudar as pessoas a aprender sobre a web</a> (1 hora ou mais)</li> + <li><a href="/en-US/docs/MDN/Contribute/Howto/Resolve_a_mentored_developer_doc_request">Corrigir um erro de documentação</a> na <a href="http://www.joshmatthews.net/bugsahoy/?mdn=1">Categoria MDN do Bugs Ahoy</a> (1 hora ou mais)</li> +</ul> + +<h3 id="Opção_4_Eu_quero_a_MDN_no_meu_idioma">Opção 4: Eu quero a MDN no meu idioma</h3> + +<p>Todo o trabalho de localização e tradução feito na MDN é elaborado pela nossa incrível comunidade de voluntários.</p> + +<ul> + <li><a href="/pt-PT/docs/MDN/Contribute/Localize/Translating_pages">Traduzir páginas</a> (2 horas) (Ver <a href="/pt-PT/docs/MDN/Doc_status/l10nPrioridade">prioridades de topo</a>)</li> + <li>Interligar com outros localizadores listados nos <a href="/pt-PT/docs/MDN/Contribute/Localize/Projetos_localização">Projetos de Localização</a> (30 minutos)</li> +</ul> + +<h3 id="Opção_5_Eu_encontrei_alguma_informação_errada_mas_não_sei_como_corrigi-la">Opção 5: Eu encontrei alguma informação errada, mas não sei como corrigi-la</h3> + +<p>Pode comunicar problemas, <a class="external" href="https://bugzilla.mozilla.org/form.doc">preenchendo um formulário de erro na documentação</a> (EN) (5 minutos)</p> + +<h2 id="Outras_coisas_que_pode_fazer_na_MDN">Outras coisas que pode fazer na MDN</h2> + +<ul> + <li>Aderir à <a href="/pt-PT/docs/MDN/Comunidade">Comunidade da MDN</a>.</li> + <li><a href="https://developer.mozilla.org/pt-PT/profile">Preencha o seu perfil</a>, assim os outros podem saber mais sobre si.</li> + <li>Saiba mais sobre como <a href="/pt-PT/docs/MDN/Contribute">contribuir para a MDN</a>.</li> +</ul> 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/como_converter_exemplos_de_codigo_para_ficarem_live/index.html new file mode 100644 index 0000000000..e0f16cc514 --- /dev/null +++ b/files/pt-pt/mdn/contribute/howto/como_converter_exemplos_de_codigo_para_ficarem_live/index.html @@ -0,0 +1,36 @@ +--- +title: Como converter exemplos de código para ficarem "live" +slug: MDN/Contribute/Howto/Como_converter_exemplos_de_codigo_para_ficarem_live +tags: + - Como + - Metadados MDN + - Principiante +translation_of: MDN/Contribute/Howto/Convert_code_samples_to_be_live +--- +<div>{{MDNSidebar}}</div> + +<p class="summary">MDN tem um sistema de "<a href="/pt-PT/docs/MDN/Contribute/Structures/Exemplos_live">exemplos <em>live</em></a>", onde o exemplo de código é mostrado numa página utilizada diretamente para exibir o resultado desse mesmo exemplo. Contudo, muitos artigos existentes tem exemplos de código que ainda não utilizam este sistema, e precisam de ser convertidos.</p> + +<p><span class="seoSummary">Exemplos <em>live</em>, permitem-lhe ver como é que é o exemplo de destino. Este guia fala sobre como utilizar os exemplos existentes e adicionar a funcionalidade "<em>live</em>" às mesmas.</span></p> + +<dl> + <dt>Onde é que isso precisa de ser feito<strong>?</strong></dt> + <dd>Artigos com a etiqueta <a href="/en-US/docs/tag/NeedsLiveSample">NeedsLiveSample</a></dd> + <dt><strong>O que precisa de saber para realizar a tarefa?</strong></dt> + <dd> + <ul> + <li>Conhecimentos em HTML, CSS e/ou JavaScript, dependendo da amostra de código.</li> + <li>Capacidade de usar macros <a href="/en-US/docs/MDN/Contribute/Tools/KumaScript">KumaScript</a> dentro dos artigos MDN.</li> + </ul> + </dd> + <dd><strong>Quais são os passos para realizar a tarefa?</strong></dd> + <dd> + <ol> + <li>Escolher um artigo da lista de artigos que estão marcados <a href="/en-US/docs/tag/NeedsLiveSample">NeedsLiveSample</a>, onde a amostra de código é para uma funcionalidade com que se sente familiarizado.</li> + <li>Converter a amostra de código para ser "live".</li> + <li>Eliminar qualquer código ou imagem que fosse previamente utilizada para demonstrar o <em>output </em>da amostra.</li> + </ol> + </dd> +</dl> + +<p>Para mais informação sobre a criação e edição de <u>Amostras <em>Live</em></u>, consulte <a href="/pt-PT/docs/MDN/Contribute/Structures/Exemplos_live">Utilizar o sistema de amostra <em>live</em></a></p> 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 new file mode 100644 index 0000000000..172aed7d5d --- /dev/null +++ b/files/pt-pt/mdn/contribute/howto/como_definir_o_resumo_para_uma_pagina/index.html @@ -0,0 +1,47 @@ +--- +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 new file mode 100644 index 0000000000..def53aa207 --- /dev/null +++ b/files/pt-pt/mdn/contribute/howto/como_efetuar_revisao_tecnica/index.html @@ -0,0 +1,65 @@ +--- +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 new file mode 100644 index 0000000000..5751a2e391 --- /dev/null +++ b/files/pt-pt/mdn/contribute/howto/como_escrever_um_artigo_para_ajudar_as_pessoas_a_aprenderem_sobre_a_web/index.html @@ -0,0 +1,114 @@ +--- +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_escrever_uma_nova_entrada_no_glossario/index.html b/files/pt-pt/mdn/contribute/howto/como_escrever_uma_nova_entrada_no_glossario/index.html new file mode 100644 index 0000000000..105853672c --- /dev/null +++ b/files/pt-pt/mdn/contribute/howto/como_escrever_uma_nova_entrada_no_glossario/index.html @@ -0,0 +1,114 @@ +--- +title: Como escrever e referenciar uma entrada no glossário +slug: MDN/Contribute/Howto/Como_escrever_uma_nova_entrada_no_Glossario +tags: + - Como... + - Glossário + - Guia(2) + - Metadados da MDN +translation_of: MDN/Contribute/Howto/Write_a_new_entry_in_the_Glossary +--- +<div>{{MDNSidebar}}</div> + +<p>O <a href="/pt-PT/docs/Gloss%C3%A1rio">glossário</a> da MDN é o local onde nós definimos toda a terminologia, gíria, e abreviações utilizadas na documentação e programação. Contribuir para o glossário é uma maneira simples de tornar a Web mais fácil para todos entenderem. Você não precisa de um alto nível de habilidade técnica para escrever entradas de glossário porque elas devem permanecer simples e diretas.</p> + +<h2 id="Como_escrever_uma_entrada">Como escrever uma entrada</h2> + +<p>Se você está procurando por tópicos que precisam de uma entrada de glossário, verifique a lista de termos não documentados no final da página de destino do Glossário; clique em qualquer um desses links para iniciar uma nova página do Glossário para o item que você clicou; então siga os passos abaixo.</p> + +<p>Se você tem uma ideia para um nova entrada de glossário, basta abrir o botão em uma nova aba, e então siga os passos abaixo do botão.</p> + +<p></p><div class="align-center"><a class="button ignore-external mega positive" href="/pt-PT/docs/new?parent=4391">Adicionar Nova Entrada ao Glossário<div></div></a></div><p></p> + +<p> </p> + +<h3 id="Passo_1_Escreva_um_resumo">Passo 1: Escreva um resumo</h3> + +<p>The first paragraph of any glossary page is a simple and short description of the term (preferably no more than two sentences). Make sure anyone reading the description can understand the defined term immediately.</p> + +<div class="note"> +<p><strong>Nota:</strong> Please don't copy-and-paste definitions from elsewhere (especially not Wikipedia, since its range of license versions is smaller, and thus incompatible with that of MDN). It's really important to make sure this content is simple and easy to understand. It's worth spending some time on it rather than stealing content blindly. This glossary should be useful new content, not repeating things from elsewhere.</p> +</div> + +<p>Links to the glossary entry will use these summaries inside their tooltips, so that readers can see the definitions without navigating away from the page they're on. (See below how to insert links to glossary entries with the \{{Glossary}} macro.)</p> + +<p>If you must, you can add a few extra paragraphs, but it's very easy to find yourself writing a whole article. Writing a whole article is fine, but please don't put it in the glossary. If you aren't sure where to put your article, feel free to <a href="/en-US/docs/MDN/Community#Join_our_mailing_lists">reach out to discuss it</a>.</p> + +<h3 id="Passo_2_Expanda_com_hiperligações">Passo 2: Expanda com hiperligações</h3> + +<p>Finally, a glossary entry should always end with a "Learn more" section. This section should contain links to help the reader move forward: discovering more details, learning to use the relevant technology, and so on.</p> + +<p>We recommend that you sort the links into at least these three groups:</p> + +<dl> + <dt>Conhecimento geral</dt> + <dd>Links that provide more general information; for example, a link to <a href="https://pt.wikipedia.org/wiki/Wikip%C3%A9dia:P%C3%A1gina_principal">Wikipedia</a> is a good starting point.</dd> + <dt>Referência técnica</dt> + <dd>Links to more in-depth technical information, on MDN or elsewhere.</dd> + <dt>Saber sobre a mesma</dt> + <dd>Hiperligações para tutoriais, exercícios, quaisquer outros materiais que ajudem o leitor a saber como utilizar a tecnologia por de trás do termo definido.</dd> +</dl> + +<h2 id="Termos_sugeridos">Termos sugeridos</h2> + +<p>So you want to contribute but you don't know which terms need to be defined? <a href="https://developer.mozilla.org/en-US/docs/Glossary#Contribute_to_the_glossary">Here's</a> a list of suggestions. Click one and get started!</p> + +<h2 id="Lidar_com_a_desambiguação">Lidar com a desambiguação</h2> + +<p>Sometimes, a term has several meanings depending on the context. To resolve the ambiguities, you must follow those guidelines:</p> + +<ul> + <li>The term's main page must be a disambiguation page containing the {{TemplateLink("GlossaryDisambiguation")}} macro.</li> + <li>The term has subpages that define the term for a given context.</li> +</ul> + +<p>Let's illustrate that with an example. The term <em>signature</em> can have different meanings in at least three different contexts: <em>security</em>, <em>function</em> and <em>email</em>.</p> + +<ol> + <li>A página de <a href="/pt-PT/docs/Gloss%C3%A1rio/Assinatura">Glossário/Assinatura</a> é a página de desambiguação como a {{TemplateLink("GlossaryDisambiguation")}} macro.</li> + <li>The page <a href="/en-US/docs/Glossary/Signature/Security">Glossary/Signature/Security</a> is the page defining a signature in a security context.</li> + <li>The page <a href="/en-US/docs/Glossary/Signature/Function">Glossary/Signature/Function</a> is the page defining a function signature.</li> + <li>The page <a href="/en-US/docs/Glossary/Signature/Email">Glossary/Signature/Email</a> is the page defining email signature.</li> +</ol> + +<h2 id="Como_utilizar_a_macro_Glossary">Como utilizar a macro \{{Glossary}}</h2> + +<p>The glossary is much more useful when people can access the definitions from another document without navigating away from what they're reading. Therefore we urge you to link to the glossary whenever you can, using the {{TemplateLink("Glossary")}} macro:</p> + +<table class="standard-table"> + <thead> + <tr> + <th scope="col">Macro</th> + <th scope="col">Resultado</th> + <th scope="col">Nota</th> + </tr> + </thead> + <tbody> + <tr> + <td>\{{Glossary("browser")}}</td> + <td>{{Glossary("browser")}}</td> + <td>When a text matches the term to be defined, just use the macro as is (it's case insensitive)</td> + </tr> + <tr> + <td>\{{Glossary("browser", "Web browser")}}</td> + <td>{{Glossary("browser","Web browser")}}</td> + <td>To display an alternative text, use the second argument to specify that text</td> + </tr> + <tr> + <td>\{{Glossary("browser", "Web browser", 1)}}</td> + <td>{{Glossary("browser","Web browser",1)}}</td> + <td>Specify <code>1</code> as an optional third argument to display the link as a regular link rather than a subtle hint</td> + </tr> + </tbody> +</table> + +<p>Links created with the \{{Glossary}} macro always display a tooltip containing the glossary entry's summary paragraph.</p> + +<h3 id="Utilização_das_linhas_diretrizes">Utilização das linhas diretrizes</h3> + +<p>In many cases, it's perfectly safe to use that macro everywhere on MDN. However, there are a few cases you should handle with care:</p> + +<ul> + <li>If a term is already linked to another part of MDN, leave it that way and do not use the \{{Glossary}} macro.</li> + <li>Within an article section, use the \{{Glossary}} macro only once for the same term (<em>hint: a section always starts with a title</em>).</li> +</ul> diff --git a/files/pt-pt/mdn/contribute/howto/comunicar_um_problema/index.html b/files/pt-pt/mdn/contribute/howto/comunicar_um_problema/index.html new file mode 100644 index 0000000000..764d3fca0c --- /dev/null +++ b/files/pt-pt/mdn/contribute/howto/comunicar_um_problema/index.html @@ -0,0 +1,24 @@ +--- +title: Como comunicar um problema na MDN +slug: MDN/Contribute/Howto/Comunicar_um_problema +tags: + - Como... + - Guía + - Metadados MDN +translation_of: MDN/Contribute/Howto/Report_a_problem +--- +<div>{{MDNSidebar}}</div> + +<p>De vez em quando, pode encontrar problemas ao utilizar a MDN. Se é um problema com a infra-estrutura do site ou um erro no conteúdo da documentação, pode tentar corrigi-lo ou comunicar o problema. Enquanto o primeiro é o preferido, o último é às vezes o melhor que pode gerir, e isso também está bem.</p> + +<h2 id="Erros_de_documentação_ou_pedidos">Erros de documentação ou pedidos</h2> + +<p>Obviously, since MDN is a wiki, the best thing you can possibly do is fix problems you spot yourself. But maybe you don't know the answer or are in the middle of a deadline on your own project or something, and need to jot down the problem so someone can look at it later.</p> + +<p>As is the case with all things Mozilla, you report a documentation problem by filing a bug. That's when filing a <a href="https://bugzilla.mozilla.org/form.doc">documentation request bug</a> comes in. The documentation request form gathers the information needed to get us started on fixing the issue.</p> + +<p>Of course, our writing community is busy, so sometimes the quickest way to see a documentation problem resolved is to fix it yourself. See <a href="/en-US/docs/MDN/Contribute/Howto/Create_and_edit_pages" title="/en-US/docs/Project:MDN/Contributing/Creating_and_editing_pages">How to create and edit pages</a> for details.</p> + +<h2 id="Erros_bugs_do_site_ou_pedidos_de_funcionalidades">Erros (bugs) do site ou pedidos de funcionalidades</h2> + +<p><a href="/en-US/docs/MDN/Kuma" title="/en-US/docs/Project:MDN/Kuma">Kuma</a>, the Mozilla-developed platform used for the MDN web site, is in a state of continuous development. Our developers—as well as a number of volunteer contributors—are constantly making improvements. If you see a bug, or have a problem with the site, or even have a suggestion for something that could make the software more awesome, you can use the <a href="https://github.com/mdn/kuma/issues/new">Kuma bug form</a> to file a report. You can also use this form to report performance problems with the site, though odds are that performance-monitoring tools have already notified the appropriate people.</p> diff --git a/files/pt-pt/mdn/contribute/howto/criar_e_editar_paginas/index.html b/files/pt-pt/mdn/contribute/howto/criar_e_editar_paginas/index.html new file mode 100644 index 0000000000..e4d8572fe3 --- /dev/null +++ b/files/pt-pt/mdn/contribute/howto/criar_e_editar_paginas/index.html @@ -0,0 +1,181 @@ +--- +title: Como criar e editar páginas +slug: MDN/Contribute/Howto/Criar_e_editar_paginas +tags: + - Guía + - Introdução + - MDN Meta + - Principiante +translation_of: MDN/Contribute/Howto/Create_and_edit_pages +--- +<div>{{MDNSidebar}}</div> + +<p><span class="seoSummary">Este artigo introduz novos colaboradores ao processo de editar páginas existentes e criar novas páginas.</span></p> + +<h2 id="Editar_uma_página_existente">Editar uma página existente</h2> + +<p>Para editar uma página:</p> + +<ol> + <li>Clique no botão <strong>Editar</strong> perto do canto superior direito da página.</li> + <li>A página vai recarregar, com uma interface de edição onde podes acrescentar ou apagar informação diretamente.</li> + <li>Acrescente parágrafos, apague texto, insira títulos, e realize outras funções básicas envolvidas em escrever e editar.</li> +</ol> + +<p>Veja o guia do <a href="/en-US/docs/MDN/Contribute/Editor/Basics">Elementos da IU do editor</a>, no <a href="/en-US/docs/MDN/Contribute/Editor">Guia para o editor da IU da MDN</a>, para obter mais informação sobre a utilização do editor incorporado da <strong>MDN</strong>.</p> + +<h3 id="Pré-visualizar_alterações">Pré-visualizar alterações</h3> + +<p>Para ver o aspeto das suas alterações:</p> + +<ul> + <li>Clique no botão <strong>Preview (Pré-visualizar)</strong>, dentro da função de edição na parte superior ou inferior da página.</li> + <li>Isto abre a página de pré-visualização, que mostra as edições numa nova janela ou separador.</li> + <li>De cada vez que carregar neste botão, a página de pré-visualização é atualizada para refletir as alterações mais recentes.</li> +</ul> + +<p>Tenha cuidado! Pré-visualizar uma página <strong>não guarda </strong>o seu progresso. Não feche o separador em que está a editar até ter guardado o seu trabalho.</p> + +<h3 id="Comentário_de_revisão">Comentário de revisão</h3> + +<p>Depois de pré-visualizar as alterações, vai querer <em>guardar a sua revisão</em>. Antes de <strong>guardar</strong>, procure a caixa do comentário de revisão, por baixo da caixa de edição, e deixe um comentário para informar outros colaboradores de porque é que fez alterações. Diga, por exemplo, se acrescentou uma secção nova, mudou algumas palavras para tornar a terminologia mais consistente, reescreveu um parágrafo para esclarecer a linguagem, ou removeu informação redundante.</p> + +<h3 id="Índice">Índice</h3> + +<p>A secção "Neste artigo", é uma lista, gerada automaticamente, de ligações para os títulos numa página. Estes podem ser modificados através dos títulos. Também é possível remover um índice ou reduzir o número de ligações ao selecionar "Editar o Título e Propriedades da Página" e mudar o valor na caixa de seleção "TOC" (Table of contents / Índice).</p> + +<h3 id="Etiquetas_(Tags)">Etiquetas (Tags)</h3> + +<p>Pode adicionar ou remover etiquetas, que descrevem o conteúdo e propósito da página, por baixo da secção de edição. Veja <a href="/en-US/docs/MDN/Contribute/Tagging">Como etiquetar devidamente as páginas</a> para obter informação sobre as etiquetas que deve utilizar.</p> + +<h3 id="Necessita_de_revisão">Necessita de revisão?</h3> + +<p>Se um colaborador perito ou experiente deve rever as suas edições, por favor peça uma revisão técnica (de código, API, ou tecnologias), e/ou uma revisão editorial (de prosa, gramática, e conteúdo), certificando-se de que a caixa adequada tem um visto antes de guardar.</p> + +<h3 id="Anexar_ficheiro">Anexar ficheiro</h3> + +<p>Se pretende <strong>anexar um ficheiro</strong><em> </em>a uma página existente, ou acrescentar uma ilustração para dar melhores esclarecimentos, o mesmo pode ser acrescentado na margem inferiro da página. Quando envia uma imagem, por favor utilize uma ferramente de otimização de imagens para tornar o ficheiro o mais pequeno possível. Desta forma, reduz o tempo de carregamento da página e ajuda o desempenho geral da MDN. Utilize a sua ferramente preferida, se tiver uma; se não, sugerimos <a href="https://tinypng.com/">TinyPNG</a>, uma ferramenta Web acessível.</p> + +<h3 id="Publicar_Descartar_ou_Continuar_a_editar">Publicar, Descartar, ou Continuar a editar</h3> + +<p>Quando termina de editar e está contente com a pré-visualização, publique o seu trabalho e comentários com o botão <em>verde</em> <strong>Publicar</strong>, à direita do título da página, ou no fim da página. Se pretende continuar, clique em <strong>Publicar e cotinuar a editar</strong>, o qual publica as suas alterações e mantém a interface de edição aberta.</p> + +<p>Se mudar de ideias, pode descartar edições com o botão <em>vermelho</em> <strong>Descartar</strong>. Atenção que este botão descarta <em>permanentemente</em>.</p> + +<p>Premir a tecla <strong>Enter</strong> na caixa de Comentário de Revisão é equivalente a clicar em <strong>Publicar e cotinuar a editar</strong>.</p> + +<div class="note"> +<p>Nota: Se tentar guardar, mas as alterações são rejeitas como inválidas, e acha que o conteúdo é apropriado para a MDN, <a href="mailto:mdn-admins@mozilla.com?subject=MDN%3A%20Content%20Rejection%20Appeal&body=%3CDescribe%20the%20content%20you%20were%20trying%20to%20save%20and%20where%20you%20were%20trying%20to%20place%20it.%3E">envie um e-mail à equipa de administração da MDN</a> para obter assistência.</p> +</div> + +<h2 id="Getting_page-creation_permissions">Getting page-creation permissions</h2> + +<p>For security reasons, newly-created accounts don't have the ability to create new pages. If you try to do so, you'll see a page instructing you how to get the page created. There are two options:</p> + +<ul> + <li><strong>Ask for the page to be created for you.</strong> To do this, <a href="https://github.com/mdn/sprints/issues/new?template=issue-template.md&projects=mdn/sprints/2&labels=user-report">file a documentation request issue</a>, with the title "Create page: <page title>". Fill out the URL field of the template with the location on MDN where you'd like the page to go if you know where to place it. In the comment text, include information on why this page needs creating.</li> + <li><strong>Request page creation privileges.</strong> If you request page creation privileges, and they're granted to you, you'll be able to add new pages by following the instructions here. To request these privileges, <a href="mailto:mdn-admins@mozilla.org">email the MDN admin</a> team with your request. Include your username, why you would like to have the ability to create new pages. For instance, you're documenting a new API which involves many new pages, or you'd like to add new terms to the glossary. You should also have made useful contributions to this site's content, and been a contributor for some time. This length of time, and the other factors are collectively considered.</li> +</ul> + +<h2 id="Creating_a_new_page">Creating a new page</h2> + +<p>Once you have page-creation permission, you can begin creating pages.</p> + +<p>If you do not know where to place a new article, <strong>do not worry.</strong> Put it anywhere, we will find it, move to where it belongs, or merge it into existing content. Whatever makes the most sense. Do not worry about making it perfect. We have happy helper gnomes who help to make your content clean and rather luscious.</p> + +<p>There are a few ways to create a new page:</p> + +<ul> + <li><a href="#Missing_page_link">'Missing page' link.</a></li> + <li><a href="#New_page_without_link">New page without a link.</a></li> + <li><a href="#Subpage_of_an_existing_page">A subpage of an existing page.</a></li> + <li><a href="#Clone_of_an_existing_page">Clone of an existing page.</a></li> + <li><a href="#Link_from_an_existing_page">Link from an existing page.</a></li> +</ul> + +<h3 id="'Missing_page'_link">'Missing page' link</h3> + +<p>As with most wikis, it is possible to create a link to a page that is yet to exist. For example, an author might create a list of all the members of an API, before creating the pages for those members. On MDN, links to non-existent pages are typically displayed in red.</p> + +<p>To create a page from a 'missing page' link:</p> + +<ol> + <li>Log into MDN, and have page-creation permission. If not logged in, clicking a 'missing page' link results in a 404 (page not found) error.</li> + <li>Click the 'missing page' link. If you have page creation permission, the <a href="/en-US/docs/MDN/Contribute/Editor">MDN Editor UI</a> opens, ready for you to create the missing page.</li> + <li>Write the content of the page, and save it.</li> +</ol> + +<h3 id="New_page_without_link">New page without link</h3> + +<p><em>To create a new page without linking from another page</em>, enter a unique page name in the URL field of your browser. For example, if you enter:</p> + +<pre class="language-html">https://developer.mozilla.org/en-US/docs/FooBar</pre> + +<p>MDN Creates a new page, with the title "FooBar", opening the editor for you to add new content. Refer to the <a href="#Editing_an_existing_page">Editing an existing page</a> section of this article, for information on how to use the editor mode.</p> + +<p><em>To create a new page without linking from another page</em>:</p> + +<ol> + <li>Log in, and have page-creation permission.</li> + <li>Enter the following in the URL field of your browser:</li> +</ol> + +<pre class="language-html">https://developer.mozilla.org/en-US/docs/new</pre> + +<p>MDN Creates a new page, with a place for a title, opening the editor to add new content to this page. Refer to <a href="#Editing_an_existing_page">Editing an existing page</a>, for information on using editor mode.</p> + +<h3 id="Subpage_of_an_existing_page">Subpage of an existing page</h3> + +<p>To create a page you want to be below an existing page, in the page hierarchy:</p> + +<ol> + <li>On the 'parent' page, click the <strong>Advanced</strong> menu (the gear icon in the toolbar), then click <strong>New sub-page</strong>.</li> + <li>An editor view opens for creating a new document.</li> + <li>Add a title for this document, in the <strong>Title</strong> field.</li> + <li>Change the <strong>Slug</strong> field, if needed. For example, if the title is long, and a shorter URL seems appropriate. This field is automatically filled by the editor, substituting underscores for spaces found in the title, changing only the last part of the URL.</li> + <li>In the <strong>TOC</strong> field, select heading levels you want to be displayed in the table of contents for the page. Or select 'No table of contents', if one is not needed.</li> + <li>Write content of the page in the editor pane, saving your changes. Refer to <a href="#Editing_an_existing_page">Editing an existing page</a>, for further information on using editor mode.</li> +</ol> + +<h3 id="Clone_of_an_existing_page">Clone of an existing page</h3> + +<p>If there is an existing page, whose format you wish to use as a base for your new page, you can 'clone' that page, and then change its content.</p> + +<ol> + <li>On the original page, click the <strong>Advanced</strong> menu (the gear icon in the toolbar), and click <strong>Clone this page</strong>. An editor view opens, for creating a new document.</li> + <li>Change the <strong>Title</strong> of the page, as appropriate for the new content. The <strong>Slug</strong> field is updated automatically as you change the <strong>Title</strong> field.</li> + <li>Change the path portion of the <strong>Slug</strong> field, as needed, to put the new document in a different location in the document hierarchy. In most cases, this is not needed. A cloned page often has similar content to its original, and need to be in a similar location.</li> + <li>In the <strong>TOC</strong> field, select the heading levels you want to be automatically displayed in the table of contents for this page. Or select 'No table of contents', if one is not needed.</li> + <li>Write your content in the editor pane, saving your changes. Refer to <a href="#Editing_an_existing_page">Editing an existing page</a>, for more information on using editor mode.</li> +</ol> + +<h3 id="Link_from_an_existing_page">Link from an existing page</h3> + +<p>This is a bit of a hybrid. You can create a link on another page, then click the link you just inserted, to create the new page:</p> + +<ol> + <li>Enter the name of your new page, anywhere that makes sense in the text of an existing page.</li> + <li>Highlight this new name, and <strong>click the Link icon (<img alt="" src="https://developer.mozilla.org/files/3810/link-icon.png" style="height: 28px; width: 29px;">) </strong>in the editor's toolbar. The <strong>'Update Link'</strong> dialog opens, with the highlighted text in the <strong>'Link To'</strong> field.</li> + <li>"/en-US/docs/" is inserted by default, to the beginning of the URL field.<em> Enter the name </em>of the page after "/en-US/docs/". The page name does not have to be the same as the link text.</li> + <li>Click OK, to create and insert the link.</li> +</ol> + +<p>If the page does not yet exist, the link is displayed in red. If the page <em>does</em> exist, the link is displayed blue. If you want to create a new page, but the page title you desire is already taken, check if it makes sense helping edit and improve the page already there. Otherwise, think of a unique title for your new page, and create a link for it. Refer to <a href="https://developer.mozilla.org/Project:en/Page_Naming_Guide" title="Project:en/Page_Naming_Guide">page naming guide</a> for guidelines.</p> + +<p>To add content to your new page, click on the red link you just created, after saving and closing the editor. The new page opens in editor mode, enabling you to start writing. Refer to <a href="#Editing_an_existing_page">Editing an existing page</a>, for further information on using editor mode.</p> + +<h2 id="Refreshing_page_content">Refreshing page content</h2> + +<p>MDN support of KumaScript macros, and integration of content from other pages can sometimes be hampered by the need for caching of pages, for performance reasons. Pages are built from their source, and this output is cached for future requests. From that moment on, any macros (templates), or integrations (using the macro<span class="templateLink"><code><a href="https://developer.mozilla.org/en-US/docs/Template:Page">Page</a></code></span>), will not reflect later changes made to the macro, its output, or the contents of the integrated material.</p> + +<ul> + <li>To manually update a page, force-refresh your Web browser. MDN detects this, triggering a page rebuild, pulling in updated macro output, and integrating page content.</li> + <li>You can also configure pages to periodically rebuild, automatically. This should not be done unless you expect the page to update frequently. See <a href="/en-US/docs/MDN/Contribute/Tools/Page_regeneration">Page regeneration</a>, for detailed information.</li> +</ul> + +<h2 id="See_also">See also</h2> + +<ul> + <li><a href="/en-US/docs/MDN/Contribute/Editor">MDN editor guide</a></li> + <li><a href="/en-US/docs/MDN/Contribute/Content/Style_guide">MDN style guide</a></li> +</ul> 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 new file mode 100644 index 0000000000..058456953e --- /dev/null +++ b/files/pt-pt/mdn/contribute/howto/criar_uma_conta_mdn/index.html @@ -0,0 +1,41 @@ +--- +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/etiqueta/index.html b/files/pt-pt/mdn/contribute/howto/etiqueta/index.html new file mode 100644 index 0000000000..2d0ca3d1d6 --- /dev/null +++ b/files/pt-pt/mdn/contribute/howto/etiqueta/index.html @@ -0,0 +1,375 @@ +--- +title: Como etiquetar devidamente as páginas +slug: MDN/Contribute/Howto/Etiqueta +tags: + - Como + - Glossário + - Guía + - Introdução + - Metadados da MDN + - Principiante + - Tutorial + - contribuir +translation_of: MDN/Contribute/Howto/Tag +--- +<div>{{MDNSidebar}}</div> + +<p class="summary">As <strong><em>tags</em> de artigo</strong> são uma maneira importante de colocar os visitantes em contacto com conteúdo útil. Cada página normalmente deverá ter várias <em>tags</em> para ajudar a manter o conteúdo organizado. Esta página explica a melhor maneira para etiquetar as páginas, e assim os nossos leitores podem encontrar a informação e nós podemos manter-nos organizados.</p> + +<p>Para obter ajuda com a interface do utilizador para editar <em>tags</em>, consulte a <a href="/pt-PT/docs/MDN/Contribute/Editor/Basicos">secção de etiquetagem</a> no nosso guia do editor.</p> + +<p>Por favor, utilize as <em>tags</em> devidamente como explicado em baixo. Se não o fizer, as nossas ferramentas automatizadas não irão gerar corretamente as listas de conteúdo, as páginas de destino, e ligação dos artigos.</p> + +<h2 id="Como_é_que_a_MDN_utiliza_as_tags_etiquetas">Como é que a MDN utiliza as <em>tags </em>(etiquetas) </h2> + +<p>As <em>tags</em> são utilizadas de vários modos na MDN:</p> + +<dl> + <dt>Categorização do documento</dt> + <dd>What type of document is it? Is it a reference? A tutorial? A landing page? Our visitors can use these tags to filter searches, so they're really important!</dd> + <dt>Identificação do tópico</dt> + <dd>What is the article about? Is it about an API? The DOM? Graphics? Again, these tags are important because they can filter searches.</dd> + <dt>Estado da tecnologia</dt> + <dd>What's the status of the technology? Is it non-standard? Obsolete or deprecated? Experimental?</dd> + <dt>Nível de proficiência</dt> + <dd>For tutorials and guides, how advanced is the material covered by the article?</dd> + <dt>Metadados do documento</dt> + <dd>The writing community uses tags to keep track of which pages need what kind of work.</dd> +</dl> + +<h2 id="Guia_do_tipo_de_tag">Guia do tipo de <em>tag</em></h2> + +<p>Here's a quick guide to the types of tags and possible values for them.</p> + +<h3 id="Categoria_do_documento">Categoria do documento</h3> + +<p>When you tag an article with one of these categories, you help the automated tools more accurately generate landing pages, tables of contents, and so on. Our new search system will also use these terms so that our visitors can locate reference or guide information at will.</p> + +<p>We use the following category names as standard tagging terms:</p> + +<dl> + <dt><code>{{Tag("Intro")}}</code></dt> + <dd>The article provides introductory material about a topic. Ideally each technology area should have only one "Intro".</dd> + <dt><code>{{Tag("Featured")}}</code></dt> + <dd>The article is critical and will display prominently on landing pages. Use this tag sparingly (never more than three documents in each documentation area).</dd> + <dt><code>{{Tag("Reference")}}</code></dt> + <dd>The article contains reference material about an API, element, attribute, property, or the like.</dd> + <dt><code>{{Tag("Landing")}}</code></dt> + <dd>The page is a landing page.</dd> + <dt><code>{{Tag("Guide")}}</code></dt> + <dd>The article is a how-to or guide page.</dd> + <dt><code>{{Tag("Example")}}</code></dt> + <dd>The article is a code sample page, or has code samples (that is, actual snippets of useful code, not one-line "syntax examples").</dd> +</dl> + +<h3 id="Tópico">Tópico</h3> + +<p>By identifying the article's topic area, you are helping generate better search results (and landing pages and navigation as well).</p> + +<p>While there's some room for flexibility here as we identify new topic areas, we try to limit ourselves to the names of APIs or technologies. Some useful examples:</p> + +<ul> + <li><code>{{Tag("HTML")}}</code></li> + <li><code>{{Tag("CSS")}}</code></li> + <li><code>{{Tag("JavaScript")}}</code> (notice the capital "S"!)</li> + <li><code>{{Tag("Document")}}</code></li> + <li><code>{{Tag("DOM")}}</code></li> + <li><code>{{Tag("API")}}</code> for each interface, method and property.</li> + <li><code>{{Tag("Method")}}</code> for each method of an API</li> + <li><code>{{Tag("Property")}}</code> for each property of an API</li> + <li><code>{{Tag("Graphics")}}</code></li> + <li><code>{{Tag("SVG")}}</code></li> + <li><code>{{Tag("WebGL")}}</code></li> + <li><code>{{Tag("Tools")}}</code></li> + <li><code>{{Tag("Web")}}</code></li> + <li><code>{{Tag("Element")}}</code></li> + <li><code>{{Tag("Extensions")}}</code> and <code>{{Tag("WebExtensions")}}</code> for WebExtension documentation.</li> +</ul> + +<p>In general, your topic identification tag should be the name of an interface with a number of related pages (like <a href="/en-US/docs/Web/API/Node" title="/en-US/docs/Web/API/Node">Node</a>, which has many pages for its various properties and methods), or the name of an overall technology type. You might tag a page about WebGL with <code>Graphics</code> and <code>WebGL</code>, for example, but a page about {{HTMLElement("canvas")}} with <code>HTML</code>, <code>Element</code>, <code>Canvas</code>, and <code>Graphics</code>.</p> + +<h4 id="Conteúdo_específico_da_Mozilla">Conteúdo específico da Mozilla</h4> + +<p>Estas <em>tags</em> são utilizadas apenas no conteúdo especifico da Mozilla:</p> + +<ul> + <li><code>{{Tag("Mozilla")}}</code></li> + <li><code>{{Tag("Firefox")}}</code></li> + <li><code>{{Tag("Firefox OS")}}</code></li> + <li><code>{{Tag("Gecko")}}</code></li> + <li><code>{{Tag("XUL")}}</code></li> + <li><code>{{Tag("XPCOM")}}</code></li> +</ul> + +<h3 id="Identificação_de_API">Identificação de API</h3> + +<p>Within the API reference, each article should identify which part of the API it covers:</p> + +<dl> + <dt><code>{{tag("Interface")}}</code></dt> + <dd>The main article for an interface should have this tag. For example, {{domxref("RTCPeerConnection")}}.</dd> + <dt><code>{{tag("Constructor")}}</code></dt> + <dd>Each interface may have up to one page tagged "Constructor"; this is the interface's constructor. The page should have the same name as the interface, like {{domxref("RTCPeerConnection.RTCPeerConnection()")}}.</dd> + <dt><code>{{tag("Property")}}</code></dt> + <dd>Every article describing a particular property within an interface needs this tag. See {{domxref("RTCPeerConnection.connectionState")}}, for example.</dd> + <dt><code>{{tag("Method")}}</code></dt> + <dd>Each article documenting an interface method needs this tag. See {{domxref("RTCPeerConnection.createOffer()")}} for example.</dd> +</dl> + +<p>In addition, the reference pages need to include interface, property, and method names among their tags. Some examples:</p> + +<dl> + <dt>The interface {{domxref("RTCPeerConnection")}}</dt> + <dd>Include the tag "RTCPeerConnection" along with the other relevant tags ("Interface", "WebRTC", "WebRTC API", "API", "Reference", and so forth).</dd> + <dt>The method {{domxref("RTCPeerConnection.createOffer()")}}</dt> + <dd>Include the tags "RTCPeerConnection" and "createOffer" (note <em>no</em> parentheses in tag names!) along with the other relevant tags, including "WebRTC", "WebRTC API", "API", "Reference", and so forth. Consider including things like "Offer" and "SDP", which are also relevant here.</dd> + <dt>The property {{domxref("RTCPeerConnection.iceConnectionState")}}</dt> + <dd>Include the tags "RTCPeerConnection" and "iceConnectionState" along with the other relevant tags, including "WebRTC", "WebRTC API", "API" and "Reference". Also consider including "ICE".</dd> +</dl> + +<h3 id="Estado_da_tecnologia">Estado da tecnologia</h3> + +<p>To help the reader understand how viable a technology is, we use tags to label pages as to the status of the technology's specification. This isn't as detailed as actually explaining what the spec is and how far the technology has come in the specification process (that's what the Specifications table is for), but it helps the reader judge, at a glance, whether it's a good idea to use the technology described in the article.</p> + +<p>Here are possible values for these tags:</p> + +<dl> + <dt><code>{{Tag("Read-only")}}</code></dt> + <dd>Apply this tag to reference pages which describe a property or attribute which is read-only.</dd> + <dt><code>{{Tag("Non-standard")}}</code></dt> + <dd>Indicates that the technology or API described on the page is not part of a standard, whether it's stable or not in any browsers which implement it (if it's not stable, it should also be {{Tag("Experimental")}}). If you don't use this tag, your readers will assume the technology is standard. The compatibility table on the page should clarify which browser(s) support this technology or API.</dd> + <dt><code>{{Tag("Deprecated")}}</code></dt> + <dd>The technology or API covered on the page is marked as deprecated in the specification, and is likely to eventually be removed, but is generally still available in current versions of browsers.</dd> + <dt><code>{{Tag("Obsolete")}}</code></dt> + <dd>The technology or API has been deemed obsolete and has been removed (or is actively being removed) from all or most current browsers.</dd> + <dt><code>{{Tag("Experimental")}}</code></dt> + <dd>The technology is not standardized, and is an experimental technology or API that may or may not ever become part of a standard. It is also subject to change in the browser engine (typically only one) that implements it. If the technology isn't part of any specification (even in draft form), it should also have the {{tag("Non-standard")}} tag.</dd> + <dt><code>{{Tag("Needs Privileges")}}</code></dt> + <dd>The API requires privileged access to the device on which the code is running.</dd> + <dt><code>{{Tag("Certified Only")}}</code></dt> + <dd>The API only works in certified code.</dd> +</dl> + +<p>These tags are no excuse to leave out the <a href="/en-US/docs/Project:Compatibility_tables">compatibility table</a> in your article! That should always be present.</p> + +<h3 id="Nível_de_competência_técnica">Nível de competência técnica</h3> + +<p>Use the skill-level tag type only for guides and tutorials (that is, pages tagged <code>Guide</code>) to help users choose tutorials based on how familiar they are with a technology. There are three values for this:</p> + +<dl> + <dt><code>{{Tag("Beginner")}}</code></dt> + <dd>Articles designed to introduce the reader to a technology they've never used or have only a passing familiarity with.</dd> + <dt><code>{{Tag("Intermediate")}}</code></dt> + <dd>Articles for users who have gotten started with the technology but aren't experts.</dd> + <dt><code>{{Tag("Advanced")}}</code></dt> + <dd>Articles about stretching the capabilities of a technology and of the reader.</dd> +</dl> + +<h3 id="Metadados_de_documento">Metadados de documento</h3> + +<p>The writing community uses tags to label articles as requiring specific types of work. Here's a list of the ones we use most:</p> + +<dl> + <dt><code>{{Tag("Draft")}}</code></dt> + <dd>The article is not complete, and is at least in theory still actively being updated (although it's also possible it's been forgotten about). Try to check with the most recent contributors before making changes, in order to avoid potential content collisions.</dd> + <dt><code>{{Tag("NeedsCompatTable")}}</code></dt> + <dd>The article needs a table to specify compatibility of a feature across browsers. <a href="/en-US/docs/MDN/Contribute/Structures/Compatibility_tables">See here</a> for a guide on contributing to browser compatibility.</dd> + <dt><code>{{Tag("NeedsContent")}}</code></dt> + <dd>The article is a stub, or is otherwise lacking information. This tag means that someone should review the content and add more details and/or finish writing the article.</dd> + <dt><code>{{Tag("NeedsExample")}}</code></dt> + <dd>The article needs one or more examples created to help illustrate the article's point. These examples should use the <a href="/en-US/docs/Project:MDN/Contributing/How_to_help/Code_samples">live sample system</a>.</dd> + <dt><code>{{Tag("NeedsLiveSamples")}}</code></dt> + <dd>The article has one or more examples that need to be updated to use the <a href="/en-US/docs/Project:MDN/Contributing/How_to_help/Code_samples">live sample system</a>.</dd> + <dt><code>{{Tag("NeedsSpecTable")}}</code></dt> + <dd>The article needs a table to indicate on which specification document(s) the feature was defined.</dd> + <dt><code>{{Tag("NeedsUpdate")}}</code></dt> + <dd>The content is out of date and needs to be updated.</dd> + <dt><code>{{Tag("l10n:exclude")}}</code></dt> + <dd>The content is not really worth localizing and will not appear on localization status pages.</dd> + <dt><code>{{Tag("l10n:priority")}}</code></dt> + <dd>The content is important and should be marked as a priority for MDN translators. Shows up in an extra priority table on localization status pages.</dd> +</dl> + +<h2 id="Unindo_tudo">Unindo tudo</h2> + +<p>Portanto, para cada página que atribui <em>tags</em> de vários tipos de <em>tag</em>, por exemplo:</p> + +<dl> + <dt>A tutorial about WebGL for beginners</dt> + <dd><code>WebGL</code>, <code>Graphics</code>, <code>Guide</code>, <code>Beginner</code></dd> + <dt>Reference page for {{HTMLElement("canvas")}}</dt> + <dd><code>Canvas</code>, <code>HTML</code>, <code>Element</code>, <code>Graphics,</code> <code>Reference</code></dd> + <dt>A landing page for Firefox OS developer tools</dt> + <dd><code>Tools</code>, <code>Firefox OS</code>, <code>Landing</code></dd> +</dl> + +<h2 id="Filtros_de_tag_e_pesquisa">Filtros de <em>tag </em>e pesquisa</h2> + +<p>Search filters won't work properly unless we tag MDN pages properly. Here's a table of search filters and which tags they look for.</p> + +<div class="note"> +<p><strong>Nota:</strong> If multiple tags are listed under "Tag name," that means any one or more of these tags must be present for the article to match.</p> +</div> + +<table class="standard-table"> + <thead> + <tr> + <th scope="col">Grupo de filtro</th> + <th scope="col">Nome do filtro de pesquisa</th> + <th scope="col">Nome da <em>tag</em></th> + </tr> + </thead> + <tbody> + <tr> + <th rowspan="22" scope="row" style="vertical-align: baseline;">Tópico</th> + <td>APIs and DOM</td> + <td>{{Tag("API")}} || {{Tag("DOM")}} {{Deprecated_Inline}}</td> + </tr> + <tr> + <td>Add-ons & Extensions {{Deprecated_Inline}}</td> + <td>{{Tag("Add-ons")}} || {{Tag("Extensions")}} || {{Tag("Plugins")}} || {{Tag("Themes")}} || {{Tag("WebExtensions")}}</td> + </tr> + <tr> + <td>CSS</td> + <td>{{Tag("CSS")}}</td> + </tr> + <tr> + <td>Canvas</td> + <td>{{Tag("Canvas")}}</td> + </tr> + <tr> + <td>Firefox</td> + <td>{{Tag("Firefox")}}</td> + </tr> + <tr> + <td>Firefox OS</td> + <td>{{Tag("Firefox OS")}}</td> + </tr> + <tr> + <td>Games</td> + <td>{{Tag("Games")}}</td> + </tr> + <tr> + <td>HTML</td> + <td>{{Tag("HTML")}}</td> + </tr> + <tr> + <td>HTTP</td> + <td>{{Tag("HTTP")}}</td> + </tr> + <tr> + <td>JavaScript</td> + <td>{{Tag("JavaScript")}}</td> + </tr> + <tr> + <td>Marketplace {{Non-standard_Inline}}</td> + <td>{{Tag("Marketplace")}}</td> + </tr> + <tr> + <td>MathML</td> + <td>{{Tag("MathML")}}</td> + </tr> + <tr> + <td>Mobile</td> + <td>{{Tag("Mobile")}}</td> + </tr> + <tr> + <td>Open Web Apps {{Non-standard_Inline}}</td> + <td>{{Tag("Apps")}}</td> + </tr> + <tr> + <td>SVG</td> + <td>{{Tag("SVG")}}</td> + </tr> + <tr> + <td>Web Development</td> + <td>{{Tag("Web Development")}}</td> + </tr> + <tr> + <td>Web Standards</td> + <td>{{Tag("Web")}}</td> + </tr> + <tr> + <td>WebExtensions</td> + <td>{{Tag("WebExtensions")}}</td> + </tr> + <tr> + <td>WebGL</td> + <td>{{Tag("WebGL")}}</td> + </tr> + <tr> + <td>Writing Documentation</td> + <td>{{Tag("MDN Meta")}}</td> + </tr> + <tr> + <td>XPCOM {{Non-standard_Inline}}</td> + <td>{{Tag("XPCOM")}}</td> + </tr> + <tr> + <td>XUL {{Non-standard_Inline}}</td> + <td>{{Tag("XUL")}}</td> + </tr> + <tr> + <th rowspan="3" scope="row" style="vertical-align: baseline; white-space: nowrap;">{{anch("Skill level")}}</th> + <td>I'm an Expert</td> + <td>{{Tag("Advanced")}}</td> + </tr> + <tr> + <td>Intermediate</td> + <td>{{Tag("Intermediate")}}</td> + </tr> + <tr> + <td>I'm Learning</td> + <td>{{Tag("Beginner")}}</td> + </tr> + <tr> + <th rowspan="7" scope="row" style="vertical-align: baseline; white-space: nowrap;">Tipo de documento</th> + <td>Docs</td> + <td><em>This restricts the search to docs content, leaving out Hacks and other MDN content.</em></td> + </tr> + <tr> + <td>Demos</td> + <td><em>This includes Demo Studio content in the search results.</em></td> + </tr> + <tr> + <td>Tools</td> + <td>{{Tag("Tools")}}</td> + </tr> + <tr> + <td>Code Samples</td> + <td>{{Tag("Example")}}</td> + </tr> + <tr> + <td>How-To & Tutorial</td> + <td>{{Tag("Guide")}}</td> + </tr> + <tr> + <td>Developer Profiles</td> + <td><em>This includes developer profiles from the MDN site in the search results.</em></td> + </tr> + <tr> + <td>External Resources</td> + <td><em>The dev team is still figuring this out...</em></td> + </tr> + </tbody> +</table> + +<h2 id="Problemas_de_etiquetagem_que_pode_corrigir">Problemas de etiquetagem que pode corrigir</h2> + +<p>There are several kinds of tag problems you can help fix:</p> + +<dl> + <dt>No tags</dt> + <dd>Generally articles should have at <em>least</em> a "{{anch("Document category", "category")}}" tag and a "{{anch("Topic", "topic")}}" tag. Usually other tags are appropriate as well, but if you can help us ensure that the minimum tags are present, you'll be a documentation hero!</dd> + <dt>Tags that don't follow our tagging standards</dt> + <dd>Please fix any documents whose tags don't follow the standards on this page.<br> + Note that you may occasionally see some localized tags (such as <code>Référence</code>) showing up on some English pages. This was due to a <a href="https://bugzilla.mozilla.org/show_bug.cgi?id=776048">bug in Kuma</a>, which caused the tags to reappear even if they were deleted. That bug has <a href="https://bugzilla.mozilla.org/show_bug.cgi?id=776048#c37">since been fixed</a>, so any remaining localized tags can be cleaned up if they're spotted.</dd> + <dt>Incorrect tags</dt> + <dd>If you're looking at an article about HTML and it's tagged "JavaScript", that's probably wrong! Likewise, if an article discusses Mozilla internals but has a "Web" tag, that's probably wrong too. Remove these tags and add the right tags if they aren't already there. Please also correct misspelled tags (e.g., "Javascript" will still match, since tags are case-insensitive, but let's not be sloppy!).</dd> + <dt>Missing tags</dt> + <dd>If an article has some but not all of the tags it needs, feel free to add more. For example, if a page in JavaScript reference is (correctly) tagged "JavaScript" but nothing else, you're invited to tag the page "Reference" as well!</dd> + <dt>Tag spam</dt> + <dd>This insidious beast is the most revolting tag problem of all: some Web vermin has deposited its droppings in the page tags (like "Free warez!" or "Hey I was browsing your site and wanted to ask you if you could help me solve this problem I'm having with Flash crashing all the time"). We've got to delete these right away! They're ugly, they're hard to manage if they're allowed to linger too long, and they're terrible for {{Glossary("SEO")}}.</dd> +</dl> + +<p>If you see one (or more) of these problems, please <a href="/en-US/docs/Project:MDN/Contributing/Getting_started#Logging_into_MDN">log into MDN</a> and click EDIT at the top right of the MDN window. Once the editor loads up, scroll down to the bottom of the page, where you'll see the tag box. For more details on the tagging interface, see "<a href="/en-US/docs/Project:MDN/Contributing/Editor_guide#The_tags_box">The tags box</a>" in the <a href="/en-US/docs/Project:MDN/Contributing/Editor_guide">MDN editor guide</a>.</p> 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 new file mode 100644 index 0000000000..d2902a8bb6 --- /dev/null +++ b/files/pt-pt/mdn/contribute/howto/fazer_revisão_editorial/index.html @@ -0,0 +1,56 @@ +--- +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/index.html b/files/pt-pt/mdn/contribute/howto/index.html new file mode 100644 index 0000000000..08ce3855be --- /dev/null +++ b/files/pt-pt/mdn/contribute/howto/index.html @@ -0,0 +1,13 @@ +--- +title: Guias de Como... +slug: MDN/Contribute/Howto +tags: + - Landing + - Metadados MDN +translation_of: MDN/Contribute/Howto +--- +<div>{{MDNSidebar}}</div><div>{{IncludeSubnav("/pt-PT/docs/MDN")}}</div> + +<p>Estes artigos proporcionam guias passo-a-passo para a realização de objetivos específicos quando contribui para a MDN.</p> + +<p>{{LandingPageListSubpages}}</p> 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 new file mode 100644 index 0000000000..e7c610347c --- /dev/null +++ b/files/pt-pt/mdn/contribute/howto/marcar_paginas_javascript/index.html @@ -0,0 +1,75 @@ +--- +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 new file mode 100644 index 0000000000..ec68693a32 --- /dev/null +++ b/files/pt-pt/mdn/contribute/howto/participar_testes_beta/index.html @@ -0,0 +1,52 @@ +--- +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/index.html b/files/pt-pt/mdn/contribute/index.html new file mode 100644 index 0000000000..151975c88c --- /dev/null +++ b/files/pt-pt/mdn/contribute/index.html @@ -0,0 +1,24 @@ +--- +title: Contribuir para a MDN +slug: MDN/Contribute +tags: + - Guía + - Landing + - Metadados MDN +translation_of: MDN/Contribute +--- +<div>{{MDNSidebar}}</div> + +<header> </header> + +<div class="boxed translate-rendered"> +<div>{{IncludeSubnav("/pt-PT/docs/MDN")}}</div> +</div> + +<p>Bem-vindo! Ao visitar esta página, efetuou o primeiro passo para se tornar em um colaborador na MDN.</p> + +<p><span class="seoSummary">Estes guias listados aqui abrangem todos os aspetos da contribuição na MDN, incluindo os guias de estilo, guias para a utilização do nosso editor e ferramentas, e muito mais. Por favor, certifique-se que lê (e que concorda com) os <a href="https://www.mozilla.org/en-US/about/legal/terms/mozilla/">Termos da Mozilla </a>(EN) antes de editar ou criar quaisquer páginas. </span></p> + +<p>Se ainda não contribuiu na MDN, o guia de <a href="https://developer.mozilla.org/pt-PT/docs/MDN/Intrudução">Iniciação na MDN</a> pode ajudá-lo a escolher uma tarefa para inciar e ajudar.</p> + +<p>{{LandingPageListSubPages()}}</p> diff --git a/files/pt-pt/mdn/contribute/localize/index.html b/files/pt-pt/mdn/contribute/localize/index.html new file mode 100644 index 0000000000..b9fdf11ea2 --- /dev/null +++ b/files/pt-pt/mdn/contribute/localize/index.html @@ -0,0 +1,60 @@ +--- +title: Localizar MDN +slug: MDN/Contribute/Localize +tags: + - Landing + - Localização + - Metadados MDN + - Precisa de Tradução + - l10n +translation_of: MDN/Contribute/Localize +--- +<div>{{MDNSidebar}}</div><p>{{IncludeSubnav("/pt-PT/docs/MDN")}}</p> + +<p>A MDN é utilizada por pessoas em todo o mundo como uma referência e guia para as tecnologias da Web, bem como, para os próprios recursos do Firefox. As nossas comunidades de localização são uma parte fundamental do projeto Mozilla; o seu trabalho na tradução e localização da nossa documentação ajuda as pessoas em todo o mundo a desenvolverem para a Web aberta. Se quiser saber mais sobre a localização, ou até começar uma nova localização, este é o lugar para começar.</p> + +<h2 id="Tipos_de_localização_na_MDN">Tipos de localização na MDN</h2> + +<p>A localização na MDN compreende três aspetos, que requerem diferentes sistemas ou privilégios de acesso.</p> + +<dl> + <dt>Interface do utilizador no site da MDN</dt> + <dd>As <em>strings</em> que aparecem em todas as páginas da MDN (ou na maioria das páginas) para enquadrar o conteúdo principal do artigo e fornecer controles de navegação e utilizador. Estas <em>strings</em> são traduzidas utilizando o sistema <a href="/pt-PT/docs/Mozilla/Localization/Localização_com_Pontoon">Pontoon</a> da Mozilla do <a href="https://pontoon.mozilla.org/projects/mdn/">projeto a MDN</a>. Se o seu idioma não estiver disponível para a MDN, um administrador deve ativá-lo. Consulte <a href="/pt-PT/docs/MDN/Contribute/Localize/Iniciar_uma_localizacao">iniciar uma nova localização na MDN</a>.</dd> + <dt>Conteúdo da MDN</dt> + <dd>O corpo principal das páginas da MDN, consistem em referência, guia ou artigos de tutorial. Os artigos podem ser traduzidos utilizando <a href="/pt-PT/docs/MDN/Contribute/Localize/Translating_pages">interface de tradução incorporada da MDN</a>. Se a sua localização não estiver disponível na lista de locais para se traduzir, consulte <a href="/pt-PT/docs/MDN/Contribute/Localize/Iniciar_uma_localizacao">iniciar uma nova localização da MDN</a>.</dd> +</dl> + +<dl> + <dt><em>Strings </em>macro</dt> + <dd>Essas <em>strings</em> são exibidas por <a href="/pt-PT/docs/MDN/Contribute/Structures/Macros">modelos de macro</a> que constroem certos tipos de navegação, mensagens ou estruturas geradas. Porque os modelos podem ter efeitos difusos e potencialmente destrutivos, as alterações passam por um <a href="/en-US/docs/MDN/Contribute/Tools/Template_editing">processo de revisão </a><a href="/pt-PT/docs/MDN/Contribute/Tools/Edição_de_modelo">e pedido de subsmissão</a>.</dd> +</dl> + +<p>As páginas seguintes fornecem mais detalhes sobre a localização na MDN:</p> + +<p>{{LandingPageListSubpages}}</p> + +<h2 id="Comunidades_de_localização_na_MDN">Comunidades de localização na MDN</h2> + +<p>As atividades de localização na MDN são ambas realizadas por indivíduos agindo de forma independente, e por grupos que trabalham em conjunto, possivelmente como parte de uma comunidade de localização maior da Mozilla. Os projetos de localização na MDN são liderados pelos<strong> supervisores de Localização.</strong></p> + +<ul> + <li><a href="/pt-PT/docs/MDN/Contribute/Localize/Projetos_localização">Projetos de localização</a></li> + <li><a href="/en-US/docs/MDN/Community/Roles/Localization_driver_role">Função do supervisor de localização</a></li> +</ul> + +<h2 id="Ferramentas_de_localização">Ferramentas de localização</h2> + +<p>Existem muitas ferramentas úteis que irá utilizar durante o trabalho de localização:</p> + +<dl> + <dt><a href="/pt-PT/docs/Mozilla/Localization/Localização_com_Pontoon" title="/en-US/docs/Mozilla/Localization/Localizing_with_Verbatim">Pontoon</a></dt> + <dd>Utilizado para tradução de <em>strings </em>em múltiplos projetos na Mozilla, incluindo a interface do utilizador da MDN (bem como a interface do utilizador do Firefox).</dd> + <dt><a href="http://transvision.mozfr.org/" title="http://transvision.mozfr.org/">Transvision</a></dt> + <dd>Um utilitário fornecido pela comunidade francesa da Mozilla, que permite-lhe procurar por ocorrências de uma <em>string</em> inglesa, encontrar todas as traduções em um idioma de destino que são utilizadas em todo o código da Mozilla. Útil para encontrar as traduções preferidas para palavras ou frases.</dd> +</dl> + +<h2 id="Consulte_também">Consulte também</h2> + +<ul> + <li><a href="/pt-PT/docs/Mozilla/Localization" title="/en-US/docs/Mozilla/Localization">Localização na Mozilla</a></li> +</ul> diff --git a/files/pt-pt/mdn/contribute/localize/iniciar_uma_localizacao/index.html b/files/pt-pt/mdn/contribute/localize/iniciar_uma_localizacao/index.html new file mode 100644 index 0000000000..35d7a909be --- /dev/null +++ b/files/pt-pt/mdn/contribute/localize/iniciar_uma_localizacao/index.html @@ -0,0 +1,104 @@ +--- +title: Iniciar uma nova localização na MDN +slug: MDN/Contribute/Localize/Iniciar_uma_localizacao +tags: + - Documentação + - Guía + - I10n + - Localização + - Metadados MDN +translation_of: MDN/Contribute/Localize/Starting_a_localization +--- +<div>{{MDNSidebar}}</div><p>As localizações de conteúdo da MDN ajudam a expandir o alcance da MDN para muitos programadores da Web e potenciais programadores da Web do que apenas aqueles que podem ler inglês. Portanto, as localizações são uma parte vital da realização da missão da MDN. <br> + <br> + Os pedidos de novas localizações na MDN são avaliados caso a caso, e devem obedecer a alguns requisitos mínimos. Outros fatores que são considerados incluem o número de falantes do idioma, e a proporção desse grupo que também lê inglês. Nós não temos regras rígidas sobre estes números, mas a prioridade será dada a idiomas que aumentam significativamente o alcance da MDN. Um idioma com uma grande população de falantes que não lêem inglês receberá maior prioridade sobre um com uma população pequena de falantes onde muitos deles lêem o inglês .</p> + +<h2 id="Critério_mínimo">Critério mínimo</h2> + +<p>O critério mínimo para dicionar um idioma na MDN, são:</p> + +<ul> + <li>An active Mozilla localization community for the locale exists outside of MDN.</li> + <li>A designated localization leader for the locale has committed to leading the localizing effort.</li> + <li>The locale for MDN has been added in Pontoon, and the community has translated at least 50% of strings.</li> + <li>A core community member has agreed to mentor the localization leader (based in part on the additional factors mentioned above, as well as team workloads).</li> +</ul> + +<h2 id="Processo_para_iniciar_a_localização">Processo para iniciar a localização</h2> + +<p>Starting a localization is not a single event, but a process with the following general steps:</p> + +<ol> + <li>Be a member of an active <a href="https://wiki.mozilla.org/L10n:Teams">Mozilla localization community</a>. If the Mozilla community for your locale is not active, work on building up that community before expanding it to include MDN.</li> + <li>Reach out to the MDN community to share your intention of starting a new MDN localization. (For example, join the <a href="https://discourse.mozilla-community.org/c/mdn">MDN discussion forum</a> and the <a href="irc://irc.mozilla.org/mdn" title="Join us on IRC">#mdn</a> IRC channel on <a class="link-irc" href="irc://irc.mozilla.org">irc.mozilla.org</a>.) Core members of the MDN community, including <a href="mailto:mdn-admins@mozilla.org?subject=Starting%20a%20localization%20project">MDN staff</a>, can advise you on whether your proposed locale seems like a good fit for MDN.</li> + <li>Add a section for your language to the list of <a href="/en-US/docs/MDN/Contribute/Localize/Localization_projects">localization projects</a>, and include anyone else who is planning to work on it.</li> + <li><a href="https://bugzilla.mozilla.org/enter_bug.cgi?alias=&assigned_to=nobody%40mozilla.org&blocked=&bug_file_loc=http%3A%2F%2F&bug_severity=normal&bug_status=NEW&comment=&component=Localization&contenttypeentry=&contenttypemethod=autodetect&contenttypeselection=text%2Fplain&data=&defined_groups=1&dependson=&description=&flag_type-4=X&flag_type-607=X&flag_type-791=X&flag_type-800=X&form_name=enter_bug&keywords=&maketemplate=Remember%20values%20as%20bookmarkable%20template&op_sys=All&priority=--&product=Mozilla%20Developer%20Network&qa_contact=website%40mdn.bugs&rep_platform=All&requestee_type-4=&requestee_type-607=&requestee_type-791=&requestee_type-800=&short_desc=&status_whiteboard=&target_milestone=---&version=unspecified">Submit a bug</a> in <a href="https://bugzilla.mozilla.org">Bugzilla</a> to request activation of your locale for MDN in Pontoon. This bug should be in the "Mozilla Developer Network" > "Localization" category. A Pontoon administrator must do this activation.</li> + <li>Work with your localization community to translate MDN UI strings in Pontoon. Don’t proceed to the next step until you have at least 50% of the strings translated. Keep communicating with the MDN community about your progress.</li> + <li><a href="https://bugzilla.mozilla.org/enter_bug.cgi?alias=&assigned_to=nobody%40mozilla.org&blocked=&bug_file_loc=http%3A%2F%2F&bug_severity=normal&bug_status=NEW&comment=&component=Localization&contenttypeentry=&contenttypemethod=autodetect&contenttypeselection=text%2Fplain&data=&defined_groups=1&dependson=&description=&flag_type-4=X&flag_type-607=X&flag_type-791=X&flag_type-800=X&form_name=enter_bug&keywords=&maketemplate=Remember%20values%20as%20bookmarkable%20template&op_sys=All&priority=--&product=Mozilla%20Developer%20Network&qa_contact=website%40mdn.bugs&rep_platform=All&requestee_type-4=&requestee_type-607=&requestee_type-791=&requestee_type-800=&short_desc=&status_whiteboard=&target_milestone=---&version=unspecified">Submit a bug</a> in <a href="https://bugzilla.mozilla.org">Bugzilla</a> to request that the locale be added to the list of available locales on MDN. (Same product and category as the bug in Step 4) Indicate who will take the role of MDN localization leader, to be a point of contact between the MDN localization group and the rest of the MDN community. Usually, this is the person who submits the bug. In order for your request to be accepted, a member of the MDN community must be willing to mentor the localization leader, so good communication up to this point will pay off if you can show that: + <ol> + <li>Your Mozilla localization community is active, and has the organization and interest need to sustain working on MDN.</li> + <li>Your locale is a good fit for MDN.</li> + <li>As a localization leader, you are easy to work with and responsive to feedback.</li> + </ol> + </li> +</ol> + +<h2 id="Organizar_um_projeto_de_localização_mecânica_da_MDN">Organizar um projeto de localização: mecânica da MDN</h2> + +<p>The basic structure of the page hierarchy in each of the localizations of MDN should be essentially the same. In general, you should try to maintain the same hierarchy of pages as the en-US (English) locale, so that each page in each language corresponds to a similar page in each locale.</p> + +<p>You are welcome to link to external local pages, write your own articles, and translate everything from the English wiki. If you do decide to write your own articles, it would be helpful if you could provide an English translation for the English wiki so it can then get translated into all of the other localized wikis.</p> + +<p>In adding local resources, you should keep a neutral point of view; that is, you shouldn't promote a particular perspective, and should instead simply provide the facts as best as possible (see information about the <a href="https://en.wikipedia.org/wiki/NPOV">NPOV</a> rule on Wikipedia). You should not link to commercial sites (like paid courses, web design companies, etc.). You should promote open standards and cross-browser compatibility over closed or proprietary methods wherever possible.</p> + +<div class="note"> +<p>Team leads are encouraged to monitor their locale's content for spam and other inappropriate materials and take steps to get them removed or corrected.</p> +</div> + +<p>There are lots of great tips from various existing translation teams; you should feel free to adopt any of these ideas you choose. In addition, please feel free to add your own suggestions as well. See <a href="/profiles/traducción">this template</a> in the Spanish wiki for an example.</p> + +<ul> + <li>Use a macro to identify articles that are in the process of being translated. The macro should provide an information box that includes a link to the original version of the article. You may also wish to use page tags to indicate pages that need more translation work. This helps track articles that are in the process of being translated.</li> + <li>Use a macro to include articles that need to be translated in article lists with a flag or marker next to them indicating that the article hasn't been translated yet. This is a way to advertise important articles in need of translation. See <a href="/profiles/tradúceme">this template</a> in the Spanish version of MDN for an example.</li> + <li>Use the "Needs technical review" and "Needs editorial review" flags, to mark articles that have been translated but should be double-checked for technical and grammatical accuracy.</li> + <li>Use the "junk" tag to mark pages that need to be deleted. Since only admins have access to delete articles, this provides a way to mark that an article is obsolete until the admins get the page deleted.</li> + <li>Be sure to include translations of these MDN "how to" pages, and include additional pages as necessary to explain your localization team's policies and practices.</li> +</ul> + +<p>To find help with your project, be sure to ask around on the <a href="https://discourse.mozilla-community.org/c/mdn">MDN discussion forum</a>, the <a href="irc://irc.mozilla.org/mdn">#mdn</a> IRC channel, and other MDN-related discussion areas. See "<a href="/en-US/docs/Project:MDN/Contributing/Join_the_community">Join the MDN community</a>" for pointers to community discussion channels that will help you find others interested in joining your localization team.</p> + +<p>You may also be able to find others interested in helping you by attending local Web development events, at your local hacker space, and the like. Be creative!</p> + +<h2 id="Organizar_uma_comunidade_de_localização">Organizar uma comunidade de localização</h2> + +<h3 id="Trabalhar_com_quaisquer_comunidades_existentes_de_localização_da_Mozilla">Trabalhar com quaisquer comunidades existentes de localização da Mozilla</h3> + +<p>Experience has shown that the most active and successful localization communities on MDN are extensions of existing Mozilla localization communities. If you’re interested in starting a localization on MDN, and you’re not already in contact with the Mozilla community for your locale, <a href="https://wiki.mozilla.org/L10n:Teams">look them up</a> and get in touch. You’ll find some great folks with experience to share about Mozilla and localization.</p> + +<h3 id="Muitas_pessoas_envolvidas">Muitas pessoas envolvidas</h3> + +<p>We’ve also seen that the more people are involved in a localization effort, the more likely it is to be self-sustaining. People come and go in a localization effort (like most things in life). The more people are involved, the more likely it is for the group to sustain through those changes. Efforts that are started by one person or a small group usually do not remain active longer than the initial members. Therefore, a big part of starting a localization effort is recruiting enough people so that the group keeps going even when some people drop out, as they inevitably do.</p> + +<h3 id="Reunir_regularmente_pessoalmente_ou_on-line">Reunir regularmente, pessoalmente ou on-line</h3> + +<p>Meeting regularly with other localizers can be a great way to build a sense of group cohesion, so that people want to keep participating. Meeting face-to-face is great if everyone is located closely together enough to be able to do that. You can meet virtually online if your group is spread too far apart to meet in person. Meeting on a regular schedule, such as once a month, is also important, so that members of the group can plan to attend. Some localizers may contribute only during a meet-up, and not at other times.</p> + +<h2 id="O_que_traduzir_primeiro">O que traduzir primeiro</h2> + +<p>A MDN tem milhares de artigos em diferentes áreas temáticas. Talvez seja apaixonado por um tópico em particular - por todos os meios, comece lá! Mas se está à procura por pontos de partida, aqui estão algumas sugestões :</p> + +<ul> + <li><a href="/pt-PT/docs/tag/l10n%3Apriority">Páginas etiquetadas "l10n:priority"</a></li> + <li>Guias da <a href="/pt-PT/docs/Learn">Área de Aprendizagem</a></li> + <li>O <a href="/pt-PT/docs/Web/JavaScript/Guia">guia de JavaScript</a></li> + <li>Páginas de <a href="/pt-PT/docs/Web/HTML/Referencia">Referência HTML</a> para elementos comuns</li> + <li>Documentos <a href="/pt-PT/docs/Web/CSS">CSS</a></li> +</ul> + +<p>Para alguns idiomas, os localizadores consideram que os guias e tutoriais são uma prioridade maior do que as páginas de referência. Os programadores da Web geralmente podem descobrir sintaxe de código da versão inglesa de uma página, mesmo que eles não sibam muito de inglês. Mas aprender novos conceitos é muito mais confortável no idioma nativo. Então, pode ser importante traduzir primeiro os tutoriais.</p> + +<h2 id="Política">Política</h2> + +<p>Todos os materiais criados e traduzidos para a MDN deverão seguir as nossas <a href="/pt-PT/docs/MDN/Sobre#Direitos_de_Autor_e_Licenças">Políticas de Licensiamento e Direitos de Autor</a>.</p> + +<p>Se encontrar problemas de qualquer género — técnico, política, ou outros — por favor, contacte a <a href="mailto:mdn-admins@mozilla.org?subject=Localization%20question" title="Contact the MDN administration team">equipa de administração da MDN</a>.</p> diff --git a/files/pt-pt/mdn/contribute/localize/projetos_localização/index.html b/files/pt-pt/mdn/contribute/localize/projetos_localização/index.html new file mode 100644 index 0000000000..2cb67a3cf7 --- /dev/null +++ b/files/pt-pt/mdn/contribute/localize/projetos_localização/index.html @@ -0,0 +1,1048 @@ +--- +title: Projetos de localização +slug: MDN/Contribute/Localize/Projetos_localização +tags: + - Comunidade + - Localização + - Metdados MDN + - Referencia + - Tradução + - l10n +translation_of: MDN/Contribute/Localize/Localization_projects +--- +<div>{{MDNSidebar}}</div><p><span class="seoSummary">Todo o trabalho de localização na MDN é efetuado por uma comunidade de voluntários fantásticos. Este artigo lista os projetos de localização, alguns deles com colaboradores ativos, e outros detalhes.</span></p> + +<p>Se pretender começar e iniciar uma tradução, consulte as páginas de <a href="/pt-PT/docs/MDN/Contribute/Localize/Translating_pages">Tradução da MDN</a>.</p> + +<div class="note"> +<p><strong>Nota:</strong> não hesite em adicionar o seu nome a esta página se estiver interessado em ser contatado por outros colaboradores sobre os esforços num local específico. Por favor, certifique-se que o seu perfil MDN mostra um modo de contacto, tais como Twitter ou outras redes sociais. Os nomes nesta página são curados para remover pessoas que não contribuíram para a MDN nos últimos 12 meses.</p> +</div> + +<details><summary> +<h2 id="af_Afrikaans">af: Afrikaans</h2> +</summary> + +<ul> + <li><a href="https://developer.mozilla.org/af/dashboards/revisions?locale=af">Latest changes</a></li> + <li>Status overview</li> + <li>Discussions</li> + <li>Current contributors</li> + <li><a href="https://wiki.mozilla.org/L10n:Teams:af">Mozilla localization project</a></li> + <li>MDN team page</li> + <li>How to help</li> + <li>Conventions</li> + <li><a href="https://pontoon.mozilla.org/af/mdn/">Translate the MDN interface</a></li> +</ul> +</details> + +<details><summary> +<h2 id="ar_العربية_Arabic">ar: العربية [Arabic]</h2> +</summary> + +<ul> + <li><a href="https://developer.mozilla.org/ar/dashboards/revisions?locale=ar&user=&topic=&start_date=&end_date=&preceding_period=&page=1">Latest changes</a></li> + <li>Status overview</li> + <li>Discussions</li> + <li>Current contributors</li> + <li><a href="https://wiki.mozilla.org/L10n:Teams:ar">Mozilla localization project</a></li> + <li>MDN team page</li> + <li>How to help</li> + <li>Conventions</li> + <li><a href="https://pontoon.mozilla.org/ar/mdn/">Translate the MDN interface</a></li> +</ul> +</details> + +<details><summary> +<h2 id="az_Azərbaycanca_Azerbaijani">az: Azərbaycanca [Azerbaijani]</h2> +</summary> + +<ul> + <li><a href="https://developer.mozilla.org/az/dashboards/revisions?locale=az&user=&topic=&start_date=&end_date=&preceding_period=&page=1">Latest changes</a></li> + <li>Status overview</li> + <li>Discussions</li> + <li>Current contributors: {{userlink("mastizada","Emin Mastizada")}}</li> + <li><a href="https://wiki.mozilla.org/L10n:Teams:az">Mozilla localization project</a></li> + <li>MDN team page</li> + <li>How to help</li> + <li>Conventions</li> + <li><a href="https://pontoon.mozilla.org/az/mdn/">Translate the MDN interface</a></li> +</ul> +</details> + +<details><summary> +<h2 id="bm_Bamanankan_Bambara">bm: Bamanankan [Bambara]</h2> +</summary> + +<ul> + <li><a href="https://developer.mozilla.org/bm/dashboards/revisions?locale=bm&user=&topic=&start_date=&end_date=&preceding_period=&page=1">Latest changes</a></li> + <li>Status overview</li> + <li>Discussions</li> + <li>Current contributors</li> + <li><a href="https://wiki.mozilla.org/L10n:Teams:bm">Mozilla localization project</a></li> + <li>MDN team page</li> + <li>How to help</li> + <li>Conventions</li> + <li><a href="https://pontoon.mozilla.org/pt-PT/mdn/">Traduza a interface da MDN</a></li> +</ul> +</details> + +<details><summary> +<h2 id="bn-BD_বাংলা_(বাংলাদেশ)_Bengali_Bangladesh">bn-BD: বাংলা (বাংলাদেশ) [Bengali, Bangladesh]</h2> +</summary> + +<ul> + <li><a href="https://developer.mozilla.org/bn-BD/dashboards/revisions?locale=bn-BD&user=&topic=&start_date=&end_date=&preceding_period=&page=1">Latest changes</a></li> + <li><a href="https://developer.mozilla.org/bn-BD/docs/MDN/Doc_status/Overview">Status overview</a></li> + <li>Discussions</li> + <li>Current contributors: {{userlink("badsha_eee","Sekander Badsha")}}</li> + <li><a href="https://wiki.mozilla.org/L10n:Teams:bn-BD">Mozilla localization project</a></li> + <li><a href="https://developer.mozilla.org/bn-BD/docs/Project:MDN/%E0%A6%85%E0%A6%AC%E0%A6%A6%E0%A6%BE%E0%A6%A8/mozillabd-l10n-team">MDN team page</a></li> + <li>How to help</li> + <li>Conventions</li> + <li><a href="https://pontoon.mozilla.org/bn_BD/mdn/">Translate the MDN interface</a></li> +</ul> +</details> + +<details><summary> +<h2 id="bn-IN_বাংলা_(ভারত)_Bengali_Índia">bn-IN: বাংলা (ভারত) [Bengali, Índia]</h2> +</summary> + +<ul> + <li><a href="https://developer.mozilla.org/bn-IN/dashboards/revisions?locale=bn-IN&user=&topic=&start_date=&end_date=&preceding_period=&page=1">Latest changes</a></li> + <li>Status overview</li> + <li>Current contributors</li> + <li><a href="https://wiki.mozilla.org/L10n:Teams:bn-IN">Mozilla localization project</a></li> + <li>MDN team page</li> + <li>How to help</li> + <li>Conventions</li> + <li><a href="https://pontoon.mozilla.org/bn_IN/mdn/">Translate the MDN interface</a></li> +</ul> +</details> + +<details><summary> +<h2 id="ca_Català_Catalan">ca: Català [Catalan]</h2> +</summary> + +<ul> + <li><a href="https://developer.mozilla.org/ca/dashboards/revisions?locale=ca&user=&topic=&start_date=&end_date=&preceding_period=&page=1">Latest changes</a></li> + <li>Status overview</li> + <li>Current contributors</li> + <li><a href="https://wiki.mozilla.org/L10n:Teams:ca">Mozilla localization project</a></li> + <li>MDN team page</li> + <li>How to help</li> + <li>Conventions</li> + <li>Translate the MDN interface</li> +</ul> +</details> + +<details><summary> +<h2 id="cs_Čeština_Czech">cs: Čeština [Czech]</h2> +</summary> + +<ul> + <li><a href="https://developer.mozilla.org/cs/dashboards/revisions?locale=cs&user=&topic=&start_date=&end_date=&preceding_period=&page=1">Latest changes</a></li> + <li>Status overview</li> + <li>Current contributors</li> + <li><a href="https://wiki.mozilla.org/L10n:Teams:cs">Mozilla localization project</a></li> + <li>MDN team page</li> + <li>How to help</li> + <li>Conventions</li> + <li>Translate the MDN interface</li> +</ul> +</details> + +<details><summary> +<h2 id="de_Deutsch_German">de: Deutsch [German]</h2> +</summary> + +<ul> + <li><a href="https://developer.mozilla.org/de/dashboards/revisions?locale=de&user=&topic=&start_date=&end_date=&preceding_period=&page=1">Latest changes</a></li> + <li><a href="https://developer.mozilla.org/de/docs/MDN/Doc_status/Overview">Status overview</a></li> + <li>Current contributors: {{userlink("fscholz")}}{{ref('*')}}, {{userlink("AlexPl")}}, {{userlink("SJW")}}, {{userlink("SebastianZ","Sebastian Zartner")}}</li> + <li><a href="https://wiki.mozilla.org/L10n:Teams:de">Mozilla localization project</a></li> + <li>MDN team page</li> + <li>How to help</li> + <li>Conventions</li> + <li><a href="https://pontoon.mozilla.org/de/mdn/">Translate the MDN interface</a></li> +</ul> +</details> + +<details><summary> +<h2 id="ee_Eʋe_Ewe">ee: Eʋe [Ewe]</h2> +</summary> + +<ul> + <li><a href="https://developer.mozilla.org/ee/dashboards/revisions?locale=ee&user=&topic=&start_date=&end_date=&preceding_period=&page=1">Latest changes</a></li> + <li>Status overview</li> + <li>Current contributors</li> + <li>Mozilla localization project</li> + <li>MDN team page</li> + <li>How to help</li> + <li>Conventions</li> + <li><a href="https://pontoon.mozilla.org/ee/mdn/">Translate the MDN interface</a></li> +</ul> +</details> + +<details><summary> +<h2 id="el_Ελληνικά_Greek">el: Ελληνικά [Greek]</h2> +</summary> + +<ul> + <li><a href="https://developer.mozilla.org/el/dashboards/revisions?locale=el&user=&topic=&start_date=&end_date=&preceding_period=&page=1">Latest changes</a></li> + <li>Status overview</li> + <li>Current contributors</li> + <li><a href="https://wiki.mozilla.org/L10n:Teams:el">Mozilla localization project</a></li> + <li>MDN team page</li> + <li>How to help</li> + <li>Conventions</li> + <li><a href="https://pontoon.mozilla.org/el/mdn/">Translate the MDN interface</a></li> +</ul> +</details> + +<details><summary> +<h2 id="es_Español_Spanish">es: Español [Spanish]</h2> +</summary> + +<ul> + <li><a href="https://developer.mozilla.org/es/dashboards/revisions?locale=es&user=&topic=&start_date=&end_date=&preceding_period=&page=1">Latest changes</a></li> + <li><a href="https://developer.mozilla.org/es/docs/MDN/Doc_status/Overview">Status overview</a></li> + <li>Current contributors: {{userlink("maedca","Manuel Camacho")}}{{ref('*')}}, {{userlink("ccarruitero")}}, {{userlink("StripTM")}}, {{userlink("Jorge.villalobos")}}</li> + <li><a href="https://wiki.mozilla.org/L10n:Teams:es">Mozilla localization project</a></li> + <li>MDN team page</li> + <li>How to help</li> + <li><a href="https://developer.mozilla.org/es/docs/Project%3AGu%C3%ADa_de_estilo">Conventions</a></li> + <li><a href="https://pontoon.mozilla.org/es/mdn/">Translate the MDN interface</a></li> +</ul> +</details> + +<details><summary> +<h2 id="fa_فارسی_Persian">fa: فارسی [Persian]</h2> +</summary> + +<ul> + <li><a href="https://developer.mozilla.org/fa/dashboards/revisions?locale=fa&user=&topic=&start_date=&end_date=&preceding_period=&page=1">Latest changes</a></li> + <li><a href="https://developer.mozilla.org/fa/docs/MDN/Doc_status/Overview">Status overview</a></li> + <li>Current contributors: {{userlink("kazem82","Kazem Ebrahimi")}}</li> + <li><a href="https://wiki.mozilla.org/L10n:Teams:fa">Mozilla localization project</a></li> + <li>MDN team page</li> + <li>How to help</li> + <li>Conventions</li> + <li><a href="https://pontoon.mozilla.org/fa/mdn/LC_MESSAGES/">Translate the MDN interface</a></li> +</ul> +</details> + +<details><summary> +<h2 id="ff_Pulaar-Fulfulde_Fulah">ff: Pulaar-Fulfulde [Fulah]</h2> +</summary> + +<ul> + <li><a href="https://developer.mozilla.org/ff/dashboards/revisions?locale=ff&user=&topic=&start_date=&end_date=&preceding_period=&page=1">Latest changes</a></li> + <li>Status overview</li> + <li>Discussions</li> + <li>Current contributors</li> + <li><a href="https://wiki.mozilla.org/L10n:Teams:ff">Mozilla localization project</a></li> + <li>MDN team page</li> + <li>How to help</li> + <li>Conventions</li> + <li><a href="https://pontoon.mozilla.org/ff/mdn/">Translate the MDN interface</a></li> +</ul> +</details> + +<details><summary> +<h2 id="fi_suomi_Finnish">fi: suomi [Finnish]</h2> +</summary> + +<ul> + <li><a href="https://developer.mozilla.org/fi/dashboards/revisions?locale=fi&user=&topic=&start_date=&end_date=&preceding_period=&page=1">Latest changes</a></li> + <li>Status overview</li> + <li>Discussions</li> + <li>Current contributors</li> + <li><a href="https://wiki.mozilla.org/L10n:Teams:fi">Mozilla localization project</a></li> + <li>MDN team page</li> + <li>How to help</li> + <li>Conventions</li> + <li>Translate the MDN interface</li> +</ul> +</details> + +<details><summary> +<h2 id="fr_Français_French">fr: Français [French]</h2> +</summary> + +<ul> + <li><a href="https://developer.mozilla.org/fr/dashboards/revisions?locale=fr&user=&topic=&start_date=&end_date=&preceding_period=&page=1">Latest changes / Dernières éditions</a></li> + <li><a href="https://developer.mozilla.org/fr/docs/MDN/Doc_status/Overview">Status overview / Statut de la localisation</a></li> + <li><a href="http://mozfr.org/mailman/listinfo/moz-fr/">Discussions (moz-fr mailiing list)</a></li> + <li>Current contributors: {{userlink("Jeremie","Jeremie Patonnier")}}{{ref('*')}}, {{userlink("SphinxKnight", "Sphinx")}}{{ref('*')}}, {{userlink("FredB")}}, {{userlink("BenoitL","Benoit Leseul")}}, {{userlink("tregagnon","Thierry Régagnon (tregagnon)")}}, {{userlink("Goofy")}}, {{userlink("the%20prisoner","the prisoner")}},{{userlink("Delapouite")}}, {{userlink("Daz")}}</li> + <li><a href="https://wiki.mozilla.org/L10n:Teams:fr">Mozilla localization project</a></li> + <li>MDN team page</li> + <li>How to help</li> + <li>Conventions</li> + <li><a href="https://pontoon.mozilla.org/fr/mdn/">Translate the MDN interface / Traduire l'interface</a></li> +</ul> +</details> + +<details><summary> +<h2 id="fy-NL_Frysk_(Netherlands)_Frisian">fy-NL: Frysk (Netherlands) [Frisian]</h2> +</summary> + +<ul> + <li><a href="https://developer.mozilla.org/fy-NL/dashboards/revisions?locale=fy-NL&user=&topic=&start_date=&end_date=&preceding_period=&page=1">Latest changes</a></li> + <li>Status overview</li> + <li>Discussions</li> + <li>Current contributors</li> + <li><a href="https://wiki.mozilla.org/L10n:Teams:fy-NL">Mozilla localization project</a></li> + <li>MDN team page</li> + <li>How to help</li> + <li>Conventions</li> + <li><a href="https://pontoon.mozilla.org/fy/mdn/">Translate the MDN interface</a></li> +</ul> +</details> + +<details><summary> +<h2 id="ga-IL_Gaelige_(Ireland)_Gaelic">ga-IL: Gaelige (Ireland) [Gaelic]</h2> +</summary> + +<ul> + <li><a href="https://developer.mozilla.org/ga-IE/dashboards/revisions?locale=ga-IE&user=&topic=&start_date=&end_date=&preceding_period=&page=1">Latest changes</a></li> + <li>Status overview</li> + <li>Discussions</li> + <li>Current contributors</li> + <li><a href="https://wiki.mozilla.org/L10n:Teams:ga-IE">Mozilla localization project</a></li> + <li>MDN team page</li> + <li>How to help</li> + <li>Conventions</li> + <li><a href="https://pontoon.mozilla.org/ga/mdn/">Translate the MDN interface</a></li> +</ul> +</details> + +<details><summary> +<h2 id="ha_Hausa">ha: Hausa</h2> +</summary> + +<ul> + <li><a href="https://developer.mozilla.org/ha/dashboards/revisions?locale=ha&user=&topic=&start_date=&end_date=&preceding_period=&page=1">Latest changes</a></li> + <li>Status overview</li> + <li>Discussions</li> + <li>Current contributors</li> + <li><a href="https://wiki.mozilla.org/L10n:Teams:ha">Mozilla localization project</a></li> + <li>MDN team page</li> + <li>How to help</li> + <li>Conventions</li> + <li><a href="https://pontoon.mozilla.org/ha/mdn/">Translate the MDN interface</a></li> +</ul> +</details> + +<details><summary> +<h2 id="he_עברית_Hebrew">he: עברית [Hebrew]</h2> +</summary> + +<ul> + <li><a href="https://developer.mozilla.org/he/dashboards/revisions?locale=he&user=&topic=&start_date=&end_date=&preceding_period=&page=1">Latest changes</a></li> + <li>Status overview</li> + <li>Discussions</li> + <li>Current contributors: {{userlink("Inkbug")}}</li> + <li><a href="https://wiki.mozilla.org/L10n:Teams:he">Mozilla localization project</a></li> + <li>MDN team page</li> + <li>How to help</li> + <li>Conventions</li> + <li><a href="https://pontoon.mozilla.org/he/mdn/">Translate the MDN interface</a></li> +</ul> +</details> + +<details><summary> +<h2 id="hi-IN_हिन्दी_(भारत)_Hindi">hi-IN: हिन्दी (भारत) [Hindi]</h2> +</summary> + +<ul> + <li><a href="https://developer.mozilla.org/hi-IN/dashboards/revisions?locale=hi-IN&user=&topic=&start_date=&end_date=&preceding_period=&page=1">Latest changes</a></li> + <li>Status overview</li> + <li>Discussions</li> + <li>Current contributors: {{userlink("flashadicts")}}</li> + <li><a href="https://wiki.mozilla.org/L10n:Teams:hi-IN">Mozilla localization project</a></li> + <li>MDN team page</li> + <li>How to help</li> + <li>Conventions</li> + <li><a href="https://pontoon.mozilla.org/hi_IN/mdn/">Translate the MDN interface</a></li> +</ul> +</details> + +<details><summary> +<h2 id="hr_Hrvatski_Croatian">hr: Hrvatski [Croatian]</h2> +</summary> + +<ul> + <li><a href="https://developer.mozilla.org/hr/dashboards/revisions?locale=hr&user=&topic=&start_date=&end_date=&preceding_period=&page=1">Latest changes</a></li> + <li>Status overview</li> + <li>Discussions</li> + <li>Current contributors</li> + <li><a href="https://wiki.mozilla.org/L10n:Teams:hr">Mozilla localization project</a></li> + <li>MDN team page</li> + <li>How to help</li> + <li>Conventions</li> + <li><a href="https://pontoon.mozilla.org/hr/mdn/">Translate the MDN interface</a></li> +</ul> +</details> + +<details><summary> +<h2 id="hu_magyar_Hungarian">hu: magyar [Hungarian]</h2> +</summary> + +<ul> + <li><a href="https://developer.mozilla.org/hu/dashboards/revisions?locale=hu&user=&topic=&start_date=&end_date=&preceding_period=&page=1">Latest changes</a></li> + <li>Status overview</li> + <li>Discussions</li> + <li>Current contributors</li> + <li><a href="https://wiki.mozilla.org/L10n:Teams:hu">Mozilla localization project</a></li> + <li>MDN team page</li> + <li>How to help</li> + <li>Conventions</li> + <li><a href="https://pontoon.mozilla.org/hu/mdn/">Translate the MDN interface</a></li> +</ul> +</details> + +<details><summary> +<h2 id="id_Bahasa_Indonesia_Indonesian">id: Bahasa Indonesia [Indonesian]</h2> +</summary> + +<ul> + <li><a href="https://developer.mozilla.org/id/dashboards/revisions?locale=id&user=&topic=&start_date=&end_date=&preceding_period=&page=1">Latest changes</a></li> + <li>Status overview</li> + <li>Discussions</li> + <li>Current contributors: {{userlink("ariestiyansyah")}}</li> + <li><a href="https://wiki.mozilla.org/L10n:Teams:id">Mozilla localization project</a></li> + <li>MDN team page</li> + <li>How to help</li> + <li>Conventions</li> + <li><a href="https://pontoon.mozilla.org/id/mdn/">Translate the MDN interface</a></li> +</ul> +</details> + +<details><summary> +<h2 id="ig_Igbo">ig: Igbo</h2> +</summary> + +<ul> + <li><a href="https://developer.mozilla.org/ig/dashboards/revisions?locale=ig&user=&topic=&start_date=&end_date=&preceding_period=&page=1">Latest changes</a></li> + <li>Status overview</li> + <li>Discussions</li> + <li>Current contributors</li> + <li><a href="https://wiki.mozilla.org/L10n:Teams:ig">Mozilla localization project</a></li> + <li>MDN team page</li> + <li>How to help</li> + <li>Conventions</li> + <li><a href="https://pontoon.mozilla.org/ig/mdn/">Translate the MDN interface</a></li> +</ul> +</details> + +<details><summary> +<h2 id="it_Italiano_Italian">it: Italiano [Italian]</h2> +</summary> + +<ul> + <li><a href="https://developer.mozilla.org/ig/dashboards/revisions?locale=it&user=&topic=&start_date=&end_date=&preceding_period=&page=1">Latest changes</a></li> + <li><a href="https://developer.mozilla.org/it/MDN/Doc_status/Overview">Status overview</a></li> + <li>Discussions: <a href="https://translate.googleusercontent.com/translate_c?depth=1&hl=en&rurl=translate.google.com&sl=auto&tl=en&u=http://forum.mozillaitalia.org/&usg=ALkJrhhzVkkb--9tarnQhoYRv6OonR79Tg">Mozilla Italia</a></li> + <li>Current contributors: {{userlink("EdoPut")}}, {{userlink("klez")}}</li> + <li><a href="https://wiki.mozilla.org/L10n:Teams:it">Mozilla localization project</a></li> + <li>MDN team page</li> + <li><a href="/it/MDN/Contribute/Localize/GuidaItaliano">How to help</a></li> + <li>Conventions</li> + <li><a href="https://pontoon.mozilla.org/it/mdn/">Translate the MDN interface</a></li> +</ul> +</details> + +<details><summary> +<h2 id="ja_日本語_Japanese">ja: 日本語 [Japanese]</h2> +</summary> + +<ul> + <li><a href="https://developer.mozilla.org/ja/dashboards/revisions?locale=ja&user=&topic=&start_date=&end_date=&preceding_period=&page=1">Latest changes</a></li> + <li><a href="https://developer.mozilla.org/ja/docs/MDN/Doc_status/Overview">Status overview</a></li> + <li>Discussions: <a href="https://groups.google.com/forum/#!forum/mozilla-translations-ja">Mozilla.translations.ja</a></li> + <li>Current contributors: {{userlink("kohei.yoshino","Yoshino (ex.Mozilla Japan)")}}, {{userlink("myakura","myakura (Masataka Yakura)")}}, {{userlink("yyss")}}, {{userlink("Marsf","Marsf (Masahiko Imanaka)")}}, {{userlink("Masayuki")}}, {{userlink("saneyuki_s")}}, {{userlink("Taken","Taken (Takeshi Kurosawa)")}}, {{userlink("Potappo")}}, {{userlink("dynamis","dynamis (Tomoya Asai)")}}, {{userlink("mantaroh")}}, {{userlink("hamasaki")}}</li> + <li><a href="https://wiki.mozilla.org/L10n:Teams:ja">Mozilla localization project</a></li> + <li>MDN team page</li> + <li>How to help: We are taking a bit long time in transition from old resources, <a href="https://developer.mozilla.org/ja/docs/Project:%E6%97%A5%E6%9C%AC%E8%AA%9E%E7%89%88">MDC Japan Project</a> (-2009), those include some useful information.</li> + <li><a href="/ja/docs/MDN/Contribute/Content/Writing_style_guide">Conventions</a></li> + <li><a href="https://pontoon.mozilla.org/ja/mdn/">Translate the MDN interface</a></li> +</ul> +</details> + +<details><summary> +<h2 id="ka_ქართული_Georgian">ka: ქართული [Georgian]</h2> +</summary> + +<ul> + <li><a href="https://developer.mozilla.org/ka/dashboards/revisions?locale=ka&user=&topic=&start_date=&end_date=&preceding_period=&page=1">Latest changes</a></li> + <li>Status overview</li> + <li>Discussions</li> + <li>Current contributors</li> + <li><a href="https://wiki.mozilla.org/L10n:Teams:ka">Mozilla localization project</a></li> + <li>MDN team page</li> + <li>How to help</li> + <li>Conventions</li> + <li>Translate the MDN interface</li> +</ul> +</details> + +<details><summary> +<h2 id="ko_한국어_Korean">ko: 한국어 [Korean]</h2> +</summary> + +<ul> + <li><a href="https://developer.mozilla.org/ko/dashboards/revisions?locale=ko&user=&topic=&start_date=&end_date=&preceding_period=&page=1">Latest changes</a></li> + <li>Status overview</li> + <li>Discussions: <a href="https://groups.google.com/forum/#!forum/mdckorea">mdckorea</a></li> + <li>Current contributors:</li> + <li><a href="https://wiki.mozilla.org/L10n:Teams:ko">Mozilla localization project</a></li> + <li><a href="/ko/docs/Project:Korean_Contributors">MDN team page</a></li> + <li>How to help</li> + <li>Conventions</li> + <li><a href="https://pontoon.mozilla.org/ko/mdn/">Translate the MDN interface</a></li> +</ul> +</details> + +<details><summary> +<h2 id="ln_Lingála">ln: Lingála</h2> +</summary> + +<ul> + <li><a href="https://developer.mozilla.org/ln/dashboards/revisions?locale=ln&user=&topic=&start_date=&end_date=&preceding_period=&page=1">Latest changes</a></li> + <li>Status overview</li> + <li>Discussions</li> + <li>Current contributors</li> + <li>Mozilla localization project</li> + <li>MDN team page</li> + <li>How to help</li> + <li>Conventions</li> + <li><a href="https://pontoon.mozilla.org/ln/mdn/">Translate the MDN interface</a></li> +</ul> +</details> + +<details><summary> +<h2 id="mg_Malagasy">mg: Malagasy</h2> +</summary> + +<ul> + <li><a href="https://developer.mozilla.org/mg/dashboards/revisions?locale=mg&user=&topic=&start_date=&end_date=&preceding_period=&page=1">Latest changes</a></li> + <li>Status overview</li> + <li>Discussions</li> + <li>Current contributors</li> + <li><a href="https://wiki.mozilla.org/L10n:Teams:mg">Mozilla localization project</a></li> + <li>MDN team page</li> + <li>How to help</li> + <li>Conventions</li> + <li><a href="https://pontoon.mozilla.org/mg/mdn/">Translate the MDN interface</a></li> +</ul> +</details> + +<details><summary> +<h2 id="ml_മലയാളം_Malayalam">ml: മലയാളം [<span class="mw-headline" id="Malayalam_.28ml.2C_ml_IN.29">Malayalam]</span></h2> +</summary> + +<ul> + <li><a href="https://developer.mozilla.org/ml/dashboards/revisions?locale=ml&user=&topic=&start_date=&end_date=&preceding_period=&page=1">Latest changes</a></li> + <li>Status overview</li> + <li>Discussions</li> + <li>Current contributors: {{userlink("riginoommen")}}, {{userlink("abin_abraham")}},</li> + <li><a href="https://wiki.mozilla.org/L10n:Teams:ml">Mozilla localization project</a></li> + <li>MDN team page</li> + <li>How to help</li> + <li>Conventions</li> + <li><a href="https://pontoon.mozilla.org/ml/mdn/">Translate the MDN interface</a></li> +</ul> +</details> + +<details><summary> +<h2 id="ms_Melayu_Malay">ms: Melayu [Malay]</h2> +</summary> + +<ul> + <li><a href="https://developer.mozilla.org/ms/dashboards/revisions?locale=ms&user=&topic=&start_date=&end_date=&preceding_period=&page=1">Latest changes</a></li> + <li>Status overview</li> + <li>Discussions</li> + <li>Current contributors</li> + <li><a href="https://wiki.mozilla.org/L10n:Teams:ms">Mozilla localization project</a></li> + <li>MDN team page</li> + <li>How to help</li> + <li>Conventions</li> + <li><a href="https://pontoon.mozilla.org/ms/mdn/">Translate the MDN interface</a></li> +</ul> +</details> + +<details><summary> +<h2 id="my_မြန်မာဘာသာ_Myanmar">my: မြန်မာဘာသာ [Myanmar]</h2> +</summary> + +<ul> + <li><a href="https://developer.mozilla.org/my/dashboards/revisions?locale=my&user=&topic=&start_date=&end_date=&preceding_period=&page=1">Latest changes</a></li> + <li>Status overview</li> + <li>Discussions</li> + <li>Current contributors: {{userlink("SetKyarWaLar")}}, {{userlink("greenlikeorange")}}</li> + <li><a href="https://wiki.mozilla.org/L10n:Teams:my">Mozilla localization project</a></li> + <li>MDN team page</li> + <li>How to help</li> + <li>Conventions</li> + <li><a href="https://pontoon.mozilla.org/my/mdn/">Translate the MDN interface</a></li> +</ul> +</details> + +<details><summary> +<h2 id="nl_Nederlands_Dutch">nl: Nederlands [Dutch]</h2> +</summary> + +<ul> + <li><a href="https://developer.mozilla.org/nl/dashboards/revisions?locale=nl&user=&topic=&start_date=&end_date=&preceding_period=&page=1">Latest changes</a></li> + <li>Status overview</li> + <li>Discussions</li> + <li>Current contributors</li> + <li><a href="https://wiki.mozilla.org/L10n:Teams:nl">Mozilla localization project</a></li> + <li>MDN team page</li> + <li>How to help</li> + <li>Conventions</li> + <li><a href="https://pontoon.mozilla.org/nl/mdn/">Translate the MDN interface</a></li> +</ul> +</details> + +<details><summary> +<h2 id="pl_Polski_Polish">pl: Polski [Polish]</h2> +</summary> + +<ul> + <li><a href="https://developer.mozilla.org/pl/dashboards/revisions?locale=pl&user=&topic=&start_date=&end_date=&preceding_period=&page=1">Latest changes</a></li> + <li><a href="https://developer.mozilla.org/pl/docs/MDN/Doc_status/Overview">Status overview</a></li> + <li>Discussions</li> + <li>Current contributors: {{userlink("ijohnnyjohnny","Daniel M")}}</li> + <li><a href="https://wiki.mozilla.org/L10n:Teams:pl">Mozilla localization project</a></li> + <li>MDN team page</li> + <li>How to help</li> + <li>Conventions</li> + <li><a href="https://pontoon.mozilla.org/pl/mdn/">Translate the MDN interface</a></li> +</ul> +</details> + +<details><summary> +<h2 id="pt-BR_Português_(do_Brasil)_Portuguese_Brazil">pt-BR: Português (do Brasil) [Portuguese, Brazil]</h2> +</summary> + +<ul> + <li><a href="https://developer.mozilla.org/pt-BR/dashboards/revisions?locale=pt-BR&user=&topic=&start_date=&end_date=&preceding_period=&page=1">Latest changes</a></li> + <li><a href="https://developer.mozilla.org/pt-BR/docs/MDN/Doc_status/Overview">Status overview</a></li> + <li>Discussions</li> + <li>Current contributors: {{userlink("HenriqueSilverio")}}</li> + <li><a href="https://wiki.mozilla.org/L10n:Teams:pt-BR">Mozilla localization project</a></li> + <li>MDN team page</li> + <li><a href="http://mzl.la/Odmaq9">Como ajudar a MDN</a></li> + <li>Conventions</li> + <li><a href="https://pontoon.mozilla.org/pt-BR/mdn/">Translate the MDN interface</a></li> +</ul> +</details> + +<details><summary> +<h2 id="pt-PT_Português_(Europeu)_Portuguese_Portugal">pt-PT: Português (Europeu) [Portuguese, Portugal]</h2> +</summary> + +<ul> + <li><a href="https://developer.mozilla.org/pt-PT/dashboards/revisions?locale=pt-PT&user=&topic=&start_date=&end_date=&preceding_period=&page=1">Últimas alterações</a></li> + <li>Status overview</li> + <li>Discussões</li> + <li>Colaboradores atuais</li> + <li><a href="https://wiki.mozilla.org/L10n:Teams:pt-PT">Projeto de Lozalização da Mozilla</a></li> + <li>Página da equipa MDN</li> + <li>Como ajudar</li> + <li>Convenções</li> + <li><a href="https://pontoon.mozilla.org/pt-PT/mdn/">Traduza a interface da MDN</a></li> +</ul> +</details> + +<details><summary> +<h2 id="ro_română_Romanian">ro: română [Romanian]</h2> +</summary> + +<ul> + <li><a href="https://developer.mozilla.org/ro/dashboards/revisions?locale=ro&user=&topic=&start_date=&end_date=&preceding_period=&page=1">Latest changes</a></li> + <li>Status overview</li> + <li>Discussions</li> + <li>Current contributors: {{userlink("Niutenisu","Niutenisu")}}</li> + <li><a href="https://wiki.mozilla.org/L10n:Teams:ro">Mozilla localization project</a></li> + <li>MDN team page</li> + <li>How to help</li> + <li>Conventions</li> + <li><a href="https://pontoon.mozilla.org/ro/mdn/">Translate the MDN interface</a></li> +</ul> +</details> + +<details><summary> +<h2 id="ru_Русский_Russian">ru: Русский [Russian]</h2> +</summary> + +<ul> + <li><a href="https://developer.mozilla.org/ru/dashboards/revisions?locale=ru&user=&topic=&start_date=&end_date=&preceding_period=&page=1">Latest changes</a></li> + <li><a href="https://developer.mozilla.org/ru/docs/MDN/Doc_status/Overview">Status overview</a></li> + <li>Discussions</li> + <li>Current contributors: {{userlink("uleming")}}, {{userlink("kup")}}, {{userlink("bychek.ru")}}</li> + <li><a href="https://wiki.mozilla.org/L10n:Teams:ru">Mozilla localization project</a></li> + <li>MDN team page</li> + <li>How to help</li> + <li><a href="/ru/docs/Project%3AWriter's_guide">Conventions</a></li> + <li><a href="https://pontoon.mozilla.org/ru/mdn/">Translate the MDN interface</a></li> +</ul> +</details> + +<details><summary> +<h2 id="son_Soŋay_Songhay">son: Soŋay [Songhay]</h2> +</summary> + +<ul> + <li><a href="https://developer.mozilla.org/son/dashboards/revisions?locale=son&user=&topic=&start_date=&end_date=&preceding_period=&page=1">Latest changes</a></li> + <li>Status overview</li> + <li>Discussions</li> + <li>Current contributors</li> + <li><a href="https://wiki.mozilla.org/L10n:Teams:son">Mozilla localization project</a></li> + <li>MDN team page</li> + <li>How to help</li> + <li>Conventions</li> + <li><a href="https://pontoon.mozilla.org/son/mdn/">Translate the MDN interface</a></li> +</ul> +</details> + +<details><summary> +<h2 id="sq_Shqip_Albanian">sq: Shqip [Albanian]</h2> +</summary> + +<ul> + <li><a href="https://developer.mozilla.org/sq/dashboards/revisions?locale=sq&user=&topic=&start_date=&end_date=&preceding_period=&page=1">Latest changes</a></li> + <li>Status overview</li> + <li>Discussions</li> + <li>Current contributors</li> + <li><a href="https://wiki.mozilla.org/L10n:Teams:sq">Mozilla localization project</a></li> + <li>MDN team page</li> + <li>How to help</li> + <li>Conventions</li> + <li><a href="https://pontoon.mozilla.org/sq/mdn/">Translate the MDN interface</a></li> +</ul> +</details> + +<details><summary> +<h2 id="sv-SE_Svenska_Swedish">sv-SE: Svenska [Swedish]</h2> +</summary> + +<ul> + <li><a href="https://developer.mozilla.org/sv-SE/dashboards/revisions?locale=sv-SE&user=&topic=&start_date=&end_date=&preceding_period=&page=1">Latest changes</a></li> + <li>Status overview</li> + <li>Discussions</li> + <li>Current contributors</li> + <li><a href="https://wiki.mozilla.org/L10n:Teams:sv-SE">Mozilla localization project</a></li> + <li>MDN team page</li> + <li>How to help</li> + <li>Conventions</li> + <li><a href="https://pontoon.mozilla.org/sv-SE/mdn/">Translate the MDN interface</a></li> +</ul> +</details> + +<details><summary> +<h2 id="sw_Kiswahili_Swahili">sw: Kiswahili [Swahili]</h2> +</summary> + +<ul> + <li><a href="https://developer.mozilla.org/sw/dashboards/revisions?locale=sw&user=&topic=&start_date=&end_date=&preceding_period=&page=1">Latest changes</a></li> + <li>Status overview</li> + <li>Discussions</li> + <li>Current contributors</li> + <li><a href="https://wiki.mozilla.org/L10n:Teams:sw">Mozilla localization project</a></li> + <li>MDN team page</li> + <li>How to help</li> + <li>Conventions</li> + <li><a href="https://pontoon.mozilla.org/sw/mdn/">Translate the MDN interface</a></li> +</ul> +</details> + +<details><summary> +<h2 id="ta_தமிழ்_Tamil">ta: தமிழ் [Tamil]</h2> +</summary> + +<ul> + <li><a href="https://developer.mozilla.org/ta/dashboards/revisions?locale=ta&user=&topic=&start_date=&end_date=&preceding_period=&page=1">Latest changes</a></li> + <li>Status overview</li> + <li>Discussions</li> + <li>Current contributors</li> + <li><a href="https://wiki.mozilla.org/L10n:Teams:ta">Mozilla localization project</a></li> + <li>MDN team page</li> + <li>How to help</li> + <li>Conventions</li> + <li><a href="https://pontoon.mozilla.org/ta/mdn/">Translate the MDN interface</a></li> +</ul> +</details> + +<details><summary> +<h2 id="th_ไทย_Thai">th: ไทย [Thai]</h2> +</summary> + +<ul> + <li><a href="https://developer.mozilla.org/th/dashboards/revisions?locale=th&user=&topic=&start_date=&end_date=&preceding_period=&page=1">Latest changes</a></li> + <li>Status overview</li> + <li>Discussions</li> + <li>Current contributors</li> + <li><a href="https://wiki.mozilla.org/L10n:Teams:th">Mozilla localization project</a></li> + <li>MDN team page</li> + <li>How to help</li> + <li>Conventions</li> + <li><a href="https://pontoon.mozilla.org/th/mdn/">Translate the MDN interface</a></li> +</ul> +</details> + +<details><summary> +<h2 id="tl_Tagalog">tl: Tagalog</h2> +</summary> + +<ul> + <li><a href="https://developer.mozilla.org/tl/dashboards/revisions?locale=tl&user=&topic=&start_date=&end_date=&preceding_period=&page=1">Latest changes</a></li> + <li>Status overview</li> + <li>Discussions</li> + <li>Current contributors</li> + <li><a href="https://wiki.mozilla.org/L10n:Teams:tl">Mozilla localization project</a></li> + <li>MDN team page</li> + <li>How to help</li> + <li>Conventions</li> + <li><a href="https://pontoon.mozilla.org/tl/mdn/">Translate the MDN interface</a></li> +</ul> +</details> + +<details><summary> +<h2 id="tn_Setswana_Tswana">tn: Setswana [Tswana]</h2> +</summary> + +<ul> + <li><a href="https://developer.mozilla.org/tn/dashboards/revisions?locale=tn&user=&topic=&start_date=&end_date=&preceding_period=&page=1">Latest changes</a></li> + <li>Status overview</li> + <li>Discussions</li> + <li>Current contributors</li> + <li><a href="https://wiki.mozilla.org/L10n:Teams:tn">Mozilla localization project</a></li> + <li>MDN team page</li> + <li>How to help</li> + <li>Conventions</li> + <li><a href="https://pontoon.mozilla.org/tn/mdn/">Translate the MDN interface</a></li> +</ul> +</details> + +<details><summary> +<h2 id="tr_Türkçe_Turkish">tr: Türkçe [Turkish]</h2> +</summary> + +<ul> + <li><a href="https://developer.mozilla.org/tr/dashboards/revisions?locale=tr&user=&topic=&start_date=&end_date=&preceding_period=&page=1">Latest changes</a></li> + <li>Status overview</li> + <li>Discussions</li> + <li>Current contributors</li> + <li><a href="https://wiki.mozilla.org/L10n:Teams:tr">Mozilla localization project</a></li> + <li>MDN team page</li> + <li>How to help</li> + <li>Conventions</li> + <li>Translate the MDN interface</li> +</ul> +</details> + +<details><summary> +<h2 id="uk_Українська_Ukrainian">uk: Українська [Ukrainian]</h2> +</summary> + +<ul> + <li><a href="https://developer.mozilla.org/uk/dashboards/revisions?locale=uk&user=&topic=&start_date=&end_date=&preceding_period=&page=1">Latest changes</a></li> + <li>Status overview</li> + <li>Discussions</li> + <li>Current contributors</li> + <li><a href="https://wiki.mozilla.org/L10n:Teams:uk">Mozilla localization project</a></li> + <li>MDN team page</li> + <li>How to help</li> + <li>Conventions</li> + <li>Translate the MDN interface</li> +</ul> +</details> + +<details><summary> +<h2 id="vi_Tiếng_Việt_Vietnamese">vi: Tiếng Việt [Vietnamese]</h2> +</summary> + +<ul> + <li><a href="https://developer.mozilla.org/vi/dashboards/revisions?locale=vi&user=&topic=&start_date=&end_date=&preceding_period=&page=1">Latest changes</a></li> + <li>Status overview</li> + <li>Discussions</li> + <li>Current contributors</li> + <li><a href="https://wiki.mozilla.org/L10n:Teams:vi">Mozilla localization project</a></li> + <li>MDN team page</li> + <li>How to help</li> + <li>Conventions</li> + <li>Translate the MDN interface</li> +</ul> +</details> + +<details><summary> +<h2 id="wo_Wolof">wo: Wolof</h2> +</summary> + +<ul> + <li><a href="https://developer.mozilla.org/wo/dashboards/revisions?locale=wo&user=&topic=&start_date=&end_date=&preceding_period=&page=1">Latest changes</a></li> + <li>Status overview</li> + <li>Discussions</li> + <li>Current contributors</li> + <li><a href="https://wiki.mozilla.org/L10n:Teams:wo">Mozilla localization project</a></li> + <li>MDN team page</li> + <li>How to help</li> + <li>Conventions</li> + <li><a href="https://pontoon.mozilla.org/wo/mdn/">Translate the MDN interface</a></li> +</ul> +</details> + +<details><summary> +<h2 id="xh_isiXhosa_Xhosa">xh: isiXhosa [Xhosa]</h2> +</summary> + +<ul> + <li><a href="https://developer.mozilla.org/xh/dashboards/revisions?locale=xh&user=&topic=&start_date=&end_date=&preceding_period=&page=1">Latest changes</a></li> + <li>Status overview</li> + <li>Discussions</li> + <li>Current contributors</li> + <li><a href="https://wiki.mozilla.org/L10n:Teams:xh">Mozilla localization project</a></li> + <li>MDN team page</li> + <li>How to help</li> + <li>Conventions</li> + <li><a href="https://pontoon.mozilla.org/xh/mdn/">Translate the MDN interface</a></li> +</ul> +</details> + +<details><summary> +<h2 id="yo_Yorùbá">yo: Yorùbá</h2> +</summary> + +<ul> + <li><a href="https://developer.mozilla.org/yo/dashboards/revisions?locale=yo&user=&topic=&start_date=&end_date=&preceding_period=&page=1">Latest changes</a></li> + <li>Status overview</li> + <li>Discussions</li> + <li>Current contributors</li> + <li><a href="https://wiki.mozilla.org/L10n:Teams:yo">Mozilla localization project</a></li> + <li>MDN team page</li> + <li>How to help</li> + <li>Conventions</li> + <li><a href="https://pontoon.mozilla.org/yo/mdn/">Translate the MDN interface</a></li> +</ul> +</details> + +<details><summary> +<h2 id="zh-CN_中文_(简体)_Chinese_simplified">zh-CN: 中文 (简体) [Chinese, simplified]</h2> +</summary> + +<ul> + <li><a href="https://developer.mozilla.org/zh-CN/dashboards/revisions?locale=zh-CN&user=&topic=&start_date=&end_date=&preceding_period=&page=1">Latest changes</a></li> + <li><a href="https://developer.mozilla.org/zh-CN/docs/MDN/Doc_status/Overview">Status overview</a></li> + <li>Discussions: {{page("/zh-CN/docs/MDN/Contribute/Localize/Localization_projects", "notes")}}</li> + <li>Current contributors: {{page("/zh-CN/docs/MDN/Contribute/Localize/Localization_projects", "leader")}}{{ref('*')}}; see the team page for other contributors.</li> + <li><a href="https://wiki.mozilla.org/L10n:Teams:zh-CN">Mozilla localization project</a></li> + <li><a href="https://developer.mozilla.org/zh-CN/docs/MDN/Contribute/Localize/Localization_projects">MDN team page</a></li> + <li>How to help</li> + <li><a href="/zh-CN/docs/MDN/Contribute/Content/Style_guide">Conventions</a></li> + <li><a href="https://pontoon.mozilla.org/zh-CN/mdn/">Translate the MDN interface</a></li> +</ul> +</details> + +<details><summary> +<h2 id="zh-TW_中文_(繁體)_Chinese_traditional">zh-TW: 中文 (繁體) [Chinese, traditional]</h2> +</summary> + +<ul> + <li><a href="https://developer.mozilla.org/zh-TW/dashboards/revisions?locale=zh-TW&user=&topic=&start_date=&end_date=&preceding_period=&page=1">Latest changes</a></li> + <li><a href="https://developer.mozilla.org/zh-TW/docs/MDN/Doc_status/Overview">Status overview</a></li> + <li>Discussions: 我們需要更多貢獻者，請到 <a href="https://groups.google.com/group/moztw-general">MozTW-general 郵件群組</a>與我們聯繫！</li> + <li>Current contributors: {{userlink("irvinfly")}}{{ref('*')}}, {{userlink("BobChao")}}, {{userlink("petercpg")}}</li> + <li><a href="https://wiki.mozilla.org/L10n:Teams:zh-TW">Mozilla localization project</a></li> + <li>MDN team page</li> + <li>How to help</li> + <li><a href="/zh-TW/docs/MDN/Contribute/Content/Style_guide">Conventions</a></li> + <li><a href="https://pontoon.mozilla.org/zh-TW/mdn/">Translate the MDN interface</a></li> +</ul> +</details> + +<details><summary> +<h2 id="zu_isiZulu_Zulu">zu: isiZulu [Zulu]</h2> +</summary> + +<ul> + <li><a href="https://developer.mozilla.org/zu/dashboards/revisions?locale=zu&user=&topic=&start_date=&end_date=&preceding_period=&page=1">Latest changes</a></li> + <li>Status overview</li> + <li>Discussions</li> + <li>Current contributors</li> + <li><a href="https://wiki.mozilla.org/L10n:Teams:zu">Mozilla localization project</a></li> + <li>MDN team page</li> + <li>How to help</li> + <li>Conventions</li> + <li><a href="https://pontoon.mozilla.org/zu/mdn/">Translate the MDN interface</a></li> +</ul> +</details> + +<p>{{endnote('*')}} O <a href="/en-US/docs/MDN/Community/Roles/Localization_driver_role">líder da localização </a>é uma pessoa que lidera uma comunidade de localização na MDN, orientando o seu trabalho na localização de conteúdo para um idioma ou tópico específico .</p> + +<h2 id="Outros_idiomas">Outros idiomas</h2> + +<p>Estes são os idiomas que não foram criados na MDN, mas onde talvez exista interesse para o fazer. Consulte <a href="/pt-PT/docs/MDN/Contribute/Localize/Iniciar_uma_localizacao">iniciar uma nova localização na MDN</a>, se pretender criar um novo idioma.</p> + +<h3 id="gu_ગુજરાતી_Gujarati">gu: ગુજરાતી [Gujarati]</h3> + +<ul> + <li><a href="https://wiki.mozilla.org/L10n:Teams:gu-IN">Projeto de localização da Mozilla</a></li> + <li>Utilizadores interessados: {{userlink("prafull_satasiya")}}</li> +</ul> + +<h3 id="haw_Hawaiian">haw: Hawaiian</h3> + +<ul> + <li><a href="https://wiki.mozilla.org/L10n:Teams:haw">Projeto de localização da Mozilla</a></li> + <li>Utilizadores interessados: {{userlink("Kolonahe")}}</li> +</ul> + +<h3 id="lo_ພາສາລາວ_Lao">lo: ພາສາລາວ [Lao]</h3> + +<ul> + <li><a href="https://wiki.mozilla.org/L10n:Teams:lo">Porjeto de localização da Mozilla</a></li> + <li>Utilizadores interessados: {{userlink("rcampbelllaos","Robert M Campbell")}}</li> +</ul> + +<h3 id="si_සිංහල_Sinhalese">si: <strong>සිංහල [Sinhalese]</strong></h3> + +<ul> + <li><a href="https://wiki.mozilla.org/L10n:Teams:si">Projeto de localização da Mozilla</a></li> + <li>Utilizadores interessados: {{userlink("pkavinda")}}</li> +</ul> + +<h3 id="sr_српски_Serbian">sr: <span lang="sr"><span class="Unicode"><span class="Unicode">српски [</span></span></span>Serbian]</h3> + +<ul> + <li><a href="https://wiki.mozilla.org/L10n:Teams:sr">Projeto de localização da Mozilla</a></li> + <li>Utilizadores interessados: {{userlink("VladimirKrstic")}}</li> +</ul> + +<h3 id="te_తెలుగు_Telugu">te: <span lang="te">తెలుగు [</span>Telugu]</h3> + +<ul> + <li><a href="https://wiki.mozilla.org/L10n:Teams:te">Projeto de localização da Mozilla</a></li> + <li>Utilizadores interessados: {{userlink("Dyvik")}}, {{userlink("ganesht")}}</li> +</ul> + +<h3 id="ur_اردو_Urdu">ur: اردو [Urdu]</h3> + +<ul> + <li><a href="https://wiki.mozilla.org/L10n:Teams:ur">Projeto de localização da Mozilla</a></li> + <li>Utilizadores interessados: {{userlink("Vaqas Iqbal")}}</li> +</ul> + +<p> </p> + +<h2 id="Consultar_também">Consultar também:</h2> + +<section id="Quick_Links"> +<ul> + <li><a href="/pt-PT/docs/MDN/Contribute/Localize/Translating_pages">Traduzir páginas da MDN</a></li> + <li><a href="/pt-PT/docs/MDN/Contribute/Localize/Iniciar_uma_localizacao">Iniciar uma nova localização na MDN</a></li> + <li><a href="/pt-PT/docs/Mozilla/Localization">Localizar software e sites da <em>Web</em> da Mozilla</a></li> + <li><a href="/pt-PT/docs/Mozilla/Localization/Localiza%C3%A7%C3%A3o_com_Pontoon">Localizar com Pontoon</a></li> +</ul> +</section> diff --git a/files/pt-pt/mdn/contribute/localize/translating_pages/index.html b/files/pt-pt/mdn/contribute/localize/translating_pages/index.html new file mode 100644 index 0000000000..ca515364e3 --- /dev/null +++ b/files/pt-pt/mdn/contribute/localize/translating_pages/index.html @@ -0,0 +1,56 @@ +--- +title: Traduzir páginas da MDN +slug: MDN/Contribute/Localize/Translating_pages +tags: + - Guía + - Localização + - Metadados da MDN + - Tradução de Página + - l10n +translation_of: MDN/Contribute/Localize/Translating_pages +--- +<div>{{MDNSidebar}}</div> + +<p>Este artigo é um guia básico para traduzir conteúdo na MDN, incluindo a mecânica do trabalho de tradução e as dicas de maneira adequada para lidar com os vários tipos de conteúdo.</p> + +<h2 id="Começar_a_tradução_de_uma_nova_página">Começar a tradução de uma nova página</h2> + +<p>Quando encontra uma página que gostaria de traduzir para o seu idioma, siga estes passos:</p> + +<ol> + <li>Clique no ícone dos Idiomas para abrir o menu dos <strong>Idiomas</strong>, e clique em <strong>Adicionar uma Tradução</strong>. A página dos Idiomas Selecionados aparece.</li> + <li>Clique no idioma que deseja utilizar na tradução da página. A visualização de Traduzir Artigo abre com o texto do idioma original exibido no lado esquerdo da visualização.</li> + <li>Sob a <strong>Descrição de Tradução</strong>, pode traduzir o título e opcionalmente a peneira rotativa para a linguagem selecionada. A "slug" é a última parte do URL de uma página (por exemplo, "Páginas de tradução" para este artigo.) Algumas comunidades de linguagens não traduzem a "slug", mantendo a mesma em Inglês. Compare com outros artigos na sua lingua, para determinar a prática comum. Pode clicar o sinal menos (-) ao lado da <strong>Descrição de Tradução</strong> para esconder esta informação quando terminar, para criar mais espaço para a seção <strong>Conteúdo de Tradução.</strong></li> + <li>Sob <strong>Conteúdo de Tradução</strong>, traduza o corpo da página.</li> + <li>Preencha pelo menos uma <strong>etiqueta</strong> para a página.</li> + <li>Clique <strong>Guardar Alterações</strong> quando terminar.</li> +</ol> + +<div class="note"><strong>Nota:</strong> os elementos da interface do utilizador da visualização do "Artigo de Tradução" são mostrados inicialmente em inglês. Nas visitas subsequentes para traduzir um artigo em particular, a interface do utilizador (IU) é mostrada no idioma apropriado se a localização da MDN estiver disponível para esse idioma. A interface do utilizador da MDN pode ser localizada, utilizando o <a href="https://pontoon.mozilla.org/projects/mdn/" title="https://localize.mozilla.org/projects/mdn/">Pontoon.</a><br> +Consulte "<a href="/pt-PT/docs/Mozilla/Localization/Localização_com_Pontoon" title="/en-US/docs/Mozilla/Localization/Localizing_with_Verbatim">Localizar com Pontoon</a>" para detalhes em como utilziar esta ferramenta.</div> + +<h2 id="Editar_uma_página_traduzida">Editar uma página traduzida</h2> + +<ul> + <li>Numa página traduzida, clique em <strong>Editar</strong> (por vezes nomeado no idioma de destino). A visualização do 'Artigo de Tradução' abre.</li> +</ul> + +<p>Se a versão inglesa foi alterada desde a última atualização da tradução, a visualização do 'Artigo de Tradução' mostra um "diff" de nível da fonte das alterações na versão inglesa. Isto ajuda-o a ver o que precisa de ser atualizado na tradução.</p> + +<h2 id="Etiquetar_traduções">Etiquetar traduções</h2> + +<p>É importante que cada página seja etiquetada pelo menos com uma etiqueta ou "tag".<br> + Mesmo que isto seja tradução.</p> + +<p>Algumas etiquetas são utilizadas para filtros de procura, ou como convenções entre colaboradores. Estas não devem ser traduzidas. Para conhecer estas etiquetas, leia as <a href="/pt-PT/docs/MDN/Contribute/Localize/Projetos_localização">Normas de Etiquetagem</a>. É livre de criar etiquetas traduzidas para o conteúdo de grupo, se isto não estiver coberto por uma das normas de etiquetas.</p> + +<h2 id="Dicas_para_os_novos_tradutores">Dicas para os novos tradutores</h2> + +<p>Se é novo na tradução (localização) na MDN, aqui estão algumas sugestões:</p> + +<ul> + <li>Os artigos no "<a href="/pt-PT/docs/Glossário">Glossário</a>" são excelentes serem traduzidos por principiantes, porque estes são curtos e simples.</li> + <li>Os artigos que estão etiquetados <a href="/en-US/docs/tag/l10n%3Apriority">"l10n:priority"</a> são considerados de alta prioridade para tradução.</li> + <li>Se ver um texto entre chaves duplas, como por exemplo <code>\{{some-text("more text")}}</code>, deixe-o não traduzido, e não modifique os caracteres de pontuação. Isto é um <a href="/en-US/docs/MDN/Contribute/Structures/Macros">macro</a>, que provavelmente cria uma estructura na página, ou tem qualquer outra função útil. É provável que veja textos não traduzidos producidos por um macro; não se preocupe com isso até que adquira mais experiência com a MDN. (Mudar este texto requere <a href="/en-US/docs/MDN/Contribute/Tools/Template_editing">privilégios</a> <a href="/en-US/docs/MDN/Contribute/Tools/Template_editing">especiais</a> porque os macros podem ser muito poderosos.) Se estiver curioso, dê uma olhada aos <a href="/en-US/docs/MDN/Contribute/Structures/Macros/Commonly-used_macros">macros mais utilizados</a> e verifique os que os macros são capazes de fazer.</li> + <li>Consulte a página "<a href="/pt-PT/docs/MDN/Contribute/Localize/Projetos_localização">Projetos de Localização</a>" para saber mais sobre a localização para o seu idioma.</li> +</ul> diff --git a/files/pt-pt/mdn/editor/basicos/index.html b/files/pt-pt/mdn/editor/basicos/index.html new file mode 100644 index 0000000000..78a0023b70 --- /dev/null +++ b/files/pt-pt/mdn/editor/basicos/index.html @@ -0,0 +1,72 @@ +--- +title: Elementos da IU do Editor +slug: MDN/Editor/Basicos +tags: + - Documentação + - Guía + - MDN + - Metadados da MDN + - Principiante + - editor +translation_of: MDN/Editor/Basics +--- +<div>{{MDNSidebar}}</div> + +<p><span class="seoSummary">O editor WYSIWYG na MDN</span> foi projetado para facilitar ao máximo a criação, edição e melhoramento de artigos e outras páginas em praticamente qualquer lugar do site. A janela do editor, mostrada abaixo, consiste em oito áreas principais. Este guia fornece informação sobre cada secção para que saiba como utilizar todo o nosso ambiente de edição.</p> + +<div class="note"> +<p>We're constantly working on improvements to MDN, so there will be times when this documentation or the screen shots below may be slightly out-of-date. We'll periodically update this documentation, though, to avoid it being unusably behind.</p> +</div> + +<p><img alt="Screenshot of the editor UI (August 2017) with each section labeled" src="https://mdn.mozillademos.org/files/15261/edit-page-with-labels.png" style="border-style: solid; border-width: 2px; height: 723px; width: 808px;"></p> + +<p>The editor UI contains the following sections, as shown above. Click a link below to read about that section of the editor.</p> + +<ul> + <li><a href="/en-US/docs/MDN/Contribute/Editor/Basics/Page_info">Page info</a></li> + <li><a href="/en-US/docs/MDN/Contribute/Editor/Basics/Page_controls">Page controls</a></li> + <li><a href="/en-US/docs/MDN/Contribute/Editor/Basics/Toolbar">Toolbar</a></li> + <li><a href="/en-US/docs/MDN/Contribute/Editor/Edit_box">Edit box</a></li> + <li><a href="/en-US/docs/MDN/Contribute/Editor/Basics/Tags">Tags</a></li> + <li><a href="#Revision_comment">Revision comment</a></li> + <li><a href="#Review_requests">Review requests</a></li> + <li><a href="/en-US/docs/MDN/Contribute/Editor/Basics/Attachments">Attachments</a></li> +</ul> + +<h2 id="Caixa_de_edição">Caixa de edição</h2> + +<p>The edit box is, of course, where you actually do your writing.</p> + +<p>Right-clicking in the editor box offers appropriate additional options depending on the context of your click: right-clicking in a table offers table-related options and right-clicking in a list offers list-related options, for example. By default, the editor uses its own contextual menu when you right-click on the editor. To access your browser's default contextual menu (such as to access the Firefox spell checker's list of suggested corrections), hold down the <kbd>Shift</kbd> or <kbd>Control</kbd> key (the <kbd>Command</kbd> key on Mac OS X) while clicking.</p> + +<p>When working in the edit box, you can use its <a href="/en-US/docs/MDN/Contribute/Editor/Edit_box">keyboard shortcuts</a>.</p> + +<h2 id="Comentário_da_revisão">Comentário da revisão</h2> + +<p>After you've made your changes, it's strongly recommended you add a comment to your revision. This is displayed in the revision history for the page, as well as on the <a href="/en-US/dashboards/revisions" title="/en-US/dashboards/revisions">Revision Dashboard</a>. It helps to explain or justify your changes to others that may review your work later. To add a revision comment, simply type the note into the revision comment box before clicking either of the <strong>Publish</strong> buttons at the top or bottom of the page.</p> + +<p>There are a few reasons this is helpful:</p> + +<ul> + <li>If the reason for your change isn't obvious, your note can explain the reasoning to others.</li> + <li>If your change is technically complex, it can explain to editors the logic behind it; this can include a bug number, for example, that editors can refer to for more information.</li> + <li>If your edit involves deleting a large amount of content, you can justify the deletion (for example, "I moved this content to article X").</li> +</ul> + +<h2 id="Pedidos_de_revisão">Pedidos de revisão</h2> + +<p>The MDN community uses <strong>reviews</strong> to try to monitor and improve the quality of MDN's content. This works by setting a flag on an article indicating that a review is needed. You can learn more about <a href="/en-US/docs/MDN/Contribute/Howto/Do_a_technical_review" title="/en-US/docs/Project:MDN/Contributing/How_to_help#Content_reviews">technical reviews</a> and <a href="/en-US/docs/MDN/Contribute/Howto/Do_an_editorial_review">editorial review</a> in the <a href="/en-US/docs/MDN/Contribute/Howto" title="/en-US/docs/Project:MDN/Contributing/How_to_help">How to</a> guides.</p> + +<p>To request a review on the article you've worked on, toggle on the checkbox next to the type of review that's needed. Technical reviews should be requested any time you make changes to the explanation of how something technical works, while editorial reviews are a good idea when you've made changes and would like someone to review your writing and style choices.</p> + +<p>While selecting a review checkbox adds the article to the lists of those <a href="/en-US/docs/needs-review/technical">needing technical review</a> or <a href="/en-US/docs/needs-review/editorial">needing editorial review</a>, it does not guarantee that anyone will immediately review the article. For technical reviews, it's a good idea to directly contact a <a href="/en-US/docs/MDN/Community/Roles/Subject-matter_experts">subject-matter expert</a> in the relevant technical area. For editorial reviews, you can post in the <a href="/https://discourse.mozilla.org/c/mdn">MDN discussion forum</a> to request that someone review your changes.</p> + +<p>Be sure to click one of the <strong>Publish</strong> buttons after making your selections, to commit your review request.</p> + +<h2 id="Consulte_também">Consulte também</h2> + +<ul> + <li><a href="https://docs.ckeditor.com/">CKEditor - Guia do Utilizador</a></li> +</ul> + +<h6 id="EditorGuideQuicklinks">{{EditorGuideQuicklinks}}<span id="cke_bm_73C" style="display: none;"> </span></h6> diff --git a/files/pt-pt/mdn/editor/index.html b/files/pt-pt/mdn/editor/index.html new file mode 100644 index 0000000000..a13dda6b6a --- /dev/null +++ b/files/pt-pt/mdn/editor/index.html @@ -0,0 +1,20 @@ +--- +title: Guia para o editor da IU da MDN +slug: MDN/Editor +tags: + - Documentação + - Guía + - Landing + - MDN + - Metadados MDN +translation_of: MDN/Editor +--- +<div>{{MDNSidebar}}</div> + +<p class="summary"><span class="seoSummary">O editor WYSIWYG (o que vê é o que obtém) para a wiki dos <strong>Documentos da Web da MDN</strong> torna fácil a contribuição para novo conteúdo. Este guia mostra-lhe como utilizar o editor e melhorar a sua produtividade. Por favor, leia e concorde com os <a href="https://www.mozilla.org/en-US/about/legal/terms/mozilla/">Termos da Mozilla</a> antes de editar ou criar novas páginas. </span></p> + +<p>O <a href="/pt-PT/docs/MDN/Contribute/linhas_diretrizes/Guia_de_estilo_de_escrita" title="Read the MDN style guide">guia de estilo de escrita da MDN</a> oferece informação sobre como formatar e estilizar o próprio conteúdo, incluindo as nossas regras de gramática e ortografia preferidas.</p> + +<p>{{LandingPageListSubpages}}</p> + +<p>{{EditorGuideQuicklinks}}</p> diff --git a/files/pt-pt/mdn/guidelines/convencoes_definicoes/index.html b/files/pt-pt/mdn/guidelines/convencoes_definicoes/index.html new file mode 100644 index 0000000000..f3a57c70c3 --- /dev/null +++ b/files/pt-pt/mdn/guidelines/convencoes_definicoes/index.html @@ -0,0 +1,201 @@ +--- +title: MDN - Convenções e Definições +slug: MDN/Guidelines/Convencoes_definicoes +tags: + - Documentação + - Guía + - Linhas Diretrizes + - MDN + - Metadados MDN +translation_of: MDN/Guidelines/Conventions_definitions +--- +<div>{{MDNSidebar}}</div> + +<div>{{IncludeSubnav("/pt-PT/docs/MDN")}}</div> + +<p class="summary">Este artigo define algumas convenções e definições que são normalmente utilizadas na MDN, que talvez não sejam óbvias para algumas pessoas quando elas as encontrarem na documentação.</p> + +<h2 id="Definições">Definições</h2> + +<h3 id="Desaprovada_e_obsoleta">Desaprovada e obsoleta</h3> + +<p><strong>Desaprovada</strong> e <strong>obsoleta</strong> são termos comuns associados com as tecnologias e especificações, mas o que eles significam?</p> + +<dl> + <dt>Desaprovada</dt> + <dd>Na MDN, o termo '<strong>desaprovada</strong>' utilizado para marcar uma API ou tecnologia que já não é recomendada, mas que ainda está implementada e poderá funcionar. Mais recentemente, nós atualizamos-la para a definição utilizada no <a href="https://github.com/mdn/browser-compat-data/blob/master/schemas/compat-data-schema.md#status-information">projeto de dados compatíveis do navegador</a>, que é que "a funcionalidade já não é mais recomendada. Esta poderá ser removida no futuro ou pode ser mantida apenas para fins de compatibilidade. Evite utilizar esta funcionalidade".</dd> + <dt>Obsoleta</dt> + <dd>No MDN, o termo '<strong>obsoleta</strong>'utilizado para marcar uma API ou tecnologia que já não é mais recomendada, mas também não é mais implementada nos navegadores. Isto foi no entanto confuso - é semelhante a obsoleta, e a distinção não é muito útil (ainda não o deveria utilizar num site de produção). Portanto, nós não estamos mais a utilizá-lo, e quaisquer instâncias encontradas deveriam ser removidas/substituídas por 'obsoleta'.</dd> +</dl> + +<h3 id="Experimental">Experimental</h3> + +<p><strong>Experimental</strong> can mean different things depending on the context you hear or read it in. When a technology is described as experimental on MDN, it means that the technology is nascent and immature, and currently in the process of being added to the Web platform (or considered for addition).</p> + +<p>One or both of these will be true:</p> + +<ul> + <li>It is implemented and enabled by default in less than two modern major browsers.</li> + <li>Its defining spec is not stable and likely to change significantly. Its syntax and behavior is therefore subject to change in future versions of browsers as the specification changes.</li> +</ul> + +<p>If one or both of these definitions is true, then you should think carefully before you start using that technology in any kind of production project (i.e. not just a demo or experiment). See also the definition of experimental in our <a href="https://github.com/mdn/browser-compat-data/blob/master/compat-data-schema.md#status-information">browser-compat-data project</a>.</p> + + + +<p>Conversely, an item is no longer experimental when:</p> + +<ul> + <li>It is implemented in two or more major browsers; or</li> + <li>Its defining spec is stable and unlikely to change.</li> +</ul> + + + +<h3 id="Páginas_arquivadas">Páginas arquivadas</h3> + +<p>Archived pages are pages that are stored in the MDN <a href="/en-US/docs/Archive">Archive of obsolete content</a>. These pages contain information out-of-date enough that it is not directly useful to anyone anymore.</p> + +<p>Most commonly, these concern Mozilla projects that have been discontinued and shouldn't be relied on anymore. But we don't simply delete them because they form a useful historical record, and some of the patterns or ideas contained within might be useful for future work. A good example is the <a href="/en-US/docs/Archive/B2G_OS">B2G (Firefox OS) project</a>.</p> + +<h4 id="Quando_é_que_uma_página_deverá_ser_arquivada">Quando é que uma página deverá ser arquivada?</h4> + +<p>A page should be archived if it fits the above description. To archive a page, you should use the "Move page feature" (<em>Advanced > Move this article</em>) to move the page into the Archive page tree (/en-US/docs/Archive). You might not have the permissions to use this feature, and before you start archiving pages you should discuss it with the MDN community first — talk to us on our <a href="https://discourse.mozilla.org/c/mdn">Discourse forum</a>.</p> + +<h3 id="Páginas_eliminadas">Páginas eliminadas</h3> + +<p>Deleted pages are pages that have been explicitly deleted from MDN — see for example the <code><a href="/en-US/docs/Web/API/SharedKeyframeList">SharedKeyframeList</a></code> interface and <code><a href="/en-US/docs/Web/API/SharedKeyframeList/SharedKeyframeList">SharedKeyframeList()</a></code> constructor. These pages contain information that is not useful in any way anymore, and/or might be incorrect to the point where keeping it available might be confusing or bad for people to know.</p> + +<p>These might be:</p> + +<ul> + <li>Reference pages for API features that were removed from the specification before they were implemented in any browsers.</li> + <li>Articles covering techniques that were later shown to be bad practice and superceded by better techniques.</li> + <li>Articles containing information that were later replaced by other, better quality articles.</li> + <li>Articles containing content that is inappropriate for MDN.</li> + <li>Translations that are old, out-of-date, and difficult to fix, meaning that the English version is preferrable and starting a new translation would be an easier option.</li> +</ul> + +<h4 id="Quando_é_que_uma_página_deverá_ser_eliminada">Quando é que uma página deverá ser eliminada?</h4> + +<p>A page should be deleted if it fits the above description. To delete a page, you should use the "Delete this page feature" (<em>Advanced > Delete this page</em>) to delete the page. You will probably not have the permissions to use this feature, and when thinking about deleting pages you should discuss it with the MDN community first — talk to us on our <a href="https://discourse.mozilla.org/c/mdn">Discourse forum</a>.</p> + + + + + +<h3 id="Quando_documentar_novas_tecnologias">Quando documentar novas tecnologias</h3> + +<p>On MDN, we are constantly looking to document new web standards technologies as appropriate. We try to strike a balance between publishing the documentation early enough so developers can learn about new features as soon as they need to, and publishing it late enough so that the technology is mature and stable so the docs won't need constant updates or rapid removal.</p> + +<p>In general, our definition of the earliest we'll consider documenting a new technology is:</p> + +<p><em>"When the feature is on a standards track and is implemented somewhere."</em></p> + +<p>You should definitely consider documenting a new technology if:</p> + +<ul> + <li>It is specified in a specification document published under a reliable standards organization (such as W3C, WHATWG, Khronos, IETF, etc.), which has reached a reasonable level of stability (e.g. a W3C working draft or candidate recommendation, or the spec is looking to be fairly stable judging by the flow of issues filed against it).</li> + <li>It is implemented consistently in at least one browser, with other browser developers showing signs of interest (such as an active ticket or "intent to implement" process in effect).</li> +</ul> + +<p>You should be more wary of documenting a new technology (but should still consider it if it makes sense) if it:</p> + +<ul> + <li>Doesn't have a spec, or the spec is a rough note that looks liable to change.</li> + <li>One or zero browsers currently implement it, and non-supporting browsers are not showing signs of interest in implementing it (you can gauge this by asking engineers who work on those browsers, looking at browser bug trackers and mailing lists, etc.).</li> +</ul> + +<p>You should not consider documenting a new technology if it:</p> + +<ul> + <li>Is not a web-exposed technology and/or is completely proprietary.</li> + <li>Is already showing signs of being deprecated, or superseded by a similar feature.</li> +</ul> + + + +<h2 id="Convenções">Convenções</h2> + +<h3 id="Quando_é_removido_algo_da_especificação">Quando é removido algo da especificação</h3> + +<p>Sometimes during the development of a new specification, or over the course of the evolution of living standards such as HTML, new elements, methods, properties, and so forth are added to the specification, stay there for a while, then get removed again. Sometimes this happens very quickly, and sometimes these new items remain in the specification for months or even years before being removed. This can make it tricky to decide how to handle the removal of the item from the spec. Here are some guidelines to help you decide what to do.</p> + +<div class="note"> +<p>For the purposes of this discussion, the word "item" is used to mean anything which can be part of a specification: an element or an attribute of an element, an interface or any individual method, property, or other member of an interface, and so forth.</p> +</div> + +<ul> + <li>If the item was <em>never</em> implemented in a release version of <em>any</em> browser—even behind a preference or flag—simply delete any references to the item from the documentation. + + <ul> + <li>If the item has any documentation pages describing only that one item (such as {{domxref("RTCPeerConnection.close()")}}), delete that page. If the removed item is an interface, this means removing any subpages describing the properties and methods on that interface as well.</li> + <li>Remove the item from any lists of properties, attributes, methods, and so forth. For methods of an interface, that means to remove it from the "Methods" section on the interface's overview page, for example.</li> + <li>Search the text of the overview page for that interface, element, etc. for any references to the removed item. Remove those references, being sure not to leave weird grammar issues or other problems with the text. This may mean not just deleting words but rewriting a sentence or paragraph to make more sense. It may also mean removing entire sections of content if the description of the item's use is lengthy.</li> + <li>Similarly, look for any discussion of the item in the guides and tutorials about the relevant API or technology. Remove those references, being sure not to leave weird grammar issues or other problems with the text. This may mean not just deleting words but rewriting a sentence or paragraph to make more sense. It may also mean removing entire sections of content if the description of the item's use is lengthy.</li> + <li>Search MDN for references to the removed item, in case there are discussions elsewhere. It's unlikely that there are, since if it was never implemented, it's unlikely to be widely discussed. Remove those mentions as well.</li> + <li>If the <a href="https://github.com/mdn/browser-compat-data">Browser Compatibility Data repository's</a> JSON files contain data for the removed items, delete those objects from the JSON code and submit a PR with that change, explaining why in the commit message and the PR description. Be careful to check that you don't break the JSON syntax while doing this.</li> + </ul> + </li> + <li>If the item was implemented in any release version of any one or more browsers—but <em>only</em> behind a preference or flag—do not delete the item from the documentation immediately. Instead, mark the item as obsolete as follows: + <ul> + <li>If the item has any documentation pages describing only that one item (such as {{domxref("RTCPeerConnection.close()")}}), add the {{TemplateLink("obsolete_header")}} macro to the top of the page and add the {{tag("Obsolete")}} tag to the page's list of tags.</li> + <li>On the overview page for the element, interface, or API, find the list of items which includes the item that's been removed from the specification and add the {{TemplateLink("obsolete_inline")}} macro after the item's name in that list.</li> + <li>Search the informative text of the overview page for that interface, element, etc. for any references to the removed item. Add warning boxes in appropriate places with text along the lines of "[whatever] has been removed from the specification and will be removed from browsers soon. See [link to page] for a new way to do this."</li> + <li>Similarly, look for any discussion of the item in the guides and tutorials about the relevant API or technology. Add similar warnings.</li> + <li>Search MDN for references to the removed item, in case there are discussions elsewhere. Add similar warning boxes there as well.</li> + <li>At some point in the future, a decision may be made to actually remove the item from the documentation; we don't normally do this but if the item was especially unutilized or uninteresting, we may decide to do so.</li> + <li>Update any relevant entries in the <a href="https://github.com/mdn/browser-compat-data">Browser Compatibility Data repo</a> to reflect the obsolescence of the item(s) affected.</li> + </ul> + </li> + <li>If the item was implemented in one or more release builds of browsers—without requiring a preference or flag to be changed—mark the item as deprecated, as follows: + <ul> + <li>If the item has any documentation pages describing only that one item (such as {{domxref("RTCPeerConnection.close()")}}), add the {{TemplateLink("deprecated_header")}} macro to the top of the page and add the {{tag("Deprecated")}} tag to the page's list of tags.</li> + <li>On the overview page for the element, interface, or API, find the list of items which includes the item that's been removed from the specification and add the {{TemplateLink("deprecated_inline")}} macro after the item's name in that list.</li> + <li>Search the informative text of the overview page for that interface, element, etc. for any references to the removed item. Add warning boxes in appropriate places with text along the lines of "[whatever] has been removed from the specification and is deprecated. It may be removed from browsers in the future, so you should not use it. See [link to page] for a new way to do this."</li> + <li>Similarly, look for any discussion of the item in the guides and tutorials about the relevant API or technology. Add similar warnings.</li> + <li>Search MDN for references to the removed item, in case there are discussions elsewhere. Add similar warning boxes there as well.</li> + <li>It's unlikely that these items will be removed from the documentation anytime soon, if ever. It's possible, however, that some or all of the material may be moved to the <a href="/en-US/docs/Archive">Archive</a> section of the site.</li> + <li>Update any relevant entries in the <a href="https://github.com/mdn/browser-compat-data">Browser Compatibility Data repo</a> to reflect the deprecation of the item(s) affected.</li> + </ul> + </li> +</ul> + +<p>Please use common sense with wording of warning messages and other changes to text suggested by the guidelines above. Different items will require different wording and handling of the situation. When in doubt, feel free to ask for advice on the <a href="https://chat.mozilla.org/#/room/#mdn:mozilla.org">MDN Web Docs chat room</a> on <a href="https://wiki.mozilla.org/Matrix">Matrix</a>, or on the <a href="https://discourse.mozilla.org/c/mdn">MDN Web Docs discussion forum</a>.</p> + +<h3 id="Copiar_conteúdo_dentro_da_MDN">Copiar conteúdo dentro da MDN</h3> + +<p>Sometimes, you need to reuse the same text on multiple pages (or you want to use one page's content as a template for another page). You have three options:</p> + +<ul> + <li>If you want to copy an entire page: + <ol> + <li>While viewing the page you want to copy, on the <strong>Advanced</strong> (gear) menu, choose <strong><a href="/en-US/docs/MDN/Contribute/Creating_and_editing_pages#Clone_of_an_existing_page">Clone this page</a></strong>. This opens the editor UI for a new page, with the contents of the cloned page already populated.</li> + <li>Enter a new <strong>Title</strong> and <strong>Slug</strong> for the cloned page.</li> + <li>Edit the contents of the page as needed, and save as usual.</li> + </ol> + </li> + <li>If you want to copy just part of a page, <strong>don't just visit the page and copy from it</strong>. This introduce unwanted additional bits of HTML into the destination page, and somebody will have to clean that up, you or another editor. Nobody wants that. To copy part of an MDN page to another page: + <ol> + <li>On the source page, click the <strong>Edit</strong> button on the source page.</li> + <li><strong>Copy the content you want to reuse from within the editor UI.</strong></li> + <li>Click <strong>Discard</strong> to exit the editor UI for that page.</li> + <li>Open the editor UI for page where you want to paste.</li> + <li>Paste the content from the clipboard.</li> + </ol> + </li> + <li>Sometimes you literally want to use the same content on many pages. In this case, you might be best off placing the content in one page, then using the {{TemplateLink("Page")}} macro to transclude the material from one page into another. This way, whenever the text on the source page is updated, the destination page will update as well (that is, this will happen on a forced-refresh or when the target page goes through a scheduled rebuild).</li> +</ul> + +<h4 id="Copiar_conteúdo_de_outro_lado">Copiar conteúdo de outro lado</h4> + +<p>Often, there is useful content about a topic somewhere on the web besides on MDN. However, copying such content can be fraught with difficulties, both legal and technical.</p> + +<p>On the technical level, search engines typically penalize a site in their rankings for reproducing content available elsewhere. Therefore, it is preferable to have original content on MDN, to enhance the search engine ranking of MDN's content. You can link to the existing content from MDN.</p> + +<p>On the legal level, you must be authorized to contribute the content, and it must be licensed and attributed in a way that is compatible with <a href="/en-US/docs/MDN/About#Copyrights_and_licenses">MDN's license</a>.</p> + +<ul> + <li><strong>If you created the existing content</strong> (for your own purposes and not as work-for-hire), and you are willing to contribute it to MDN under MDN's license, this is the easiest case, and you are free to contribute the content.</li> + <li><strong>If the copyright for the content belongs to someone else</strong>, it must be licensed and attributed compatibly with MDN's license. It is often not easy for someone who is not a lawyer to determine what licenses are compatible. To be on the safe side, contact a member of the <a href="https://wiki.mozilla.org/MDN#Staff_Team">MDN staff team</a>, who may consult Mozilla's Legal team for guidance if necessary.</li> +</ul> diff --git a/files/pt-pt/mdn/guidelines/guia_de_estilo_de_escrita/index.html b/files/pt-pt/mdn/guidelines/guia_de_estilo_de_escrita/index.html new file mode 100644 index 0000000000..fe96ad554e --- /dev/null +++ b/files/pt-pt/mdn/guidelines/guia_de_estilo_de_escrita/index.html @@ -0,0 +1,667 @@ +--- +title: Guia de estilo de escrita +slug: MDN/Guidelines/Guia_de_estilo_de_escrita +tags: + - Documentação + - Guia(2) + - Linhas Diretrizes + - MDN + - Metadados MDN +translation_of: MDN/Guidelines/Writing_style_guide +--- +<div>{{MDNSidebar}}</div> + +<p><span class="seoSummary">To present documentation in an organized, standardized, and easy-to-read manner, the MDN Web Docs style guide describes how text should be organized, spelled, formatted, and so on. These are guidelines rather than strict rules.</span> We are more interested in content than formatting, so don't feel obligated to learn the style guide before contributing. Do not be upset or surprised, however, if an industrious volunteer later edits your work to conform to this guide.</p> + +<p>If you're looking for specifics of how a given type of page should be structured, see the <a href="/en-US/docs/MDN/Contribute/Content/Layout">MDN page layout guide</a>.</p> + +<p>The language aspects of this guide apply primarily to English-language documentation. Other languages may have (and are welcome to create) style guides. These should be published as subpages of the localization team's page.</p> + +<p>For style standards that apply to content written for sites other than MDN, refer to the <a href="https://www.mozilla.org/en-US/styleguide/" title="https://www.mozilla.org/en-US/styleguide/">One Mozilla style guide</a>.</p> + +<h2 id="Básico">Básico</h2> + +<p>The best place to start in any extensive publishing style guide is with some very basic text standards to help keep documentation consistent. The following sections outline some of these basics to help you.</p> + +<h3 id="Page_titles">Page titles</h3> + +<p>Page titles are used in search results and also used to structure the page hierarchy in the breadcrumb list at the top of the page. The page title (which is displayed at the top of the page and in the search results) can be different from the page "slug", which is the portion of the page's URL following "<em><locale>/docs/</em>".</p> + +<h4 id="Title_and_heading_capitalization">Title and heading capitalization</h4> + +<p>Page titles and section headings should use sentence-style capitalization (only capitalize the first word and proper nouns) rather than headline-style capitalization:</p> + +<ul> + <li><span class="correct"><strong>Correct</strong></span>: "A new method for creating JavaScript rollovers"</li> + <li><span class="incorrect"><strong>Incorrect</strong></span>: "A New Method for Creating JavaScript Rollovers"</li> +</ul> + +<p>We have many older pages that were written before this style rule was established. Feel free to update them as needed if you like. We're gradually getting to them.</p> + +<h4 id="Choosing_titles_and_slugs">Choosing titles and slugs</h4> + +<p>Page slugs should be kept short; when creating a new level of hierarchy, the new level's component in the slug should just be a word or two.</p> + +<p>Page titles, on the other hand, may be as long as you like, within reason, and they should be descriptive.</p> + +<h4 id="Creating_new_subtrees">Creating new subtrees</h4> + +<p>When you need to add some articles about a topic or subject area, you will typically do so by creating a landing page, then adding subpages for each of the individual articles. The landing page should open with a paragraph or two describing the topic or technology, then provide a list of the subpages with descriptions of each page. You can automate the insertion of pages into the list using some macros we've created.</p> + +<p>For example, consider the <a href="/en-US/docs/Web/JavaScript">JavaScript</a> guide, which is structured as follows:</p> + +<ul> + <li><a href="/en-US/docs/Web/JavaScript/Guide" title="JavaScript/Guide">JavaScript/Guide</a> - Main table-of-contents page</li> + <li><a href="/en-US/docs/Web/JavaScript/Guide/JavaScript_Overview" title="JavaScript/Guide/JavaScript_Overview">JavaScript/Guide/JavaScript Overview</a></li> + <li><a href="/en-US/docs/JavaScript/Guide/Functions" title="JavaScript/Guide/Functions">JavaScript/Guide/Functions</a></li> + <li><a href="/en-US/docs/JavaScript/Guide/Details_of_the_Object_Model" title="JavaScript/Guide/Details_of_the_Object_Model">JavaScript/Guide/Details of the Object Model</a></li> +</ul> + +<p>Try to avoid putting your article at the top of the hierarchy, which slows the site down and makes search and site navigation less effective.</p> + +<h3 id="Sections_paragraphs_and_newlines">Sections, paragraphs, and newlines</h3> + +<p>Use heading levels in decreasing order: {{HTMLElement("h2")}} then {{HTMLElement("h3")}} then {{HTMLElement("h4")}}, without skipping levels. H2 is the highest level allowed because H1 is reserved for the page title. If you need more than three or four levels of headers you should consider breaking up the article into several smaller articles with a landing page, linking them together using the {{TemplateLink("Next")}}, {{TemplateLink("Previous")}}, and {{TemplateLink("PreviousNext")}} macros.</p> + +<p>The Enter (or Return) key on your keyboard starts a new paragraph. To insert a newline without a space, hold down the Shift key while pressing Enter.</p> + +<p>Don't create single subsections -- you don't subdivide a topic into one. It's either two subheadings or more or none at all. </p> + +<p>Don't have bumping heads, which are headings followed immediately by headings. Aside from looking horrible, it's helpful to readers if every heading has at least a brief intro after it to introduce the subsections beneath.</p> + +<h3 id="Listas">Listas</h3> + +<p>Lists should be written in a similar format across all contributions. Correct procedures should include suitable punctuation and sentence structure regardless of the list format. However dependent on the type of list you are writing, you must adjust your format accordingly. Refer to the documentation below to understand the differences of each.</p> + +<h4 id="Bulleted_Lists">Bulleted Lists</h4> + +<p>Bulleted lists should be used for grouping purposes to create concise but effective pieces of information. Each new piece of information must start with a '•' to signify a new piece. Bulleted lists must follow standard punctuation usage, pay attention to the use of full stops; they must be included at the end of each sentence just like standard writing practice.</p> + +<p>An example of a correctly structured bulleted list:</p> + +<blockquote> +<p><em>In this example we should include:</em></p> + +<ul> + <li><em>A condition, with a brief explanation.</em></li> + <li><em>A similar condition, with a brief explanation.</em></li> + <li> + <p><em>Yet another condition, some further explanation.</em></p> + </li> +</ul> +</blockquote> + +<p>Note how the format remains the same from bullet to bullet. Create a bullet point, state a condition that has relevence to your indented topic and add some pausing punctuation in order to follow up the condition with a concise explanation.</p> + +<h4 id="Listas_Numeradas">Listas Numeradas</h4> + +<p>Instruction lists must follow suitable numbering and format. It is important to include these attributes as with instructions, being clear is a key priority. Create the list in a similar style to a bulleted list, however numbered or instruction lists can be extensive where necessary, meaning correct punctuation is vital as you will be forming complex sentences.</p> + +<p>An example of a correctly structured numbered list:</p> + +<blockquote> +<p><em>In order for you to structure a correct numbered list you must:</em></p> + +<p><em>1. Begin with creating an introductory heading to lead into the instructions. This way we can provide the user with context before beginning the instructions.</em></p> + +<p><em>2. Start creating your instructions, listing your instructions with numbers. This is a standard format of a numbered list that is easily recognizable by the user. Your instructions may be quite extensive, so it is important to write effectively and use correct punctuation where necessary.</em></p> + +<p><em>3. After you have finished your instructions, close off the numbered list with a brief explanation of the outcome upon completion.</em></p> + +<p><em>This is an example of writing your closing explanation. We have created a short numbered list which provides instructive steps to produce a numbered list with the correct formatting. </em></p> +</blockquote> + +<p>Numbered lists are almost exclusive for instructive purposes, so before writing consider your approach based on the context of the information you are trying to relay. </p> + +<h3 id="Formatação_e_estilo_do_texto">Formatação e estilo do texto</h3> + +<p>Use the "Formatting Styles" drop-down list to apply predefined styles to selected content.</p> + +<div class="note">The "Note" style is used to call out important notes, like this one.</div> + +<div class="warning">Similarly, the "Warning" style creates warning boxes like this.</div> + +<p>Unless specifically instructed to do so, <strong>do not</strong> use the HTML <code>style</code> attribute to manually style content. If you can't do it using a predefined class, drop into {{IRCLink("mdn")}} and ask for help.</p> + +<h3 id="Code_sample_style_and_formatting">Code sample style and formatting</h3> + +<h4 id="Tabs_and_line_breaks">Tabs and line breaks</h4> + +<p>Use two spaces per tab in all code examples. Indent the code cleanly, with open-brace ("{") characters on the same line as the statement that opens the block. For example:</p> + +<pre class="brush: js notranslate">if (condition) { + /* handle the condition */ +} else { + /* handle the "else" case */ +} +</pre> + +<p>Long lines shouldn't be allowed to stretch off horizontally to the extent that they require horizontal scrolling to read. Instead, break at natural breaking points. Some examples follow:</p> + +<pre class="brush: js notranslate">if (class.CONDITION || class.OTHER_CONDITION || class.SOME_OTHER_CONDITION + || class.YET_ANOTHER_CONDITION ) { + /* something */ +} + +var toolkitProfileService = Components.classes["@mozilla.org/toolkit/profile-service;1"] + .createInstance(Components.interfaces.nsIToolkitProfileService); +</pre> + +<h4 id="Inline_code_formatting">Inline code formatting</h4> + +<p>Use the "Code" button (labeled with two angle brackets "<>") to apply inline code-style formatting to function names, variable names, and method names (this uses the {{HTMLElement("code")}} element). For example, "the <code class="js plain">frenchText()</code> function".</p> + +<p>Method names should be followed by a pair of parentheses: <code>doSomethingUseful()</code>. The parentheses help differentiate methods from other code terms.</p> + +<h4 id="Syntax_highlighting">Syntax highlighting</h4> + +<p><img alt="Screenshot of the 'Syntax Highlighter' menu." src="https://mdn.mozillademos.org/files/12682/Language%20list.png" style="border-style: solid; border-width: 1px; float: right; margin: 2px 4px;">Entire lines (or multiple lines) of code should be formatted using syntax highlighting rather than the {{HTMLElement("code")}} element. Select the appropriate language from the language list button (the one with the two code blocks), as seen in the screenshot to the right. This will insert a preformatted code box with line numbers and syntax highlighting for the chosen language.</p> + +<p>The following example shows text with JavaScript formatting:</p> + +<div class="line number2 index1 alt1"> +<pre class="brush: js notranslate">for (var i = 0, j = 9; i <= 9; i++, j--) + document.writeln("a[" + i + "][" + j + "]= " + a[i][j]);</pre> +</div> + +<p>If no appropriate language is available, use ("No Highlight" in the language menu). This will result in code without syntax highlighting:</p> + +<pre class="brush: plain notranslate">x = 42;</pre> + +<h4 id="Syntax_definitions">Syntax definitions</h4> + +<p>If you want to insert a syntax definition, you can choose the "Syntax Box" option from the "Styles" drop-down menu in the editor toolbar. This will give the syntax definition a special formatting distinguishing it from normal code.</p> + +<h4 id="Blocks_not_referring_to_code">Blocks not referring to code</h4> + +<p>There are a few use cases where a <pre> block does not refer to code and doesn't have syntax highlighting nor line numbers. In such cases you should add a <pre> without class. Those cases include things like tree structures:</p> + +<pre class="notranslate">root/ + + folder1/ + file1 + + folder2/ + file2 + file3 +</pre> + +<p>To create preformatted content without syntax highlighting and line numbers click the "pre" button in the toolbar. Then start to type the text.</p> + +<h4 id="Styling_HTML_element_references">Styling HTML element references</h4> + +<p>There are specific rules to follow when writing about HTML elements. These rules produce consistent descriptions of elements and their components. They also ensure correct linking to detailed documentation.</p> + +<dl> + <dt>Element names</dt> + <dd>Use the {{TemplateLink("HTMLElement")}} macro, which creates a link to the page for that element. For example, writing \{{HTMLElement("title")}} produces "{{HTMLElement("title")}}". If you don't want to create a link, <strong>enclose the name in angle brackets</strong> and use "Code (inline)" style (e.g., <code><title></code>).</dd> + <dt>Attribute names</dt> + <dd>Use <strong>bold face</strong>.</dd> + <dt>Attribute definitions</dt> + <dd>Use the {{TemplateLink("htmlattrdef")}} macro (e.g., <span class="nowiki">\{{htmlattrdef("type")}}</span>) for the definition term, so that it can be linked to from other pages, then use the {{TemplateLink("htmlattrxref")}} macro (e.g., <span class="nowiki">\{{htmlattrxref("attr","element")}}</span>) to reference attribute definitions.</dd> + <dt>Attribute values</dt> + <dd>Use "Code (inline)" style, and do not use quotation marks around strings, unless needed by the syntax of a code sample. For example: When the <strong>type</strong> attribute of an <code><input></code> element is set to <code>email</code> or <code>tel</code> ...</dd> + <dt>Labeling attributes</dt> + <dd>Use labels like {{HTMLVersionInline(5)}} thoughtfully. For example, use them next to the bold attribute name but not for every occurrence in your body text.</dd> +</dl> + +<h3 id="Latin_abbreviations">Latin abbreviations</h3> + +<h4 id="In_notes_and_parentheses">In notes and parentheses</h4> + +<ul> + <li>Common Latin abbreviations (etc., i.e., e.g.) may be used in parenthetical expressions and notes. Use periods in these abbreviations, followed by a comma or other appropriate punctuation. + <ul> + <li><span class="correct"><strong>Correct</strong></span>: Web browsers (e.g., Firefox) can be used ...</li> + <li><span class="incorrect"><strong>Incorrect</strong></span>: Web browsers e.g. Firefox can be used ...</li> + <li><span class="incorrect"><strong>Incorrect</strong></span>: Web browsers, e.g. Firefox, can be used ...</li> + <li><span class="incorrect"><strong>Incorrect</strong></span>: Web browsers, (eg: Firefox) can be used ...</li> + </ul> + </li> +</ul> + +<h4 id="In_running_text">In running text</h4> + +<ul> + <li>In regular text (i.e., text outside of notes or parentheses), use the English equivalent of the abbreviation. + <ul> + <li><span class="correct"><strong>Correct</strong></span>: ... web browsers, and so on.</li> + <li><span class="incorrect"><strong>Incorrect</strong></span>: ... web browsers, etc.</li> + <li><span class="correct"><strong>Correct</strong></span>: Web browsers such as Firefox can be used ...</li> + <li><span class="incorrect"><strong>Incorrect</strong></span>: Web browsers e.g. Firefox can be used ...</li> + </ul> + </li> +</ul> + +<h4 id="Meanings_and_English_equivalents_of_Latin_abbreviations">Meanings and English equivalents of Latin abbreviations</h4> + +<table class="fullwidth-table"> + <tbody> + <tr> + <th>Abbrev</th> + <th>Latin</th> + <th>English</th> + </tr> + <tr> + <td>cf.</td> + <td><em>confer</em></td> + <td>compare</td> + </tr> + <tr> + <td>e.g.</td> + <td><em>exempli gratia</em></td> + <td>for example</td> + </tr> + <tr> + <td>et al.</td> + <td><em>et alii</em></td> + <td>and others</td> + </tr> + <tr> + <td>etc.</td> + <td><em>et cetera</em></td> + <td>and so forth, and so on</td> + </tr> + <tr> + <td>i.e.</td> + <td><em>id est</em></td> + <td>that is, in other words</td> + </tr> + <tr> + <td>N.B.</td> + <td><em>nota bene</em></td> + <td>note well</td> + </tr> + <tr> + <td>P.S.</td> + <td><em>post scriptum</em></td> + <td>postscript</td> + </tr> + </tbody> +</table> + +<div class="note"> +<p>Always consider whether it's truly beneficial to use a Latin abbreviation. Some of these are used so rarely that many readers won't understand the meaning, and others are often confused with one another. And be sure that <strong>you</strong> use them correctly, if you choose to do so. For example, be careful not to confuse "e.g." with "i.e.", which is a common error.</p> +</div> + +<h3 id="Acronyms_and_abbreviations">Acronyms and abbreviations</h3> + +<h4 id="Capitalization_and_periods">Capitalization and periods</h4> + +<p>Use full capitals and delete periods in all acronyms and abbreviations, including organizations such as "US" and "UN".</p> + +<ul> + <li><span class="correct"><strong>Correct</strong></span>: XUL</li> + <li><span class="incorrect"><strong>Incorrect</strong></span>: X.U.L.; Xul</li> +</ul> + +<h4 id="Expansion">Expansion</h4> + +<p>On the first mention of a term on a page, expand acronyms likely to be unfamiliar to users. When in doubt, expand it, or, better, link it to the article or <a href="/en-US/docs/Glossary">glossary</a> entry describing the technology.</p> + +<ul> + <li><span class="correct"><strong>Correct</strong></span>: "XUL (XML User Interface Language) is Mozilla's XML-based language..."</li> + <li><span class="incorrect"><strong>Incorrect</strong></span>: "XUL is Mozilla's XML-based language..."</li> +</ul> + +<h4 id="Plurals_of_acronyms_and_abbreviations">Plurals of acronyms and abbreviations</h4> + +<p>For plurals of acronyms or abbreviations, add <em>s</em>. Don't use an apostrophe. Ever. Please.</p> + +<ul> + <li><span class="correct"><strong>Correct</strong></span>: CD-ROMs</li> + <li><span class="incorrect"><strong>Incorrect</strong></span>: CD-ROM's</li> +</ul> + +<h4 id="Versus_vs._and_v.">"Versus", "vs.", and "v."</h4> + +<p>The contraction "vs." is preferred.</p> + +<ul> + <li><span class="correct"><strong>Correct</strong></span>: this vs. that</li> + <li><span class="incorrect"><strong>Incorrect</strong></span>: this v. that</li> + <li><span class="incorrect"><strong>Incorrect</strong></span>: this versus that</li> +</ul> + +<h3 id="Capitalização">Capitalização</h3> + +<p>Use standard English capitalization rules in body text, and capitalize "World Wide Web." It is acceptable to use lower case for "web" (used alone or as a modifier) and "internet;" this guideline is a change from a previous version of this guide, so you may find many instances of "Web" and "Internet" on MDN. Feel free to change these as you are making other changes, but editing an article just to change capitalization is not necessary.</p> + +<p>Keyboard keys should use sentence-style capitalization, not all-caps capitalization. For example, "Enter" not "ENTER."</p> + +<h3 id="Contrações">Contrações</h3> + +<p>Our writing style tends to be casual, so you should feel free to use contractions (e.g., "don't", "can't", "shouldn't") if you prefer.</p> + +<h3 id="Pluralização">Pluralização</h3> + +<p>Use English-style plurals, not the Latin- or Greek-influenced forms.</p> + +<ul> + <li><span class="correct"><strong>Correct</strong></span>: syllabuses, octopuses</li> + <li><span class="incorrect"><strong>Incorrect</strong></span>: syllabi, octopi</li> +</ul> + +<h3 id="Hifenização">Hifenização</h3> + +<p>Hyphenate compounds when the last letter of the prefix is a vowel and is the same as the first letter of the root.</p> + +<ul> + <li><font color="green"><strong>Correct</strong></font>: email, re-elect, co-op</li> + <li><font color="red"><strong>Incorrect</strong></font>: e-mail, reelect, coop</li> +</ul> + +<h3 id="Idioma_de_género_neutral">Idioma de género neutral</h3> + +<p>It is a good idea to use gender-neutral language in any writing where gender is irrelevant to the subject matter, to make the text as inclusive as possible. So for example, if you are talking about the actions of a specific man, usage of he/his would be fine, but if the subject is a person of either gender, he/his isn't appropriate.<br> + <br> + Let's take the following example:</p> + +<blockquote> +<p>A confirmation dialog appears, asking the user if he allows the Web page to make use of his Web cam.</p> +</blockquote> + +<blockquote> +<p>A confirmation dialog appears, asking the user if she allows the Web page to make use of her Web cam.</p> +</blockquote> + +<p>Both versions are gender-specific. To fix this, use gender-neutral pronouns:</p> + +<blockquote> +<p>A confirmation dialog appears, asking the user if they allow the Web page to make use of their Web cam.</p> +</blockquote> + +<div class="note"> +<p>MDN allows the use of this very common syntax (which is controversial among usage authorities), to make up for the lack of a neutral gender in English. The use of the third-person plural as a gender neutral pronoun (that is, using "they," them", "their," and "theirs") is an accepted practice, commonly known as "<a href="https://en.wikipedia.org/wiki/Singular_they">singular 'they.'</a>"</p> +</div> + +<p>You can use both genders:</p> + +<blockquote> +<p>A confirmation dialog appears, asking the user if he or she allows the web page to make use of his/her web cam.</p> +</blockquote> + +<p>making the users plural:</p> + +<blockquote> +<p>A confirmation dialog appears, asking the users if they allow the web page to make use of their web cams.</p> +</blockquote> + +<p>The best solution, of course, is to rewrite and eliminate the pronouns:</p> + +<blockquote> +<p>A confirmation dialog appears, requesting the user's permission for web cam access.</p> +</blockquote> + +<blockquote> +<p>A confirmation dialog box appears, which asks the user for permission to use the web cam.</p> +</blockquote> + +<p>The last way of dealing with the problem is arguably better, as it is not only grammatically more correct but removes some of the complexity associated with dealing with genders across different languages that may have wildly varying gender rules. This solution can make translation easier for both readers and localizers.</p> + +<h3 id="Numbers_and_numerals">Numbers and numerals</h3> + +<h4 id="Dates">Dates</h4> + +<p>For dates (not including dates in code samples) use the format "January 1, 1990".</p> + +<ul> + <li><span class="correct"><strong>Correct</strong></span>: February 24, 2006</li> + <li><span class="incorrect"><strong>Incorrect</strong></span>: February 24th, 2006; 24 February, 2006; 24/02/2006</li> +</ul> + +<p>Alternately, you can use the YYYY/MM/DD format.</p> + +<ul> + <li><span class="correct"><strong>Correct</strong></span>: 2006/02/24</li> + <li><span class="incorrect"><strong>Incorrect</strong></span>: 02/24/2006; 24/02/2006; 02/24/06</li> +</ul> + +<h4 id="Decades">Decades</h4> + +<p>For decades, use the format "1990s". Don't use an apostrophe.</p> + +<ul> + <li><span class="correct"><strong>Correct</strong></span>: 1990s</li> + <li><span class="incorrect"><strong>Incorrect</strong></span>: 1990's</li> +</ul> + +<h4 id="Plurals_of_numerals">Plurals of numerals</h4> + +<p>For plurals of numerals add "s". Don't use an apostrophe.</p> + +<ul> + <li><span class="correct"><strong>Correct</strong></span>: 486s</li> + <li><span class="incorrect"><strong>Incorrect</strong></span>: 486's</li> +</ul> + +<h4 id="Commas">Commas</h4> + +<p>In running text, use commas only in five-digit and larger numbers.</p> + +<ul> + <li><span class="correct"><strong>Correct</strong></span>: 4000; 54,000</li> + <li><span class="incorrect"><strong>Incorrect</strong></span>: 4,000; 54000</li> +</ul> + +<h3 id="Punctuation">Punctuation</h3> + +<h4 id="Serial_comma">Serial comma</h4> + +<p><strong>Use the serial comma</strong>. The serial (also known as "Oxford") comma is the comma that appears before the conjunction in a series of three or more items.</p> + +<ul> + <li><span class="correct"><strong>Correct</strong></span>: I will travel on trains, planes, and automobiles.</li> + <li><span class="incorrect"><strong>Incorrect</strong></span>: I will travel on trains, planes and automobiles.</li> +</ul> + +<div class="note"> +<p>This is in contrast to the <a href="https://www.mozilla.org/en-US/styleguide/" title="https://www.mozilla.org/en-US/styleguide/">One Mozilla style guide</a>, which specifies that the serial comma is not to be used. MDN is an exception to this rule.</p> +</div> + +<h3 id="Ortografia">Ortografia</h3> + +<p>For words with variant spellings, always use their American English spelling. In general, use the first entry at <a href="http://www.dictionary.com/">Dictionary.com</a>, unless that entry is listed as a variant spelling or as being primarily used in a non-American form of English; for example, if you <a href="http://dictionary.reference.com/browse/honour">look up "honour"</a>, you find the phrase "Chiefly British" followed by a link to the American standard form, "<a href="http://dictionary.reference.com/browse/honor">honor</a>". Do not use variant spellings.</p> + +<ul> + <li><span class="correct"><strong>Correct</strong></span>: localize, honor</li> + <li><span class="incorrect"><strong>Incorrect</strong></span>: localise, honour</li> +</ul> + +<h3 id="Terminologia">Terminologia</h3> + +<h4 id="Obsolete_vs._deprecated">Obsolete vs. deprecated</h4> + +<p>It's important to be clear about the difference between the terms <strong>obsolete</strong> and <strong>deprecated</strong>.</p> + +<dl> + <dt>Obsolete</dt> + <dd>On MDN, the term <strong>obsolete</strong> marks an API or technology that is not only no longer recommended, but also no longer implemented in the browser. For Mozilla-specific technologies, the API is no longer implemented in Mozilla code; for Web standard technology, the API or feature is no longer supported by current, commonly-used browsers.</dd> + <dt>Deprecated</dt> + <dd>On MDN, the term <strong>deprecated</strong> marks an API or technology that is no longer recommended, but is still implemented and may still work. These technologies will in theory eventually become <em>obsolete</em> and be removed, so you should stop using them. For Mozilla-specific technologies, the API is still supported in Mozilla code; for Web standard technology, the API or feature has been removed or replaced in a recent version of the defining standard.</dd> +</dl> + +<h4 id="Elementos_de_HTML">Elementos de HTML</h4> + +<p>Use "elements" to refer to HTML and XML elements, rather than "tags". In addition, they should almost always be wrapped in "<>", and should be in the {{HTMLElement("code")}} style. When you reference a given element for the first time in a section, you should use the {{TemplateLink("HTMLElement")}} macro to create a link to the documentation for the element (unless you're writing within that element's reference document page).</p> + +<ul> + <li><span class="correct"><strong>Correct</strong></span>: the {{HTMLElement("span")}} element</li> + <li><span class="incorrect"><strong>Incorrect</strong></span>: the span tag</li> +</ul> + +<h4 id="Parameters_vs._arguments">Parameters vs. arguments</h4> + +<p>The preferred term on MDN is <strong>parameters</strong>. Please avoid the term "arguments" for consistency if at all possible.</p> + +<h4 id="User_interface_actions">User interface actions</h4> + +<p>In task sequences, describe user interface actions using the imperative mood. Identify the user interface element by its label and type.</p> + +<ul> + <li><span class="correct"><strong>Correct</strong></span>: Click the Edit button.</li> + <li><span class="incorrect"><strong>Incorrect</strong></span>: Click Edit.</li> +</ul> + +<h3 id="Voice">Voice</h3> + +<p>While the active voice is preferred, the passive voice is also acceptable, given the informal feel of our content. Try to be consistent, though.</p> + +<h2 id="Wiki_markup_and_usage">Wiki markup and usage</h2> + +<h3 id="Hiperligações">Hiperligações</h3> + +<p>Links are a large part of what makes a wiki a powerful learning and teaching tool. Below you'll find some basic information, but you can find a complete guide to <a href="/en-US/docs/MDN/Contribute/Editor/Links">creating and editing links on MDN</a> in our editor guide.</p> + +<p>We encourage you to create appropriate links among articles; they help improve navigation and discoverability of content. You can easily create links not only among pages on MDN (internal links) but also to pages outside MDN (external links).</p> + +<p>There are two ways to create links: you explicitly create a link using the Link button in the editor's toolbar—or by pressing <kbd>Ctrl</kbd>+<kbd>K</kbd> (<kbd>Cmd</kbd>-<kbd>K</kbd> on the Mac)—or you can use MDN's powerful macro system to generate links automatically or based on an input value.</p> + +<p>When deciding what text to use as a link, there are a few guidelines you can follow:</p> + +<ul> + <li>Whenever a macro exists which will create the link you need, and you are able to do so, please do. <a href="/en-US/docs/MDN/Contribute/Editor/Links#Using_link_macros">Using macros to create links</a> will not only help you get it right, but will allow future improvements to MDN to automatically be applied to your link.</li> + <li>For an API name, use the entire string of the API term as written in your content. The easiest way to do this is to <a href="/en-US/docs/MDN/Contribute/Editor/Links#Linking_to_documentation_for_APIs">use the appropriate macro</a> to construct a properly-formatted link for you.</li> + <li>For a term for which you're linking to a page defining or discussing that term, use the name of the term and no additional text as the link's text. For example: + <ul> + <li><span class="correct"><strong>Correct</strong></span>: You can use <a href="/en-US/docs/Web/JavaScript">JavaScript</a> code to create dynamic applications on the Web.</li> + <li><span class="incorrect"><strong>Incorrect</strong></span>: You can use <a href="/en-US/docs/Web/JavaScript">JavaScript code</a> to create dynamic applications on the Web.</li> + </ul> + </li> + <li>Otherwise, when adding a useful link to prose, try to choose an action and object phrase, such as: + <ul> + <li><span class="correct"><strong>Correct</strong></span>: If you'd like to <a href="/en-US/docs/Mozilla/Developer_guide">contribute to the Firefox project</a>, your first step is to <a href="/en-US/docs/Mozilla/Developer_guide/Build_Instructions">download and build Firefox</a>.</li> + <li><span class="incorrect"><strong>Incorrect</strong></span>: <a href="/en-US/docs/Mozilla/Developer_guide">If you'd like to contribute to the Firefox project</a>, your first step is to <a href="/en-US/docs/Mozilla/Developer_guide/Build_Instructions">download and build</a> Firefox.</li> + </ul> + </li> +</ul> + +<h4 id="Esquemas_de_URL">Esquemas de URL</h4> + +<p>For security reasons, you should only create links that use the following schemes:</p> + +<ul> + <li><code>http://</code></li> + <li><code>https://</code></li> + <li><code>ftp://</code></li> + <li><code>mailto:</code></li> +</ul> + +<p>Others may or may not work, but are not supported and will probably be removed by editorial staff.</p> + +<div class="note"> +<p>In particular, be sure not to use the <code>about:</code> or <code>chrome://</code> schemes, as they will not work. Similarly, the <code>javascript:</code> scheme is blocked by most modern browsers, as is <code>jar:</code>.</p> +</div> + +<h3 id="Etiquetas_de_página">Etiquetas de página</h3> + +<p>Tags provide meta information about a page and/or indicate that a page has specific improvements needed to its content. Every page in the wiki should have tags. You can find details on tagging in our <a href="/en-US/docs/MDN/Contribute/Howto/Tag">How to properly tag pages</a> guide.</p> + +<p>The tagging interface lives at the bottom of a page while you're in edit mode, and looks something like this:</p> + +<p><img alt="Screenshot of the UX for adding and removing tags on MDN" src="https://mdn.mozillademos.org/files/7859/tag-interface.png" style="border-style: solid; border-width: 1px; height: 167px; width: 863px;"></p> + +<p>To add a tag, click in the edit box at the end of the tag list and type the tag name you wish to add. Tags will autocomplete as you type. Press enter (or return) to submit the new tag. Each article may have as many tags as needed. For example, an article about using JavaScript in AJAX programming might have both "JavaScript" and "AJAX" as tags.</p> + +<p>To remove a tag, just click the little "X" icon in the tag.</p> + +<h4 id="Tagging_pages_that_need_work">Tagging pages that need work</h4> + +<p>In addition to using tags to track information about the documentation's quality and content, we also use them to mark articles as needing specific types of work.</p> + +<h4 id="Tagging_obsolete_pages">Tagging obsolete pages</h4> + +<p>Use the following tags for pages that are not current:</p> + +<ul> + <li><em>Junk</em>: Use for spam, pages created by mistake, or content that is so bad that it should be deleted. Pages with this tag are deleted from time to time.</li> + <li><em>Obsolete</em>: Use for content that is technically superseded, but still valid in context. For example an HTML element that is obsolete in HTML5 is still valid in HTML 4.01. You can also use the <span class="nowiki">{{TemplateLink("obsolete_header")}}</span> macro to put a prominent banner on the topic.</li> + <li><em>Archive</em>: Use for content that is technically superseded and no longer useful. If possible, add a note to the topic referring readers to a more current topic. For example, a page that describes how to use the Mozilla CVS repository should refer readers to a current topic on using Mercurial repos. (If no corresponding current topic exists, use the <em>NeedsUpdate</em> tag, and add an explanation on the Talk page.) Pages with the Archive tag are eventually moved from the main content of MDN to the <a href="/en-US/docs/Archive">Archive</a> section.</li> +</ul> + +<h3 id="Resumo_SEO">Resumo SEO</h3> + +<p>The SEO summary provides a short description of a page. It will be reported as a summary of the article to robots crawling the site, and will then appear in search results for the page. It is also used by macros that automate the construction of landing pages inside MDN itself.</p> + +<p>By default, the first paragraph of the page is used as the SEO summary. However, you can override this behavior by marking a section with the <a href="/en-US/docs/Project:MDN/Contributing/Editor_guide/Editing#Formatting_styles">"SEO summary" style in the WYSIWYG editor</a>.</p> + +<h3 id="Landing_pages">Landing pages</h3> + +<p><strong>Landing pages</strong> are pages at the root of a topic area of the site, such as the main <a href="/en-US/docs/CSS" title="CSS">CSS</a> or <a href="/en-US/docs/HTML" title="HTML">HTML</a> pages. They have a standard format that consists of three areas:</p> + +<ol> + <li>A brief (typically one paragraph) overview of what the technology is and how it's used. See {{anch("Writing a landing page overview")}} for tips.</li> + <li>A two-column list of links with appropriate headings. See {{anch("Creating a page link list")}} for guidelines.</li> + <li>An <strong>optional</strong> "Browser compatibility" section at the bottom of the page.</li> +</ol> + +<h4 id="Creating_a_page_link_list">Creating a page link list</h4> + +<p>The link list section of an MDN landing page consists of two columns. These are created using the following HTML:</p> + +<pre class="brush: html notranslate"><div class="row topicpage-table"> + <div class="section"> + ... left column contents ... + </div> + <div class="section"> + ... right column contents ... + </div> +</div></pre> + +<p>The left column should be a list of articles, with an <code><h2></code> header at the top of the left column explaining that it's a list of articles about the topic (e.g., "Documentation and tutorials about foo"); this header should use the CSS class "Documentation". Below that is a <code><dl></code> list of articles with each article's link in a <code><dt></code> block and a brief one-or-two sentence summary of the article in the corresponding <code><dd></code> block.</p> + +<p>The right column should contain one or more of the following sections, in order:</p> + +<dl> + <dt>Getting help from the community</dt> + <dd>This should provide information on Matrix chat rooms and mailing lists available on the topic. The heading should use the class "Community".</dd> + <dt>Tools</dt> + <dd>A list of tools the user can look at to help with the use of the technology described in this section of MDN. The heading should use the class "Tools".</dd> + <dt>Related topics</dt> + <dd>A list of links to landing pages for other, related, technologies of relevance. The heading should use the class "Related_Topics".</dd> +</dl> + +<p><strong><<<finish this once we finalize the landing page standards>>></strong></p> + +<h2 id="Utilização_inserção_de_imagens">Utilização, inserção de imagens</h2> + +<p>It's sometimes helpful to provide an image in an article you create or modify, especially if the article is very technical. To include an image:</p> + +<ol> + <li>Attach the desired image file to the article (at the bottom of every article in edit mode)</li> + <li>Create an image in the WYSIWYG editor</li> + <li>In the WYSIWYG editor, in the drop-down list of attachments, select the newly created attachment that is your image</li> + <li>Press OK.</li> +</ol> + +<h2 id="Outras_referências">Outras referências</h2> + +<h3 id="Preferred_style_guides">Preferred style guides</h3> + +<p>If you have questions about usage and style not covered here, we recommend referring to the <a href="http://www.economist.com/styleguide/introduction">Economist style guide</a> or, failing that, the <a href="https://www.amazon.com/Chicago-Manual-Style-16th/dp/0226104206">Chicago Manual of Style</a>.</p> + +<h3 id="Preferred_dictionary">Preferred dictionary</h3> + +<p>For questions of spelling, please refer to <a href="http://www.dictionary.com/">Dictionary.com</a>. The spelling checker for this site uses American English. Please do not use variant spellings (e.g., use <em>color</em> rather than <em>colour</em>).</p> + +<p>We will be expanding the guide over time, so if you have specific questions that aren't covered in this document, please send them to the <a href="/en-US/docs/Project:Community" title="Project:en/Community">MDC mailing list</a> or <a href="/User:Sheppy" title="User:Sheppy">project lead</a> so we know what should be added.</p> + +<h3 id="Específico_da_MDN">Específico da MDN</h3> + +<ul> + <li><a href="/en-US/docs/MDN/Contribute/Structures/Macros/Commonly-used_macros" title="Project:en/Custom_Templates">Commonly-used macros</a> on MDN, with explanations.</li> +</ul> + +<h3 id="Idioma_gramática_ortografia">Idioma, gramática, ortografia</h3> + +<p>If you're interested in improving your writing and editing skills, you may find the following resources to be helpful.</p> + +<ul> + <li><a href="http://www.amazon.com/Writing-Well-30th-Anniversary-Nonfiction/dp/0060891548">On Writing Well</a>, by William Zinsser (Amazon link)</li> + <li><a href="http://www.amazon.com/Style-Basics-Clarity-Grace-4th/dp/0205830765/" title="http://www.amazon.com/Style-Lessons-Clarity-Grace-Edition/dp/0321898680">Style: The Basics of Clarity and Grace</a>, by Joseph Williams and Gregory Colomb (Amazon link)</li> + <li><a href="https://brians.wsu.edu/common-errors-in-english-usage/">Common Errors in English</a></li> + <li><a href="http://www-personal.umich.edu/~jlawler/aue.html">English Grammar FAQ</a> (alt.usage.english)</li> + <li><a href="http://www.angryflower.com/bobsqu.gif">Bob's quick guide to the apostrophe, you idiots</a> (funny)</li> + <li><a href="http://www.amazon.com/Merriam-Websters-Concise-Dictionary-English-Usage/dp/B004L2KNI2" title="http://www.amazon.com/Merriam-Websters-Concise-Dictionary-English-Usage/dp/B004L2KNI2">Merriam-Webster's Concise Dictionary of English Usage</a> (Amazon link): Scholarly but user-friendly, evidence-based advice; very good for non-native speakers, especially for preposition usage.</li> + <li><a href="http://english.stackexchange.com/">English Language and Usage StackExchange</a>: Question and answer site for English language usage.</li> +</ul> diff --git a/files/pt-pt/mdn/guidelines/index.html b/files/pt-pt/mdn/guidelines/index.html new file mode 100644 index 0000000000..e4e220f1f4 --- /dev/null +++ b/files/pt-pt/mdn/guidelines/index.html @@ -0,0 +1,10 @@ +--- +title: Linhas Diretrizes +slug: MDN/Guidelines +translation_of: MDN/Guidelines +--- +<div>{{MDNSidebar}}</div><div>{{IncludeSubnav("/pt-PT/docs/MDN")}}</div> + +<p><span class="seoSummary">Estas </span>linhas diretrizes <span class="seoSummary">proporcionam detalhes em como é que a documentação da MDN deverá ser escrita e formatada, bem como, é que deverá ser apresentado as nossas amostras de código e outro conteúdo.</span> Ao seguir esta orientação, pode certificar-se de que o material que produz é simples e fácil de utilziar.</p> + +<p>{{LandingPageListSubpages}}</p> diff --git a/files/pt-pt/mdn/guidelines/isto_pertence_a_mdn/index.html b/files/pt-pt/mdn/guidelines/isto_pertence_a_mdn/index.html new file mode 100644 index 0000000000..429ffa389f --- /dev/null +++ b/files/pt-pt/mdn/guidelines/isto_pertence_a_mdn/index.html @@ -0,0 +1,200 @@ +--- +title: Isto pertence aos MDN Web Docs? +slug: MDN/Guidelines/Isto_pertence_a_MDN +tags: + - Guía + - Linhas Diretrizes + - Metadados MDN +translation_of: MDN/Guidelines/Does_this_belong_on_MDN +--- +<div>{{MDNSidebar}}</div> + +<div>{{IncludeSubnav("/pt-PT/docs/MDN")}}</div> + +<p><span class="seoSummary">Neste artigo, irá encontrar informação a descrever como decidir se determinado tópico e/ ou tipo de conteúdo deverá ou não ser incluído na MDN Web Docs. Nós também iremos considerar outros lugares em que pode colocar o conteúdo, embora não em profundidade</span>.</p> + +<h2 id="A_questão">A questão</h2> + +<p>If you're preparing to document something, you may be trying to decide whether to put the information on MDN Web Docs. In addition, you may be considering maintaining documentation in your source code, putting the document on the <a href="https://wiki.mozilla.org/">Mozilla wiki</a>, or in readme files in a Git repository. This article's purpose is to help you decide which of these options is right for your content.</p> + +<p>The two main considerations for whether a document belongs on MDN are:</p> + +<ul> + <li>The topic of the document (what is it about?)</li> + <li>The nature of the document (what kind of document is it?)</li> +</ul> + +<p>Be aware that all contributions to MDN fall under specific open source licenses; these are <a href="https://developer.mozilla.org/en-US/docs/MDN/About#Copyrights_and_licenses">described in detail</a> on our <a href="/en-US/docs/MDN/About">About MDN</a> page.</p> + +<div class="note"> +<p><strong>Nota</strong>: Keep in mind that Mozilla's <a href="https://www.mozilla.org/en-US/about/legal/terms/mozilla/">Websites & Communications Terms of Use</a> are in effect when you use or contribute to MDN Web Docs. Review this document to ensure that you're aware of what can and cannot be posted on Mozilla sites.</p> +</div> + +<h2 id="Que_tópicos_pertencem_aos_MDN_Web_Docs">Que tópicos pertencem aos MDN Web Docs?</h2> + +<p>In general, if it's an open web-facing technology, we document it on MDN. This means any feature that can used by Web developers creating sites and applications now and in the near future. If it is implemented by multiple browsers and either accepted as standard or is progressing towards standardization, then yes, definitely. If it is still very experimental and not implemented in multiple browsers and/or liable to change, then it is still suitable for inclusion, but may not be seen as a priority for the writer's team to work on.</p> + +<p>The primary focus is on front-end web technologies:</p> + +<ul> + <li><a href="/en-US/docs/Web/HTML" title="HTML">HTML</a></li> + <li><a href="/en-US/docs/Web/CSS" title="CSS">CSS</a></li> + <li><a href="/en-US/docs/Web/JavaScript" title="en/JavaScript">JavaScript</a></li> + <li><a href="/en-US/docs/Web/SVG" title="SVG">SVG</a></li> + <li><a href="/en-US/docs/Web/API">Web APIs</a></li> + <li><a href="/en-US/docs/Web/API/WebGL_API" title="WebGL">WebGL</a></li> + <li>etc.</li> +</ul> + +<div class="note"> +<p><strong>Nota</strong>: Back-end technologies usually have their own documentation elsewhere that MDN does not attempt to supercede, although we <a href="https://developer.mozilla.org/en-US/docs/Learn/Server-side">do have some exceptions</a>.</p> +</div> + +<p>Also welcome are topics that cut across technologies but are relevant to Web development, such as:</p> + +<ul> + <li><a href="/en-US/docs/Web/Accessibility" title="Accessibility">Accessibility</a></li> + <li><a href="/en-US/docs/AJAX">AJAX</a></li> + <li><a href="/en-US/docs/Web/Guide/Graphics">Web graphics</a></li> + <li><a href="/en-US/docs/Apps">Open web apps</a></li> + <li><a href="/en-US/Apps/Tutorials/Games">Web-based games</a></li> +</ul> + +<div class="note"> +<p><strong>Nota:</strong> MDN covers some non-standard features if they're exposed to the Web, especially if they find common usage; for example, we have documentation for WebKit-specific CSS properties.</p> +</div> + +<h2 id="Que_tópicos_não_pertencem_aos_MDN_Web_Docs">Que tópicos não pertencem aos MDN Web Docs?</h2> + +<p>In general, anything that isn't an open web standard does not belong on MDN. The below sections provide more specifics.</p> + +<h3 id="Produtos_da_Mozilla">Produtos da Mozilla</h3> + +<p>Documentation in this category includes information on both how to work with Mozilla products, as a developer, and how to contribute to these open-source projects.</p> + +<p>While MDN Web Docs contains a large quantity of Mozilla product documentation, the focus of new content development is on open web standards. We are in the process of determining what to do about this content, so it may not make sense to create new Mozilla product documentation on MDN Web Docs. If you are working on a Mozilla product (or project that may become a product), talk to a member of the <a href="https://wiki.mozilla.org/Engagement/MDN_Durable_Team">MDN staff team</a> to discuss possible avenues for documenting your product. Also, see the section on <a href="#Cases_for_documenting_elsewhere">Cases for documenting elsewhere</a>, below.</p> + +<ul> + <li><a href="en-US/docs/Firefox">Firefox browser</a> + + <ul> + <li><a href="/en-US/docs/Tools">Firefox Developer Tools</a></li> + <li><a href="/en-US/docs/Mozilla/Add-ons">Add-ons</a></li> + <li><a href="en-US/docs/Mozilla/Developer_guide/Build_Instructions">Building and configuring Firefox</a></li> + <li>etc.</li> + </ul> + </li> + <li><a href="/en-US/docs/Mozilla">The Mozilla platform</a> + <ul> + <li><a href="/en-US/docs/Mozilla/Gecko">Gecko</a></li> + <li><a href="/en-US/docs/Mozilla/Projects/SpiderMonkey">SpiderMonkey</a></li> + <li>etc.</li> + </ul> + </li> +</ul> + +<h3 id="E_que_mais">E que mais?</h3> + +<p>Other examples of inappropriate topics for MDN Web Docs:</p> + +<ul> + <li>Technology that is not exposed to the Web and is specific to a non-Mozilla browser.</li> + <li>Technology that is not related to the Web or Mozilla products.</li> + <li>Documentation for end-users; for Mozilla products, such documentation belongs on the <a href="https://support.mozilla.org">Mozilla support site</a>.</li> +</ul> + +<h2 id="Que_tipos_de_documentos_pertencem_à_MDN">Que tipos de documentos pertencem à MDN?</h2> + +<p>In general, MDN is for <em>product</em> documentation, not for <em>project</em> or <em>process</em> documentation (except <a href="/en-US/docs/MDN">about MDN itself</a>). So, if the document is about "how to use a thing" or "how a thing works" (where the "thing" is in one of the topic categories mentioned above), then it can go on MDN. But if it about "who's working on developing a thing" or "plans for developing a thing", then it shouldn't go on MDN. In that case, if the thing is being developed under the umbrella of Mozilla, then the <a href="https://wiki.mozilla.org/Main_Page">Mozilla project wiki</a> may be a good place for it.</p> + +<p>Here are some examples of types of documents that should <em>not</em> be placed on MDN<strong>:</strong></p> + +<ul> + <li>Planning documents</li> + <li>Design documents</li> + <li>Project proposals</li> + <li>Specifications or standards</li> + <li>Promotional material, advertising, or personal information{{ref("*")}}</li> +</ul> + +<h2 id="Vantagens_para_documentar_na_MDN">Vantagens para documentar na MDN</h2> + +<p>If you've determined that the documentation you want to write is appropriate in content and type for MDN, but you're still not sure whether MDN is the best place for it, read on. There are a lot of good reasons to create documentation on MDN.</p> + +<h3 id="Muitos_escritores_e_tradutores">Muitos escritores e tradutores</h3> + +<p>The MDN community is big. We have a lot of people that participate in creating and maintaining content on MDN. With writers and editors on every continent (okay, maybe not Antarctica, but otherwise), there's a lot of value to the sheer volume of writers:</p> + +<ul> + <li>We have a paid staff of writers whose <strong>mission</strong> is to make sure that our content is as good as possible.</li> + <li>We have a core community of volunteers who contribute substantial amounts of content and can help you.</li> + <li>The MDN team can work with you to ensure that your documentation project is adequately staffed.</li> + <li>The broader MDN community also contributes enormously, from typo fixes to editorial reviews of your content.</li> + <li>The <a href="https://chat.mozilla.org/#/room/#mdn:mozilla.org">MDN Web Docs chat room</a> offers a resource where you can talk to our writing community and get their advice, or recruit help with the production of or maintenance of your content.</li> + <li>Because we have contributors all over the world, there's always someone around, watching for problems and fixing them.</li> + <li>Our community of volunteers includes translators for many languages, who can help localize your documentation.</li> +</ul> + +<p>Do you want your development team to be entirely responsible for the production of documentation? That's likely if your documentation is maintained elsewhere.</p> + +<h3 id="Manutenção">Manutenção</h3> + +<p>Because of the sheer number of contributors, there's usually someone on hand to watch for problems with your content: from spam control to copy-editing, things can happen around the clock. Here's just a taste of what our team can do:</p> + +<dl> + <dt>Delete spam</dt> + <dd>Spam happens. We deal with it.</dd> + <dt>Copy editing</dt> + <dd>You don't have to worry if your writing isn't as clear or precise as you'd like. We'll turn your prose into something other people can read.</dd> + <dt>Consistency of style</dt> + <dd>We'll ensure that your content is stylistically consistent not just within itself, but with the other documentation around it.</dd> + <dt>Content management</dt> + <dd>Our team will help ensure that the documentation is cross-linked with other relevant materials, that articles are put in the right places, and that menus and other infrastructure is built to make it easy to follow and understand.</dd> + <dt>Site and platform maintenance</dt> + <dd>MDN has both an IT team which keeps the site up, running, and secure, and a platform development team to maintain and enhance the platform on which the content is presented. You won't need to devote your own or additional resources to documentation infrastructure.</dd> +</dl> + +<h2 id="Casos_para_documentação_em_qualquer_outra_parte">Casos para documentação em qualquer outra parte</h2> + +<p>There are also a few reasons you may be thinking about documenting your work somewhere other than MDN. Here are some of those reasons, and the pros and cons for each.</p> + +<h3 id="Planos_e_processos">Planos e processos</h3> + +<p>Documentation for plans, processes, and proposals should never be put on MDN. That's pretty simple. If your project is part of Mozilla, you can put them on the <a href="https://wiki.mozilla.org/Main_Page">Mozilla project wiki</a>.</p> + +<h3 id="O_projeto_está_no_GitHub">O projeto está no GitHub</h3> + +<p>Some of Mozilla's projects are hosted on GitHub, and GitHub offers its own wiki-like system for documentation. Some teams like to produce their documentation there. This is certainly fair and convenient if you're game to write your own docs; however, keep in mind that:</p> + +<ul> + <li>The MDN Web Docs team will probably not be able to help you. We don't generally participate in documentation work off MDN Web Docs; there are exceptions but they are exceptionally rare.</li> + <li>Cross-linking your documentation with other relevant materials may be difficult or impossible.</li> + <li>The content will not have consistent style with other documentation.</li> + <li>Your documentation loses discoverability by not being among other (Web or Mozilla) documentation.</li> +</ul> + +<p>It's possible, of course, that these things don't bother you, or aren't a problem in your situation. Some teams don't mind writing and maintaining their own docs, or are working on code that has minimal documentation needs.</p> + +<h3 id="Quer_manter_os_documentos_na_fonte">Quer manter os documentos na fonte</h3> + +<p>Some teams like to have their documentation in the source tree. This is particularly common with project internals and library projects.</p> + +<p>This approach has a couple of advantages:</p> + +<ul> + <li>It lets the developers document their technology as they code it, helping to ensure that the docs stay up to date with the code.</li> + <li>Docs can be subject to the same development and release processes as the code, including versioning.</li> +</ul> + +<p>There are some drawbacks:</p> + +<ul> + <li>The MDN Web Docs team can't help you; even if the code is within Mozilla's source repository, the system of reviews and check-ins make it impractical for the docs team to participate.</li> + <li>You don't have easy tools for cross-linking with other relevant documentation. Cross-linking provides both context and additional important information to your readers.</li> + <li>Your documentation loses discoverability by not being among other documentation.</li> + <li>Even if you use conversion tools (like JavaDoc) to create Web-readable documentation, it won't be as attractive as what we can do on MDN Web Docs.</li> +</ul> + +<p>Still, this can be a viable option (possibly even a good option) for some types of projects, especially small ones or those that aren't expected to get much interest.</p> + +<p>{{endnote("*")}} It's OK to put a limited amount of personal information on your MDN profile page. User profiles should reflect a human being, not a business or organization. A moderate degree of self-promotion is OK, but link-spamming is not. Please <em>do not </em>use your profile to upload personal photos or other irrelevant files.</p> diff --git a/files/pt-pt/mdn/index.html b/files/pt-pt/mdn/index.html new file mode 100644 index 0000000000..afad0c7b65 --- /dev/null +++ b/files/pt-pt/mdn/index.html @@ -0,0 +1,30 @@ +--- +title: O projeto MDN +slug: MDN +tags: + - Landing + - Metadados MDN +translation_of: MDN +--- +<div>{{MDNSidebar}}</div> + +<p><strong>MDN - Documentos da Web, </strong>é uma wiki onde nós documentamos a Web aberta, tecnologias da Mozilla, e outros tópicos de desenvolvimento. Qualquer poessoa é bem-vinda para adicionar e editar conteúdo. Não tem de ser um programador ou saber muito sobre tecnologia; existem várias tarefas diferentes que precisam de ser realizadas, desde o mais simples (revisão de conteúdo e correção de erros ortográficos) até ao mais complexo (escrever documentação de API).</p> + +<div class="summary"> +<p>A missão de MDN - Documentos da Web é fornecer aos programadores a informação necessária para criar facilmente projetos na plataforma da Web. Nós convidámo-lo a ajudar!</p> +</div> + +<p>Nós precisamos da sua ajuda! É fácil. Não se preocupe em pedir permissão ou em cometer erros. Por outro lado, por favor, venha conhecer a '<a href="/pt-PT/docs/MDN/Community" title="/pt-PT/docs/MDN/Community">Comunidade da MDN</a>'; nós estamos aqui para o ajudar! A documentação abaixo deverá ajudá-lo a começar.</p> + +<ul class="card-grid"> + <li><span><a class="new" href="/pt-PT/docs/MDN/Intrudu%C3%A7%C3%A3o" rel="nofollow">Início Rápido do Principiante</a></span> + + <p>É novo na MDN e pretende saber como ajudar para a tornar melhor? Comece aqui!</p> + </li> + <li><span><a href="/pt-PT/docs/MDN/Contribute">Eu sou um utilizador avançado</a></span> + <p>Aceda ao nosso guia completo e aprofundado para os colaboradores da MDN, para saber mais assim que se sentir confortável.</p> + </li> + <li><span><a class="new" href="/pt-PT/docs/MDN/Sobre/Promover" rel="nofollow">Passe a palavra</a></span> + <p>Se gostar da MDN, ajude a passar a palavra! Encontre arte, ferramentas, e guias para promover a MDN.</p> + </li> +</ul> diff --git a/files/pt-pt/mdn/kuma/index.html b/files/pt-pt/mdn/kuma/index.html new file mode 100644 index 0000000000..3ffc29d8b6 --- /dev/null +++ b/files/pt-pt/mdn/kuma/index.html @@ -0,0 +1,24 @@ +--- +title: 'Kuma: Plataforma wiki da MDN' +slug: MDN/Kuma +tags: + - Kuma + - MDN Meta + - Metadados MDN +translation_of: MDN/Kuma +--- +<div>{{MDNSidebar}}{{IncludeSubnav("/pt-PT/docs/MDN")}}</div> + +<p class="summary">Kuma é o código Django que é utilizado para os 'Documentos da Web na MDN'.</p> + +<p>{{SubpagesWithSummaries}}</p> + +<h2 id="Participe_na_plataforma_Kuma">Participe na plataforma Kuma</h2> + +<p>Para participar na plataforma Kuma:</p> + +<ul> + <li>Visite o <a href="https://github.com/mozilla/kuma">projeto Kuma no Github</a>.</li> + <li>Consulte o <a href="https://github.com/mozilla/kuma/blob/master/CONTRIBUTING.md">Guia de Contribuição.</a></li> + <li>Se necessário, consulte a <a href="http://kuma.readthedocs.org/en/latest/">documentação completa de Kuma</a>.</li> +</ul> diff --git a/files/pt-pt/mdn/sobre/index.html b/files/pt-pt/mdn/sobre/index.html new file mode 100644 index 0000000000..1da67e04e5 --- /dev/null +++ b/files/pt-pt/mdn/sobre/index.html @@ -0,0 +1,127 @@ +--- +title: Sobre a MDN +slug: MDN/Sobre +tags: + - Colaboração + - Comunidade + - Direitos de Autor + - Documentação + - Guía + - Licenças + - Metadados da MDN +translation_of: MDN/About +--- +<div>{{MDNSidebar}}</div> + +<div>{{IncludeSubnav("/pt-PT/docs/MDN")}}</div> + +<p>MDN Web Docs é uma plataforma de aprendizagem em evolução para as tecnologias da Web<em> </em>e <em>software </em>que energiza a Web, incluindo:</p> + +<ul> + <li>Padrões da <em>Web</em>, tais como <a href="/pt-PT/docs/Web/CSS" title="/en-US/docs/CSS">CSS</a>, <a href="/pt-PT/docs/Web/HTML" title="/en-US/docs/HTML">HTML</a>, e <a href="/pt-PT/docs/Web/JavaScript" title="/en-US/docs/JavaScript">JavaScript</a></li> + <li><a href="/pt-PT/docs/Apps" title="/pt-PT/docs/Apps">Desenvolvimento de aplicações da Web Aberta</a></li> + <li><a href="/pt-PT/docs/Mozilla/Add-ons" title="/en-US/docs/Add-ons">Desenvolvimento de extras (add-ons) do Firefox</a></li> +</ul> + +<h2 id="A_nossa_missão">A nossa missão</h2> + + + +<p>A missão da MDN é simples: proporcionar aos programadores a informação que eles precisam para criarem facilmente projetos na <a href="https://developer.mozilla.org/en-US/docs/Web">Web aberta</a>. Se é uma tecnologia aberta exposta à Web, nós queremos documentá-la.</p> + +<p>Além disso, nós proporcionamos documentação sobre os <a href="/pt-PT/docs/Mozilla">produtos Mozilla</a> e como <a href="/pt-PT/docs/Mozilla">criar e contribuir para os projetos da Mozilla.</a></p> + +<p>Se não tiver a certeza se um tópico em particular deve ser abrangido na MDN, leia: <a href="/pt-PT/docs/MDN/Contribute/linhas_diretrizes/Isto_pertence_a_MDN">Isso pertence ao MDN?</a></p> + + + +<h2 id="Como_é_que_pode_ajudar">Como é que pode ajudar</h2> + + + +<p>Não precisa de ser capaz de programar - ou escrever bem - para poder ajudar a MDN! Nós temos muitas maneiras em que pode ajudar, desde rever artigos para ter a certeza de que fazem sentido, para contribuir com texto, para adicionar código de exemplo. De facto, existem muitas maneiras de ajudar que nós temos uma página de <a href="https://developer.mozilla.org/pt-PT/docs/MDN/Intrudu%C3%A7%C3%A3o">Primeiros Passos</a> que o ajuda a escolher as tarefas para fazer, com base nos seus interesses e quanto tempo é que tem para contribuir!</p> + +<p>Também pode ajudar a <u><a href="https://developer.mozilla.org/pt-PT/docs/MDN/Sobre/Promover">promover a MDN</a></u> no seu próprio blogue ou site da Web.</p> + + + +<h2 id="A_comunidade_da_MDN">A comunidade da MDN</h2> + +<p>Nossa comunidade é global! Temos colaboradores incríveis em todo o mundo, em vários idiomas. Se você quiser saber mais sobre nós, ou se precisar de ajuda de qualquer tipo com o MDN, fique à vontade para visitar nosso <a href="https://discourse.mozilla.org/c/mdn">fórum de discussão</a> ou <a href="irc://irc.mozilla.org#mdn">canal de IRC</a>! Você também pode acompanhar o que estamos fazendo seguindo nossa conta no Twitter, <a href="https://twitter.com/MozDevNet">@MozDevNet</a>. Você também pode enviar tweets para nós, se você vir algo errado ou se você gostaria de oferecer feedback (ou quiser nos agradecer) aos nossos escritores e colaboradores!</p> + +<h2 id="Utilizar_conteúdo_da_MDN_Web_Docs">Utilizar conteúdo da MDN Web Docs</h2> + +<p>O conteúdo da MDN está disponível gratuitamente, e sob as licenças de código aberto.</p> + +<h3 id="Direitos_de_Autor_e_Licenças">Direitos de Autor e Licenças</h3> + +<p>O conteúdo da MDN está totalmente disponível sob várias licenças de código aberto. Esta secção cobre os tipos de conteúdo que nós proporcionamos e quais as licenças em vigor para cada.</p> + +<h4 id="Documentação_e_artigos">Documentação e artigos</h4> + +<p><strong>MDN wiki documents</strong> have been prepared with the contributions of many authors, both within and outside the Mozilla Foundation. Unless otherwise indicated, the content is available under the terms of the <a class="external text" href="http://creativecommons.org/licenses/by-sa/2.5/" rel="nofollow" title="http://creativecommons.org/licenses/by-sa/2.5/">Creative Commons Attribution-ShareAlike license</a> (CC-BY-SA), v2.5 or any later version. Please attribute "Mozilla Contributors" and include a hyperlink (online) or URL (in print) to the specific wiki page for the content being sourced. For example, to provide attribution for this article, you can write:</p> + +<blockquote><a href="/pt-PT/docs/MDN/Sobre">Sobre a MDN</a>, pelos <a href="https://developer.mozilla.org/en-US/docs/MDN/About$history">Colaboradores da Mozilla </a>(inglês) está licenciado sob <a href="http://creativecommons.org/licenses/by-sa/2.5/">CC-BY-SA 2.5</a>.</blockquote> + +<p>Note that in the example, "Mozilla Contributors" links to the history of the cited page. See <a href="http://wiki.creativecommons.org/Marking/Users">Best practices for attribution</a> (EN) for further explanation.</p> + +<div class="note"> +<p><strong>Nota:</strong> consulte o <a href="/pt-PT/docs/Archive/Meta_docs/Conteudo_MDN_em_WebPlatform.org" title="/en-US/docs/MDN_content_on_WebPlatform.org">conteúdo da MDN em WebPlatform.org</a> para informação sobre como reutilizar e atribuir conteúdo MDN nesse site.</p> +</div> + +<h4 id="Code_samples_and_snippets">Code samples and snippets</h4> + +<p>Code samples added to this wiki before August 20, 2010 are available under the <a class="external" href="http://www.opensource.org/licenses/mit-license.php" title="http://www.opensource.org/licenses/mit-license.php">MIT license</a>; you should insert the following attribution information into the MIT template: "© <date of last wiki page revision> <name of person who put it in the wiki>".</p> + +<p>Code samples added on or after August 20, 2010 are in the <a class="external" href="http://creativecommons.org/publicdomain/zero/1.0/" title="http://wiki.creativecommons.org/Public_domain">public domain</a>. No licensing notice is necessary, but if you need one, you can use: "Any copyright is dedicated to the Public Domain. http://creativecommons.org/publicdomain/zero/1.0/".</p> + +<h4 id="Contribuições">Contribuições</h4> + +<p>If you wish to contribute to this wiki, you must make your documentation available under the Attribution-ShareAlike license (or occasionally an alternative license already specified by the page you are editing), and your code samples available under <a href="http://creativecommons.org/publicdomain/zero/1.0/" title="http://creativecommons.org/publicdomain/zero/1.0/">Creative Commons CC-0</a> (a Public Domain dedication). Adding to this wiki means you agree that your contributions will be made available under those licenses.</p> + +<p>Some older content was made available under a license other than the licenses noted above; these are indicated at the bottom of each page by way of an <a class="internal" href="/Archive/Meta_docs/Examples/Alternate_License_Block" title="Project:En/Examples/Alternate License Block">Alternate License Block</a>.</p> + +<div class="warning"> +<p>Não podem ser criadas novas páginas utilizando licenças alternativas.</p> +</div> + +<p><strong>Os direitos de autor para os materiais contribuídos permanecem com o autor, a menos que o mesmo o atribua a outra pessoa</strong>.</p> + +<p>Se tiver quaisquer questões relacionadas ou problemas sobre qualquer coisa aqui discutida, por favor, contacte <a class="external" href="mailto:eshepherd@mozilla.com" rel="nofollow" title="mailto:eshepherd@mozilla.com">Eric Shepherd</a>.</p> + +<p><strong>Logótipo, marcas registadas, marcas de serviço e wordmarks</strong></p> + +<hr> +<p>The rights in the trademarks, logos, service marks of the Mozilla Foundation, as well as the look and feel of this web site, are not licensed under the Creative Commons license, and to the extent they are works of authorship (like logos and graphic design), they are not included in the work that is licensed under those terms. If you use the text of documents, and wish to also use any of these rights, or if you have any other questions about complying with our licensing terms for this collection, you should contact the Mozilla Foundation here: <a class="external text" href="mailto:licensing@mozilla.org" rel="nofollow" title="mailto:licensing@mozilla.org">licensing@mozilla.org</a>.</p> + +<h3 id="Interligação_com_a_MDN">Interligação com a MDN</h3> + +<p>See this article for guidance on <a href="/en-US/docs/MDN/About/Linking_to_MDN">linking to MDN</a> for best practices when linking.</p> + +<h2 id="Transferência_de_conteúdo">Transferência de conteúdo</h2> + +<p>Pode transferir <a href="/media/developer.mozilla.org.tar.gz">um <em>tarball mirror </em>completo da MDN</a>. (2.1GB, em fevereiro de 2017)</p> + +<h3 id="Páginas_únicas">Páginas únicas</h3> + +<p>You can retrieve the content of a single page on MDN by adding <a href="/en-US/docs/MDN/Kuma/API#Document_parameters">document parameters</a> to the URL to specify what format you want.</p> + +<h3 id="Ferramentas_de_terceiros">Ferramentas de terceiros</h3> + +<p>You can view MDN content via third-party tools like <a href="http://kapeli.com/dash">Dash</a> (for Mac OS) and <a href="http://zealdocs.org/">Zeal</a> (for Linux and Windows).</p> + +<p><a href="https://kapeli.com/">Kapeli</a> also publishes <a href="https://kapeli.com/mdn_offline">offline MDN docs</a> covering HTML, CSS, JavaScript, SVG, and XSLT.</p> + +<h2 id="Comunicação_de_problemas_com_MDN_Web_Docs">Comunicação de problemas com MDN Web Docs</h2> + +<p>Consultar "<a href="/pt-PT/docs/MDN/Contribute/Howto/Comunicar_um_problema">Como comunicar um problema na MDN</a>".</p> + +<h2 id="Histórico_da_MDN_Web_Docs">Histórico da MDN Web Docs</h2> + +<p>MDN Web Docs (anteriormente Mozilla Developer Network (MDN), anteriormente projeto da Mozilla Developer Center (MDC), a.k.a. Devmo) começou no início de 2005, quando a <a class="external" href="http://www.mozillafoundation.org">Fundação Mozilla</a> (inglês) obteve a licença da AOL para utilizar o conteúdo <a href="https://web.archive.org/web/*/devedge.netscape.com" title="Project:en/DevEdge">DevEdge</a> original do Netscape. O conteúdo DevEdge foi minado para o material ainda útil, que foi migrado por voluntários para esta wiki, e assim esta seria mais fácil para atualizar e manter.</p> + +<p>Pode encontrar mais história da MDN na nossa página de <a href="/pt-PT/docs/MDN_at_ten">celebração do 10º. aniversário</a>, incluindo uma história verbal por algumas das pessoas que estiverem envolvidas.</p> + +<h2 id="Sobre_a_Mozilla">Sobre a Mozilla</h2> + +<p>Se quer saber mais sobre quem somos, como fazer parte da Mozilla ou apenas onde nos encontrar, veio ao lugar certo. Para descobrir o que nos impulsiona e nos torna diferentes, visite a nossa página da <a href="https://www.mozilla.org/pt-PT/mission/">missão</a>.</p> diff --git a/files/pt-pt/mdn/structures/api_references/barras_laterais_de_referencia_da_api/index.html b/files/pt-pt/mdn/structures/api_references/barras_laterais_de_referencia_da_api/index.html new file mode 100644 index 0000000000..8e28e33556 --- /dev/null +++ b/files/pt-pt/mdn/structures/api_references/barras_laterais_de_referencia_da_api/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> diff --git a/files/pt-pt/mdn/structures/api_references/index.html b/files/pt-pt/mdn/structures/api_references/index.html new file mode 100644 index 0000000000..a7a7b21004 --- /dev/null +++ b/files/pt-pt/mdn/structures/api_references/index.html @@ -0,0 +1,58 @@ +--- +title: API references +slug: MDN/Structures/API_references +tags: + - API + - Contribute + - Guide + - NeedsTranslation + - Reference + - TopicStub +translation_of: MDN/Structures/API_references +--- +<div>{{MDNSidebar}}</div><div>{{IncludeSubnav("/en-US/docs/MDN")}}</div> + +<p class="summary">Client-side JavaScript APIs form a large part of the technology available on the web, and MDN includes extensive reference material to explain what functionality is available in these APIs, and how to use it. In this set of guides we explain how to create API reference material on MDN.</p> + +<h2 id="Prerequisite_resources">Prerequisite resources</h2> + +<p>Before starting to document an API, you should have available:</p> + +<ol> + <li>The latest spec: Whether it is a W3C Recommendation or an early editor's draft, you should refer to the latest available draft of the spec that covers (or specs that cover) that API. To find it, you can usually do a Web search. The latest version will often be linked to from all versions of the spec, listed under "latest draft" or similar.</li> + <li>The latest modern web browsers: These should be experimental/alpha builds such as <a href="https://nightly.mozilla.org/">Firefox Nightly</a>/<a href="https://www.google.com/intl/en/chrome/browser/canary.html">Chrome Canary</a> that are more likely to support the features you are documenting. This is especially pertinent if you are documenting a nascent/experimental API.</li> + <li>Demos/blog posts/other info: Find as much info as you can. It is useful to start by spending time familiarizing yourself with how the API works — learn what the main interfaces/properties/methods are, what the primary use cases are, and how to write simple functionality with it.</li> + <li>Useful engineering contacts: It is really useful to find yourself a friendly engineering contact to ask questions about the spec, someone who is involved in the standardization of the API, or its implementation in a browser. Good places to find them are: + <ul> + <li>Your internal company address book, if you work for a relevant company.</li> + <li>A public mailing list that is involved in the discussion of that API, such as Mozilla's <a href="https://lists.mozilla.org/listinfo/dev-platform">dev-platform</a> or <a href="https://lists.mozilla.org/listinfo/dev-webapi">dev-webapi</a> lists, or a W3C list like <a href="https://lists.w3.org/Archives/Public/public-webapps/">public-webapps</a>.</li> + <li>The spec itself. For example, the <a href="https://webaudio.github.io/web-audio-api/">Web Audio API spec</a> lists the authors and their contact details at the top.</li> + </ul> + </li> +</ol> + +<h2 id="High_level_structure">High level structure</h2> + +<dl> + <dt><a href="/en-US/docs/MDN/Contribute/Structures/API_references/What_does_an_API_reference_need">What does an API reference need?</a></dt> + <dd>This article explains what pages are required for a complete API reference.</dd> + <dt><a href="/en-US/docs/MDN/Contribute/Structures/Page_types">Page types</a></dt> + <dd>There are a number of types of pages that are used repeatedly on MDN. This article describes these page types, their purpose, and gives examples of each and templates to use when creating a new page.</dd> +</dl> + +<h2 id="Individual_page_features">Individual page features</h2> + +<p>These articles explain how to create the individual page features required for API reference pages.</p> + +<dl> + <dt><a href="/en-US/docs/MDN/Contribute/Structures/API_references/API_reference_sidebars">API reference sidebars</a></dt> + <dd>When including a sidebar on your MDN API reference articles, you are able to customize it so that it displays links to related Interfaces, tutorials, and other resources relevant just to that API. This article explains how.</dd> + <dt><a href="/en-US/docs/MDN/Contribute/Structures/Syntax_sections">Syntax sections</a></dt> + <dd>The syntax section of an MDN reference page contains a syntax box defining the exact syntax that a feature has (e.g. what parameters can it accept, which ones are optional?) This article explains how to write syntax boxes for refererence articles.</dd> + <dt><a href="/en-US/docs/MDN/Contribute/Structures/Code_examples">Code examples</a></dt> + <dd>On MDN, you'll see numerous code examples inserted throughout the pages to demonstrate usage of web platform features. This article discusses the different mechanisms available for adding code examples to pages, along with which ones you should use and when.</dd> + <dt><a href="/en-US/docs/MDN/Contribute/Structures/Specification_tables">Specification tables</a></dt> + <dd>Every reference page on MDN should provide information about the specification or specifications in which that API or technology was defined. This article demonstrates what these tables look like and explains how to construct them.</dd> + <dt><a href="/en-US/docs/MDN/Contribute/Structures/Compatibility_tables">Compatibility tables</a></dt> + <dd>MDN has a standard format for compatibility tables for our open web documentation; that is, documentation of technologies such as the DOM, HTML, CSS, JavaScript, SVG, and so forth, that are shared across all browsers. This article covers how to use our features to add compatibility data to MDN pages.</dd> +</dl> diff --git a/files/pt-pt/mdn/structures/api_references/o_que_e_que_uma_referencia_de_api_precisa/index.html b/files/pt-pt/mdn/structures/api_references/o_que_e_que_uma_referencia_de_api_precisa/index.html new file mode 100644 index 0000000000..986791e813 --- /dev/null +++ b/files/pt-pt/mdn/structures/api_references/o_que_e_que_uma_referencia_de_api_precisa/index.html @@ -0,0 +1,162 @@ +--- +title: O que é que uma referência de API precisa? +slug: MDN/Structures/API_references/O_que_e_que_uma_referencia_de_API_precisa +translation_of: MDN/Structures/API_references/What_does_an_API_reference_need +--- +<div>{{MDNSidebar}}</div><p class="summary">Este artigo explica quais as páginas que são necessárias para uma referência completa da API .</p> + +<div class="note"> +<p><strong>Nota</strong>: It is a good idea to create the list of documents you need to write or update when you are working on an API reference, then check them off as you complete them.</p> +</div> + +<h2 id="API_pages_at_a_glance">API pages at a glance</h2> + +<p>An API reference will generally contain the following pages. You can find more details of what each page contains, examples, and templates, in our <a href="/en-US/docs/MDN/Contribute/Structures/Page_types">Page types</a> article.</p> + +<ol> + <li>Overview page</li> + <li>Interface pages</li> + <li>Constructor pages</li> + <li>Method pages</li> + <li>Property pages (including event handlers properties)</li> + <li>Event pages</li> + <li>Concept/guide pages</li> + <li>Examples</li> +</ol> + +<div class="note"> +<p><strong>Nota</strong>: We'll be referring to the <a href="/en-US/docs/Web/API/Web_Audio_API">Web Audio API</a> for examples in this article.</p> +</div> + +<div class="note"> +<p><strong>Nota</strong>: To create a page as specified below, the easiest way is to go to the parent page you want it to hang off, and choose <em>Cog icon > New sub-article</em>. If you haven't got this option available on your MDN interface, you'll need to request this privilege (ask at <code>mdn-admins@mozilla.org</code>), or ask another MDN contributor to create them for you.</p> +</div> + +<h3 id="Página_de_sinopse">Página de sinopse</h3> + +<p>A single API overview page is used to describe the role of the API, its top-level interfaces, related features contained in other interfaces, and other high level details. Its name and slug should be the name of the API plus "API" on the end. It is placed at the top level of the API reference, as a child of <a href="/en-US/docs/Web/API">https://developer.mozilla.org/en-US/docs/Web/API</a>.</p> + +<p>Example:</p> + +<ul> + <li>Title: <em>Web Audio API</em></li> + <li>Slug: <em>Web_Audio_API</em></li> + <li>URL: <a href="https://developer.mozilla.org/en-US/docs/Web/API/Web_Audio_API">https://developer.mozilla.org/en-US/docs/Web/API/Web_Audio_API</a></li> +</ul> + +<h3 id="Páginas_da_interface">Páginas da interface</h3> + +<p>Each interface will have its own page too, describing the purpose of the interface, listing any members (constructors, methods, properties, etc. it contains), and showing what browsers it is compatible with. A page's name and slug should be the name of the interface, exactly as written in the spec. Each page is placed at the top level of the API reference, as a child of <a href="/en-US/docs/Web/API">https://developer.mozilla.org/en-US/docs/Web/API</a>.</p> + +<p>Exemplos:</p> + +<ul> + <li>Title: <em>AudioContext</em></li> + <li>Slug: <em>AudioContext</em></li> + <li>URL: <a href="https://developer.mozilla.org/en-US/docs/Web/API/AudioContext">https://developer.mozilla.org/en-US/docs/Web/API/AudioContext</a></li> +</ul> + +<ul> + <li>Title: <em>AudioNode</em></li> + <li>Slug: <em>AudioNode</em></li> + <li>URL: <a href="https://developer.mozilla.org/en-US/docs/Web/API/AudioNode">https://developer.mozilla.org/en-US/docs/Web/API/AudioNode</a></li> +</ul> + +<div class="note"> +<p><strong>Nota:</strong> We document every member appearing in the interface. You should bear the following rules in mind:</p> + +<ul> + <li>We document methods defined on the <u>prototype</u> of an object implementing this interface (instance methods), and methods defined on the actual class itself (static methods). On the rare occasions that they both exist on the same interface, you should list them in separate sections on the page (Static methods/Instance methods). Usually only instance methods exist, in which case you can put these under the title "Methods".</li> + <li>We do not document inherited properties and methods of the interface: they are listed on the respective parent interface. We do hint at their existence though.</li> + <li>We do document properties and methods defined in mixins, though we use the mixin name as interface name. (This is not optimal as the mixin name will not appear in the console, but it prevents the duplication of documentation. We may revisit this in the future.)</li> + <li>Special methods like the stringfier (<code>toString()</code>) and the jsonizier (<code>toJSON()</code>) are also listed if they do exist.</li> + <li>Named constructors (like <code>Image()</code> for {{domxref("HTMLImageElement")}} ) are also listed, if relevant.</li> +</ul> +</div> + +<h3 id="Páginas_de_constructor">Páginas de <em>constructor</em></h3> + +<p>Each interface has 0 or 1 constructors, documented on a subpage of the interface's page. It describes the purpose of the constructor and shows what its syntax looks like, usage examples, browser compatibility information, etc. Its slug is the name of the constructor, which is exactly the same as the interface name, and the title is interface name, dot, constructor name, then parentheses on the end.</p> + +<p>Example:</p> + +<ul> + <li>Title: <em>AudioContext.AudioContext()</em></li> + <li>Slug: <em>AudioContext</em></li> + <li>URL: <a href="https://developer.mozilla.org/en-US/docs/Web/API/AudioContext/AudioContext">https://developer.mozilla.org/en-US/docs/Web/API/AudioContext/AudioContext</a></li> +</ul> + +<h3 id="Páginas_de_propriedade">Páginas de propriedade</h3> + +<p>Each interface has zero or more properties, documented on subpages of the interface's page. each page describes the purpose of the property and shows what its syntax looks like, usage examples, browser compatibility information, etc. Its slug is the name of the property, and the title is interface name, dot, then property name.</p> + +<p>Examples:</p> + +<ul> + <li>Title: <em>AudioContext.state</em></li> + <li>Slug: <em>state</em></li> + <li>URL: <a href="/en-US/docs/Web/API/AudioContext/state">https://developer.mozilla.org/en-US/docs/Web/API/AudioContext/state</a></li> +</ul> + +<ul> + <li>Title: <em>AudioContext.onstatechange</em></li> + <li>Slug: <em>onstatechange</em></li> + <li>URL: <a href="/en-US/docs/Web/API/AudioContext/onstatechange">https://developer.mozilla.org/en-US/docs/Web/API/AudioContext/onstatechange</a></li> +</ul> + +<div class="note"> +<p><strong>Nota:</strong> Event handler properties are treated in the same way as regular properties; they are generally listed in a separate section on the interface page though.</p> +</div> + +<ul> +</ul> + +<h3 id="Páginas_de_método">Páginas de método</h3> + +<p>Each interface has zero or more methods, documented on subpages of the interface's page. each page describes the purpose of the method and shows what its syntax looks like, usage examples, browser compatibility information, etc. Its slug is the name of the method, and the title is interface name, dot, method name, then parentheses.</p> + +<p>Examples:</p> + +<ul> + <li>Title: <em>AudioContext.close()</em></li> + <li>Slug: <em>close</em></li> + <li>URL: <a href="/en-US/docs/Web/API/AudioContext/close">https://developer.mozilla.org/en-US/docs/Web/API/AudioContext/close</a></li> +</ul> + +<ul> + <li>Title: <em>AudioContext.createGain()</em></li> + <li>Slug: <em>createGain</em></li> + <li>URL: <a href="/en-US/docs/Web/API/AudioContext/createGain">https://developer.mozilla.org/en-US/docs/Web/API/AudioContext/createGain</a></li> +</ul> + +<h3 id="Páginas_de_evento">Páginas de evento</h3> + +<p>Each event handler property you create will have a corresponding event page, describing the event that causes the handler to fire, documented on a subpage of <a href="/en-US/docs/Web/Events">https://developer.mozilla.org/en-US/docs/Web/Events</a>. Each page describes the purpose of the event and shows what its syntax looks like, usage examples, browser compatibility information, etc. Its slug and title is the name of the event.</p> + +<p>Example:</p> + +<ul> + <li>Title: <em>statechange</em></li> + <li>Slug: <em>statechange</em></li> + <li>URL: <a href="/en-US/docs/Web/Events/statechange">https://developer.mozilla.org/en-US/docs/Web/Events/statechange</a></li> +</ul> + +<h3 id="Páginas_de_conceitoguia">Páginas de conceito/guia</h3> + +<p>Most API references have at least one guide and sometimes also a concept page to accompany it. At minimum, an API reference should contain a guide called "Using the <em>name-of-api</em>", which will provide a basic guide to how to use the API. More complex APIs may require multiple usage guides to explain how to use different aspects of the API.</p> + +<p>If required, you can also including a concepts article called "<em>name-of-api</em> concepts", which will provide explanation of the theory behind any concepts related to the API that developers should understand to effectively use it.</p> + +<p>These articles should all be created as subpages of the API overview page. For example, the Web Audio has four guides and a concept article:</p> + +<ul> + <li><a href="/en-US/docs/Web/API/Web_Audio_API/Using_Web_Audio_API">https://developer.mozilla.org/en-US/docs/Web/API/Web_Audio_API/Using_Web_Audio_API</a></li> + <li><a href="/en-US/docs/Web/API/Web_Audio_API/Visualizations_with_Web_Audio_API">https://developer.mozilla.org/en-US/docs/Web/API/Web_Audio_API/Visualizations_with_Web_Audio_API</a></li> + <li><a href="/en-US/docs/Web/API/Web_Audio_API/Web_audio_spatialization_basics">https://developer.mozilla.org/en-US/docs/Web/API/Web_Audio_API/Web_audio_spatialization_basics</a></li> + <li><a href="/en-US/docs/Web/API/Web_Audio_API/Porting_webkitAudioContext_code_to_standards_based_AudioContext">https://developer.mozilla.org/en-US/docs/Web/API/Web_Audio_API/Porting_webkitAudioContext_code_to_standards_based_AudioContext</a></li> + <li><a href="/en-US/docs/Web/API/Web_Audio_API/Basic_concepts_behind_Web_Audio_API">https://developer.mozilla.org/en-US/docs/Web/API/Web_Audio_API/Basic_concepts_behind_Web_Audio_API</a></li> +</ul> + +<h3 id="Exemplos">Exemplos</h3> + +<p>You should create some examples that demonstrate at least the most common use cases of the API. You can put these anywhere that is appropriate, although the recommended place is the <a href="https://github.com/mdn/">MDN GitHub repo</a>.</p> diff --git a/files/pt-pt/mdn/structures/exemplos_live/index.html b/files/pt-pt/mdn/structures/exemplos_live/index.html new file mode 100644 index 0000000000..91295fc37c --- /dev/null +++ b/files/pt-pt/mdn/structures/exemplos_live/index.html @@ -0,0 +1,248 @@ +--- +title: Exemplos live +slug: MDN/Structures/Exemplos_live +tags: + - Estruturas + - Guia(2) + - Intermediário + - Metadados MDN +translation_of: MDN/Structures/Live_samples +--- +<div>{{MDNSidebar}}</div><p><span class="seoSummary">Exemplos MDN supports turning sample code displayed in articles into running samples the reader can look at in action. These live samples can include HTML, CSS, and JavaScript in any combination.</span> Note that "live" samples are <em>not interactive</em>; however, they do ensure that the output displayed for a sample matches the code of the sample exactly, because it is actually generated by the code sample.</p> + +<h2 id="Como_é_que_os_exemplos_live_funcionam">Como é que os exemplos <em>live </em>funcionam</h2> + +<p>The live sample system gathers up all the code in a group, merges it into one HTML file, and then renders that HTML in an {{HTMLElement("iframe")}}. A live sample therefore consists of two pieces:</p> + +<ul> + <li>A group of code blocks</li> + <li>The macro call that (creates the frame or the link that) displays the result of the code blocks</li> +</ul> + +<p>A "group" of code blocks, in this context, is identified by the ID of a heading or a block element (such as a {{HTMLElement("div")}}).</p> + +<ul> + <li>If the ID belongs to a block element, the group includes all the code blocks within the enclosing block element whose ID is used. </li> + <li>If the ID belongs to a heading, the group includes all the code blocks that are after that heading and before the next heading of the same heading level. Note that code blocks under subheadings of the specified heading are all used; if this is not the effect you want, use an ID on a block element instead.</li> +</ul> + +<p>The macro uses a special URL to fetch the sample code for a given group: <code>http://<em>url-of-page</em>$samples/<em>group-id</em></code>, where <code>group-id</code> is the ID of the heading or block where the code is located. The resulting frame (or page) is sandboxed, secure, and technically may do anything that works on the Web. Of course, as a practical matter, the code must contribute to the point of the page that contains it; random stuff running on MDN will be removed by the editor community.</p> + +<div class="note"> +<p><strong>Nota:</strong> You <strong>must</strong> use the macro for presenting the live sample's output. MDN's editor will strip out any direct use of the <code><iframe></code> element in order to ensure security.</p> +</div> + +<p>Each {{HTMLElement("pre")}} block containing code for the sample has a class on it that indicates whether it's HTML, CSS, or JavaScript code; these are "brush: html", "brush: css", and "brush: js". These classes must be on the corresponding blocks of code so that the wiki can use them correctly; fortunately, these are added for you automatically when you use the syntax highlighter features in the editor's toolbar.</p> + +<p>The live sample system has lots of options available, and we'll try to break things down to look at them a bit at a time.</p> + +<h3 id="Macros_de_exmplo_live">Macros de exmplo <em>live</em></h3> + +<p>There are two macros that you can use to display live samples:</p> + +<ul> + <li><span class="templateLink"><code><a href="/en-US/docs/Template:EmbedLiveSample">EmbedLiveSample</a> </code></span>embeds a live sample into a page</li> + <li><span class="templateLink"><code><a href="/en-US/docs/Template:LiveSampleLink">LiveSampleLink</a></code></span> creates a link that opens the live sample in a new page</li> +</ul> + +<p>In many cases, you may be able to add the <span class="templateLink"><code><a href="/en-US/docs/Template:EmbedLiveSample">EmbedLiveSample</a></code></span> or <span class="templateLink"><code><a href="/en-US/docs/Template:LiveSampleLink">LiveSampleLink</a></code></span> macro to pages with little or no additional work! As long as the sample can be identified by a heading's ID or is in a block with an ID you can use, simply adding the macro should do the job.</p> + +<h4 id="EmbedLiveSample_macro">EmbedLiveSample macro</h4> + +<pre class="syntaxbox notranslate"> \{{EmbedLiveSample(<em>block_ID</em>, <em>width</em>, <em>height</em>, <em>screenshot_URL</em>, <em>page_slug</em>)}}</pre> + +<dl> + <dt>block_ID</dt> + <dd>Required: The ID of the heading or enclosing block to draw the code from. The best way to be sure you have the ID right is to look at the URL of the section in the page's table of contents.</dd> + <dt>width</dt> + <dd>The width of the {{HTMLElement("iframe")}} to create, specified in <code>px</code>. This is optional; a reasonable default width will be used if you omit this. Note that if you want to use a specific width, you <em>must</em> also specify the height parameter.</dd> + <dt>height</dt> + <dd>The height of the {{HTMLElement("iframe")}} to create, specified in <code>px</code>. This is optional; a reasonable default height will be used if you omit this. Note that if you want to use a specific height, you <em>must</em> also specify the width parameter. If you use only one of them, the default frame size is used.</dd> + <dt>screenshot_URL</dt> + <dd>The URL of a screenshot that shows what the live sample should look like. This is optional, but can be useful for new technologies that may not work in the user's browser, so they can see what the sample would look like if it were supported by their browser. If you include this parameter, the screenshot is shown next to the live sample, with appropriate headings.</dd> + <dt>page_slug</dt> + <dd>The slug of the page containing the sample; this is optional, and if it's not provided, the sample is pulled from the same page on which the macro is used.</dd> +</dl> + +<ol> +</ol> + +<h4 id="LiveSampleLink_macro">LiveSampleLink macro</h4> + +<pre class="syntaxbox notranslate"> \{{LiveSampleLink(<em>block_ID</em>, <em>link_text</em>)}}</pre> + +<dl> + <dt>block_ID</dt> + <dd>The ID of the heading or enclosing block to draw the code from. The best way to be sure you have the ID right is to look at the URL of the section in the page's table of contents.</dd> + <dt>link_text</dt> + <dd>A string to use as the link text.</dd> +</dl> + +<h2 id="Utilizar_o_sistema_de_exemplo_live">Utilizar o sistema de exemplo <em>live</em></h2> + +<p>The sections below describe a few common use cases for the live sample system.</p> + +<p>In all of these cases, to see the results of the live sample, you must click <strong>Save Changes</strong> in the editor (which takes you out of edit mode). Because of the reflexive, <a href="http://www.imdb.com/title/tt1375666/?ref_=nv_sr_1"><em>Inception</em></a>-like nature of live samples, the <strong>Preview Changes</strong> functionality is <em>not</em> able to display live samples.</p> + +<h3 id="Turning_snippets_into_live_samples">Turning snippets into live samples</h3> + +<p>One common use case is to take existing code snippets already shown on MDN and turn them into live samples.</p> + +<h4 id="Preparar_os_exemplos_de_código">Preparar os exemplos de código</h4> + +<p>The first step is to either add code snippets or ensure that existing ones are ready to be used as live samples, in terms of the content and in terms of their mark-up. The code snippets, taken together, must comprise a complete, runnable example. For example, if the existing snippet shows only CSS, you might need to add a snippet of HTML for the CSS to operate on.</p> + +<p>Each piece of code must be in a {{HTMLElement("pre")}} block, with a separate block for each language, properly marked as to which language it is. Most of the time, this has already been done, but it's always worth double-checking to be sure each piece of code is configured with the correct syntax. Next to the <strong>PRE</strong> icon in the toolbar is a drop-down menu icon (tooltip: Syntax Highlighter) with the various languages that MDN does syntax highlighting for. Setting the language for the block for syntax highlighting also correlates it with a language for the purposes of the live sample system.</p> + +<div class="note"> +<p><strong>Nota:</strong> You may have more than one block for each language; they are all concatenated together. This lets you have a chunk of code, followed by an explanation of how it works, then another chunk, and so forth. This makes it even easier to produce tutorials and the like that utilize live samples interspersed with explanatory text.</p> +</div> + +<p>So make sure the {{HTMLElement("pre")}} blocks for your HTML, CSS, and/or JavaScript code are each configured correctly for that language's syntax highlighting, and you're good to go.</p> + +<div class="note"> +<p><strong>Nota:</strong> When pasting content into MDN, please be aware that if pasting styled content (including, for example, syntax highlighting in code being copied from another site) that you may be bringing along unwanted and unneeded additional styles or classes. Please be careful not to do this; if necessary, review your edit in source mode to remove these unnecessary styles and classes (or check it before pasting, or use the "Paste as plain text" option instead).</p> +</div> + +<h4 id="Inserir_a_macro_de_exemplo_live">Inserir a macro de exemplo <em>live</em></h4> + +<p>Once the code is in place and properly configured to identify each block's language, you need to insert the macro that creates the iframe.</p> + +<ol> + <li>Click the <strong>Insert Live Code Sample iFrame</strong> button in the toolbar; it looks like this: <img alt="" src="https://mdn.mozillademos.org/files/5383/insert-live-sample-btn.png" style="height: 18px; width: 19px;">. This opens a dialog box for configuring your live sample frame:<img alt="" src="https://mdn.mozillademos.org/files/5385/sample-finder.png" style="height: 358px; width: 405px;"></li> + <li>Under <strong>Document</strong>, enter the title of the article that contains the sample you wish to embed. By default, it's the article you're currently editing, but you can choose an article elsewhere on MDN, too. This makes it possible to reuse samples on multiple pages if needed. (If you type new text in this field, a menu of partially matching pages appears; select the title of the page you want.)</li> + <li>In the <strong>Sections in Document</strong> menu, select the section in the article that contains the code blocks of the sample you want to embed.</li> + <li>Click the <strong>OK</strong> button to generate and insert the macro call that creates the sample frame for you. The macro call looks something like this:<br> + <strong>\{{ EmbedLiveSample('Live_sample_demo') }}</strong></li> +</ol> + +<h3 id="Adicionar_um_novo_exemplo_live">Adicionar um novo exemplo <em>live</em></h3> + +<p>If you're writing a new page, and want to insert code that you want to present as a live sample, even more of the work can be done for you by the editor! </p> + +<ol> + <li>Click the <strong>Insert Code Sample Template</strong> button in the toolbar, which looks like this: <img alt="" src="/files/4265/live-sample-button.png" style="height: 19px; width: 21px;">. This presents a simple dialog asking you to name your live sample:<br> + <img alt="" src="https://mdn.mozillademos.org/files/5387/insert-live-sample-template.png" style="height: 155px; width: 251px;"></li> + <li>Enter the title of the sample; this is used as the heading for the sample. Make sure that your title makes sense within the context of the page you're on.</li> + <li>Click <strong>OK</strong>. A new heading with the title you entered is created, with sub-headings and empty code blocks for HTML, CSS, and JavaScript.</li> + <li>Delete any headings and code blocks you don't need.</li> + <li>Enter the code that makes up your sample in the appropriate code blocks</li> + <li><a href="#conventions">Check conventions</a></li> +</ol> + +<h3 id="Utilizar_o_Localizador_de_Exemplo">Utilizar o 'Localizador de Exemplo'</h3> + +<p>As mentioned above, the Sample Finder is activated by clicking the<strong> Insert Live Code Sample iFrame</strong> icon. Unfortunately the the Sample Finder may produce a macro that is NOT usable without editing. There are two problem areas that should be carefully checked and edited if necessary.</p> + +<ol> + <li><strong>Document </strong>field. This field will search as you type and present a list of documents that match your string. But the list presented will NOT include the sub-page. For example, say you are working on the subpage for <a href="https://developer.mozilla.org/en-US/docs/Web/CSS/@counter-style/negative">Negative </a>under the main page <a href="https://developer.mozilla.org/en-US/docs/Web/CSS/@counter-style">@counter-style</a>. The Sample Finder search will not find Negative but will find the main page @counter-style. When @counter-style is selected the field background turns green. See below for the issue this creates.</li> + <li><strong>Sections in Document</strong>. The pull-down menu Sections in Document may not show the section that you need. Just pick one, say Examples, and it can be fixed with a simple edit.</li> +</ol> + +<p>Here is what the Sample Finder produced:</p> + +<pre class="notranslate"><code>\{{ EmbedLiveSample('Examples', '', '', '', 'Web/CSS/@counter-style') }}</code></pre> + +<p>This macro will not work. The block_ID is Examples and it should be Example in this case (check the source ID for this section to verify which block_ID you need to use. Similarly the page_slug is @counter-style and it should be @counter-style/negative. These corrections can be done directly in the page with Edit active.</p> + +<p>After editing the macro now looks like this:</p> + +<pre class="notranslate"><code>\{{ EmbedLiveSample('Example', '', '', '', 'Web/CSS/@counter-style/negative') }}</code></pre> + +<p>This edited macro will work correctly. If the macro is working correctly you will see the <strong>Open in CodePen</strong> button. A thumbnail of the example should appear above the Open in CodePen button. If the button is there but there isn't a thumbnail, just wait a few minutes. It may take some time for the server to generate it.</p> + +<h2 id="Live_sample_demo" name="Live_sample_demo">Encontrar exemplos que precisam de ser atualizados</h2> + +<p>When looking for existing samples to update, there are three main kinds of updating you may wish to do:</p> + +<ul> + <li>Turn an existing non-live example snippet into a live sample.</li> + <li>Correct bugs in an existing live sample.</li> + <li>Improve an existing live sample, or update a sample based on technology changes.</li> +</ul> + +<div class="note"> +<p><strong>Note</strong><strong>:</strong> If you find an article that has samples in need of being updated to use the live sample system, please add the tag "NeedsLiveSample" to the page.</p> +</div> + +<h3 id="Encontrar_exemplos_para_os_transformnar_em_exemplos_live">Encontrar exemplos para os transformnar em exemplos <em>live</em></h3> + +<p>MDN has lots of older examples that don't yet use the live sample system. Our goal is to update most or all of these to be live samples. This will improve consistency and usability. You will almost certainly find many of these as you use MDN on a daily basis; however, how can you find them if you're specifically looking for them to update? Unfortunately, there's not an easy way to do that. But there are some guidelines you can follow to help track them down:</p> + +<ul> + <li>Start by looking at this <a href="/en-US/docs/tag/NeedsLiveSample" title="/en-US/docs/tag/NeedsLiveSamples">list of pages tagged with "NeedsLiveSample"</a>. These are pages that users have marked as needing updating. You should add this tag yourself, if you see a page that needs to be updated to use live samples but don't have time to fix right away.</li> + <li>Browse through documentation trees that are likely to include examples, such as the <a href="/en-US/docs/Web/JavaScript/Guide" title="/en-US/docs/Web/JavaScript/Guide">JavaScript Guide</a>, <a href="/en-US/docs/Web/HTML" title="/en-US/docs/Web/HTML">HTML documentation</a>, and <a href="/en-US/docs/Web/CSS/Reference" title="/en-US/docs/Web/CSS/Reference">CSS reference</a>.</li> + <li>Search for terms like "<a href="/en-US/search?q=example" title="/en-US/search?q=example">example</a>" or "<a href="/en-US/search?q=sample" title="/en-US/search?q=sample">sample</a>" and look through the results for pages to update.</li> +</ul> + +<h2 id="Live_sample_demo" name="Live_sample_demo">Demonstração de exemplo <em>live</em></h2> + +<p>This section is the result of using the live sample template button to create not only the main heading ("Live sample demo"), but also subheadings for our HTML, CSS, and JavaScript content. You're not limited to one block of each; in addition, they don't even need to be in any particular order. Mix and match!</p> + +<p>You may choose to delete any of these you wish; if you don't need any script, just delete that heading and its {{HTMLElement("pre")}} block. You can also delete the heading for a code block ("HTML", "CSS", or "JavaScript"), since these are not used by the live sample macro.</p> + +<p>Now that the template has been inserted, we can put in some code, and even some explanatory text.</p> + +<h3 id="HTML">HTML</h3> + +<p>This HTML creates a paragraph and some blocks to help us position and style a message.</p> + +<pre class="brush: html notranslate"><p>A simple example of the live sample system in action.</p> +<div class="box"> + <div id="item">Hello world!</div> +</div> +</pre> + +<h3 id="CSS">CSS</h3> + +<p>The CSS code styles the box as well as the text inside it.</p> + +<pre class="brush: css notranslate">.box { + width: 200px; + height: 100 px; + border-radius: 6px; + background-color: #ffaabb; +} + +#item { + width: 100%; + font-weight: bold; + text-align: center; + font-size: 2em; +} +</pre> + +<h3 id="JavaScript">JavaScript</h3> + +<p>This code is very simple. All it does is attach an event handler to the "Hello world!" text that makes an alert appear when it is clicked.</p> + +<pre class="brush: js notranslate">var el = document.getElementById('item'); +el.onclick = function() { + alert('Owww, stop poking me!'); +} +</pre> + +<h3 id="Resultado">Resultado</h3> + +<p>Here is the result of running the code blocks above via<code> \{{EmbedLiveSample('Live_sample_demo')}}</code>:</p> + +<p>{{EmbedLiveSample('Live_sample_demo')}}</p> + +<p>Here is a link that results from calling these code blocks via <code>\{{LiveSampleLink('Live_sample_demo', 'Live sample demo link')}}</code>:</p> + +<p>{{LiveSampleLink('Live_sample_demo', 'Live sample demo link')}}</p> + +<h2 id="Convenções_sobre_exemplos_live"><a id="conventions" name="conventions">Convenções sobre exemplos <em>live</em></a></h2> + +<div class="note"> +<p><strong>Nota:</strong> This is currently (Feb. 2016) under discussion on the dev-mdc mailing list (see <a href="https://groups.google.com/forum/#!topic/mozilla.dev.mdc/49oqJAHFnWQ">this thread</a>). Any input is welcome. If this note persists after some month (Apr. 2016), please reach the author of the first email in this thread for updating this page.</p> +</div> + +<dl> + <dt>Ordem dos blocos de código</dt> + <dd>When adding a live sample, the code blocks should be sorted so that the first one corresponds to the main language for this sample (if there is one). For example, when adding a live sample for the HTML Reference, the first block should be HTML, when adding a live sample for the CSS Reference, it should be CSS and so on.</dd> + <dt>Nomeação de cabeçalhos</dt> + <dd>When there is no ambiguity (e.g. the sample is under a "Examples" section), headings should be straightforward with the sole name of the corresponding language: HTML, CSS, JavaScript, SVG, etc. (see above). Headings like "HTML Content" or "JavaScript Content" should not be used. However if such a short heading makes content unclear, one can use a more thoughtful title.</dd> + <dt>Utilizar um bloco de "Resultado"</dt> + <dd>After the different code blocks, please use a last "Result" block before using the <code>EmbedLiveSample</code> macro (see above). This way, the semantic of the example is made clearer for both the reader and any tools that would parse the page (e.g. screen reader, web crawler).</dd> +</dl> diff --git a/files/pt-pt/mdn/structures/index.html b/files/pt-pt/mdn/structures/index.html new file mode 100644 index 0000000000..b8df701dac --- /dev/null +++ b/files/pt-pt/mdn/structures/index.html @@ -0,0 +1,16 @@ +--- +title: Document structures +slug: MDN/Structures +tags: + - Landing + - MDN Meta + - NeedsTranslation + - Structures + - TopicStub +translation_of: MDN/Structures +--- +<div>{{MDNSidebar}}</div><div>{{IncludeSubnav("/en-US/docs/MDN")}}</div> + +<p>Throughout MDN, there are various document structures that are used repeatedly, to provide consistent presentation of information in MDN articles. Here are articles describing these structures, so that, as an MDN author, you can recognize, apply, and modify them as appropriate for documents you write, edit, or translate.</p> + +<p>{{LandingPageListSubPages()}}</p> diff --git a/files/pt-pt/mdn/structures/macros/index.html b/files/pt-pt/mdn/structures/macros/index.html new file mode 100644 index 0000000000..984483ee1e --- /dev/null +++ b/files/pt-pt/mdn/structures/macros/index.html @@ -0,0 +1,46 @@ +--- +title: Macros +slug: MDN/Structures/Macros +tags: + - Estruturas + - Guía + - Kuma + - KumaScript + - Metadados MDN +translation_of: MDN/Structures/Macros +--- +<div>{{MDNSidebar}}</div><p><span class="seoSummary">A plataforma <a href="/en-US/docs/Project:MDN/Kuma" title="/en-US/docs/Project:MDN/Kuma">Kuma</a> </span> na qual a MDN é executada, fornece um sistema de macro poderoso, <span class="seoSummary"><a href="https://developer.mozilla.org/en-US/docs/MDN/Contribute/Tools/KumaScript" title="/en-US/docs/Project:MDN/Kuma/KumaScript_guide">KumaScript</a>,</span> que torna possível realizar uma grande variedade de coisas automaticamente. Este artigo fornece informação sobre como invocar as macros da MDN dentro dos artigos<span class="seoSummary">.</span></p> + +<p>O <a href="/en-US/docs/MDN/Contribute/Tools/KumaScript" title="/en-US/docs/Project:MDN/Kuma/KumaScript_guide">guia de KumaScript</a> fornece uma visão detalhada de como utilizar as macros na MDN, deste modo, esta secção é mais um breve resumo.</p> + +<h2 id="Como_as_macros_são_implementadas">Como as macros são implementadas</h2> + +<p>Macros on MDN are implemented using server-executed <a href="/en-US/docs/Web/JavaScript" title="/en-US/docs/Web/JavaScript">JavaScript</a> code, interpreted using <a href="https://nodejs.org/en/" title="https://nodejs.org/en/">Node.js</a>. On top of that we have a number of libraries we've implemented that provide wiki-oriented services and features to let macros interact with the wiki platform and its contents. If you're interested in learning more, see the <a href="/en-US/docs/MDN/Contribute/Tools/KumaScript" title="/en-US/docs/Project:MDN/Kuma/KumaScript_guide">KumaScript guide</a>.</p> + +<h2 id="Utilização_uma_macro_no_conteúdo">Utilização uma macro no conteúdo</h2> + +<p>To actually use a macro, you simply enclose the call to the macro in a pair of double-braces, with its parameters, if any, enclosed in parentheses; that is:</p> + +<pre class="notranslate">\{{macroname(parameter-list)}}</pre> + +<p>A few notes about macro calls:</p> + +<ul> + <li>Macro names are case-sensitive, but some attempt is made to correct for common capitalization errors; you may use all lowercase even if the macro name uses caps within it, and you may capitalize a macro whose name normally starts with a lower-case letter.</li> + <li>Parameters are separated by commas.</li> + <li>If there are no parameters, you may leave out the parentheses entirely; <code>\{{macroname()}}</code> and <code>\{{macroname}}</code> are identical.</li> + <li>Numeric parameters can be in quotes, or not. It's up to you (however, if you have a version number with multiple decimals in it, it needs to be in quotes).</li> + <li>If you get errors, review your code carefully. If you still can't figure out what's going on, see <a href="/en-US/docs/MDN/Kuma/Troubleshooting_KumaScript_errors">Troubleshooting KumaScript errors</a> for help.</li> +</ul> + +<p>Macros are heavily cached; for any set of input values (both parameters and environmental values such as the URL for which the macro was run), the results are stored and reused. This means that the macro is only actually run when the inputs change.</p> + +<div class="note"> +<p><strong>Nota:</strong> You can force all the macros on a page to be re-evaluated by force-refreshing the page in your browser (that is, a shift-reload).</p> +</div> + +<p>Macros can be as simple as just inserting a larger block of text or swapping in contents from another part of MDN, or as complex as building an entire index of content by searching through parts of the site, styling the output, and adding links.</p> + +<p>You can read up on our most commonly-used macros on the <a href="/en-US/docs/MDN/Contribute/Structures/Macros/Commonly-used_macros" title="/en-US/docs/Project:MDN/Contributing/Custom_macros">Commonly-used macros</a> page; also, there's a <a href="https://developer.mozilla.org/en-US/docs/templates" title="https://developer.mozilla.org/en-US/docs/templates">complete list of all macros</a> here. Most macros have documentation built into them, as comments at the top.</p> + +<p>{{EditorGuideQuicklinks}}</p> diff --git a/files/pt-pt/mdn/tools/edição_de_modelo/index.html b/files/pt-pt/mdn/tools/edição_de_modelo/index.html new file mode 100644 index 0000000000..aa1f90ba40 --- /dev/null +++ b/files/pt-pt/mdn/tools/edição_de_modelo/index.html @@ -0,0 +1,12 @@ +--- +title: Edição de modelo +slug: MDN/Tools/Edição_de_modelo +tags: + - Ferramentas + - Guía + - Metadados MDN +translation_of: MDN/Tools/Template_editing +--- +<div>{{MDNSidebar}}</div><p>Na MDN, os modelos esccritos em <a href="/pt-PT/docs/MDN/Contribute/Tools/KumaScript">KumaScript</a> são utilziados por uma geração de conteúdo automatizado e personalização dentro das páginas. Cada modelo é um ficheiro separado sob <a href="https://github.com/mozilla/kumascript/tree/master/macros">a diretoria de macros do repositório de KumaScript no GitHub</a>.</p> + +<p>Qualquer pessoa que edite páginas da wiki da MDN podem invocar modelos via <span class="seoSummary"> </span> <span class="seoSummary"> <a href="/pt-PT/docs/MDN/Contribute/Structures/Macros">macros</a> nos artigos da MDN.Qualquer pessoa pode criar e editar modelos via <a href="https://github.com/mozilla/kumascript">repositório de KumaScript no GitHub, </a>utilizando práticas de código aberto padrão (<em>fork</em> repositório, criar um ramo, efetuar alterações, e submeter um pedido de submissão para revisão). </span> Note que enviar um pedido de submissão é atualmente a única maneira para atualizar as <em>strings</em> traduzidas nos modelos que as contêm .</p> diff --git a/files/pt-pt/mdn/tools/index.html b/files/pt-pt/mdn/tools/index.html new file mode 100644 index 0000000000..9030b49d4d --- /dev/null +++ b/files/pt-pt/mdn/tools/index.html @@ -0,0 +1,17 @@ +--- +title: MDN tools +slug: MDN/Tools +tags: + - Landing + - MDN Meta + - NeedsTranslation + - TopicStub +translation_of: MDN/Tools +--- +<div>{{MDNSidebar}}</div> + +<div>{{IncludeSubnav("/en-US/docs/MDN")}}</div> + +<p>MDN offers a number of features that make it easier to track progress, manage content, and keep up with the latest changes to the site.</p> + +<p>{{LandingPageListSubpages}}</p> diff --git a/files/pt-pt/mdn/tools/kumascript/index.html b/files/pt-pt/mdn/tools/kumascript/index.html new file mode 100644 index 0000000000..e031036563 --- /dev/null +++ b/files/pt-pt/mdn/tools/kumascript/index.html @@ -0,0 +1,496 @@ +--- +title: KumaScript +slug: MDN/Tools/KumaScript +tags: + - Ferramentas + - Guía + - Kuma + - KumaScript + - Metadados MDN +translation_of: MDN/Tools/KumaScript +--- +<div>{{MDNSidebar}}</div><h2 id="Sinopse">Sinopse</h2> + +<p><span class="seoSummary">Na plataforma <a href="/pt-PT/docs/MDN/Kuma">Kuma</a> que gere a MDN, o sistema de modelo para os aspetos de automação de conteúdo na <em>wiki é chamado de </em><a class="link-https" href="https://github.com/mdn/kumascript" title="https://github.com/mdn/kumascript">KumaScript</a>. KumaScript é gerido por <em>server-side</em> JavaScript, implementado com a utilização de <a class="external" href="https://nodejs.org/en/" title="https://nodejs.org/en/">Node.js</a>.</span> Este artigo proporciona informação básica de como utilizar KumaScript.</p> + +<p>For a detailed overview and Q&A of KumaScript, watch the MDN dev team's <a href="https://vreplay.mozilla.com/replay/showRecordDetails.html?sortBy=date&viewCount=1&currentPage=1&groupBy=combo&roomFilter=&usernameFilter=&searchFilter=&usernameFullFilter=&myManager=-1&adminManager=0&webCast=0&command=&recId=1082&auxMessage=&auxMessage1=&lang=en&langChanged=&tenantFilter=&securityTab=">KumaScript Fireside Chat</a> (the meeting starts at 10 minutes into the video). KumaScript replaced DekiScript, which was the template language for MindTouch, the previous platform used by MDN.</p> + +<h3 id="O_que_é_KumaScript">O que é KumaScript?</h3> + +<ul> + <li>A way to reuse and localize content that appears repeatedly between documents (e.g., compatibility labels, section navigation, warning banners).</li> + <li>A way to build documents out of content pulled from other documents.</li> + <li>A way to fetch and include content from other web sites and services (e.g., Bugzilla).</li> +</ul> + +<h3 id="O_que_KumaScript_não_é">O que KumaScript não é</h3> + +<ul> + <li>KumaScript does not support interactive scripting of the kind that can accept form submissions.</li> + <li>KumaScript does not have access to a database, files, or any other way to store information persistently.</li> + <li>KumaScript does not support site personalization based on the user currently logged in.</li> + <li>KumaScript does not have access to user information, only to the content and metadata of a wiki page being viewed.</li> +</ul> + +<h2 id="Elementar">Elementar</h2> + +<p>KumaScript is used on MDN in <a class="link-https" href="https://github.com/visionmedia/ejs" title="https://github.com/visionmedia/ejs">embedded JavaScript templates</a>. These templates can be invoked in document content by any MDN author, through the use of macros.</p> + +<p>A script in KumaScript is a <em>template</em>, and each template is a file in <a href="https://github.com/mdn/kumascript/tree/master/macros">the macros directory of the KumaScript repository</a> on Github. A <a class="link-https" href="https://github.com/mdn/kumascript/blob/master/macros/hello.ejs" title="hello.ejs">template</a> looks like this:</p> + +<pre class="notranslate"><% for (var i = 0; i < $0; i++) { %> +Hello #<%= i %> +<% } %></pre> + +<p>Invoking a template is done with a <em>macro</em>, which can be used anywhere in any wiki content. A macro looks like this:</p> + +<pre class="notranslate">\{{ hello("3") }}</pre> + +<p>The output of the macro looks like this:</p> + +<pre class="notranslate">Hello #0 +Hello #1 +Hello #2</pre> + +<h3 id="Sintaxe_de_macro">Sintaxe de macro</h3> + +<p>KumaScript templates are invoked in document content with macros, like this:</p> + +<pre class="notranslate">\{{ templateName("arg0", "arg1", ..., "argN") }} +</pre> + +<p>Macro syntax consists of these rules:</p> + +<ul> + <li>Macros start and end with <code>\{{</code> and <code>\}}</code> characters.</li> + <li>The first part of the macro is the name of a template. The lowercase value of this name should match the lowercase value of one of the filenames under <a href="https://github.com/mdn/kumascript/tree/master/macros">the macros directory of KumaScript</a>.</li> + <li>A template can accept parameters, and this parameter list starts and ends with parentheses.</li> + <li>All non-numeric parameters must be in quotes. Numbers can be left unquoted.</li> +</ul> + +<h4 id="Utilizar_JSON_como_um_parâmetro_de_macro">Utilizar JSON como um parâmetro de macro</h4> + +<p>As a semi-experimental feature (not guaranteed to work), you can supply a JSON object for the first and only parameter, like so:</p> + +<pre class="notranslate">\{{ templateName({ "Alpha":"one", "Beta":["a","b","c"], "Foo":"http:\/\/mozilla.org\/" }) }} +</pre> + +<p>The data from this macro is available in template code as an object in the <code>$0</code> argument (e.g., <code>$0.Alpha</code>, <code>$0.Beta</code>, <code>$0.Foo</code>). This also allows you to express complex data structures in macro parameters that are hard or impossible to do with a simple list of parameters.</p> + +<p>Note that this parameter style is very picky — it must adhere to <a href="http://json.org/" title="http://json.org/">JSON syntax</a> exactly, which has some requirements about escaping characters that are easy to miss (e.g., all forward slashes are escaped). When in doubt, <a href="http://jsonlint.com/" title="http://jsonlint.com/">try running your JSON through a validator</a>.</p> + +<h4 id="Como_escrever_no_texto">Como escrever "\{{" no texto</h4> + +<p>Since the character sequence "<code>\{{</code>" is used to indicate the start of a macro, this can be troublesome if you actually just want to use "<code>\{{</code>" and "<code>}}</code>" in a page. It will probably produce <code>DocumentParsingError</code> messages.</p> + +<p>In this case, you can escape the first brace with a backslash, like so: <code>\\{</code></p> + +<h3 id="Sintaxe_de_modelo">Sintaxe de modelo</h3> + +<p>Each KumaScript template is a file under <a href="https://github.com/mdn/kumascript/tree/master/macros">the macros directory of KumaScript</a>. You create and edit these files as you would the files of any open-source project on GitHub (see <a href="https://github.com/mdn/kumascript">the KumaScript README</a> for more information).</p> + +<p>KumaScript templates are processed by an <a class="link-https" href="https://github.com/visionmedia/ejs" title="https://github.com/visionmedia/ejs">embedded JavaScript template engine</a> with a few simple rules:</p> + +<ul> + <li>Within a template, the parameters passed in from the macro are available as the variables <code>$0</code>, <code>$1</code>, <code>$2</code>, and so on. The entire list of parameters is also available in a template as the variable <code>arguments</code>.</li> + <li>Most text is treated as output and included in the output stream.</li> + <li>JavaScript variables and expressions can be inserted into the output stream with these blocks: + <ul> + <li><code><%= expr %></code> — the value of a JavaScript expression is escaped for HTML before being included in output (e.g., characters like <code><</code> and <code>></code> are turned into <code>&lt;</code> and <code>&gt;</code>).</li> + <li><code><%- expr %></code> — the value of a JavaScript expression is included in output without any escaping. (Use this if you want to dynamically build markup or use the results of another template that may include markup.)</li> + <li>It is an error to include semicolons inside these blocks.</li> + </ul> + </li> + <li>Anything inside a <code><% %></code> block is interpreted as JavaScript. This can include loops, conditionals, etc.</li> + <li>Nothing inside a <code><% %></code> block can ever contribute to the output stream. But, you can transition from JS mode to output mode using <code><% %></code>—for example: + <pre class="notranslate"><% for (var i = 0; i < $0; i++) { %> +Hello #<%= i %> +<% } %> +</pre> + + <p>Note how the JavaScript code is contained in <code><% ... %></code>, and output happens in the space between <code>%> ... <%</code>. The <code>for</code> loop in JS can begin with one <code><% %></code> block, transition to output mode, and finish up in a second <code><% %></code> JS block.</p> + </li> + <li>For more details on EJS syntax, <a class="link-https" href="https://github.com/visionmedia/ejs" title="https://github.com/visionmedia/ejs">check out the upstream module documentation</a>.</li> +</ul> + +<h3 id="Dicas">Dicas</h3> + +<p>You can see a list of macros and how they are used on MDN on the <a href="/en-US/dashboards/macros">macros dashboard</a>.</p> + +<h2 id="Funcionalidades_Avançadas">Funcionalidades Avançadas</h2> + +<p>Beyond the basics, the KumaScript system offers some advanced features.</p> + +<h3 id="Variáveis_de_ambiente">Variáveis de ambiente</h3> + +<p>When the wiki makes a call to the KumaScript service, it passes along some context on the current document that KumaScript makes available to templates as variables:</p> + +<dl> + <dt><code>env.path</code></dt> + <dd>The path to the current wiki document</dd> + <dt><code>env.url</code></dt> + <dd>The full URL to the current wiki document</dd> + <dt><code>env.id</code></dt> + <dd>A short, unique ID for the current wiki document</dd> + <dt><code>env.files</code></dt> + <dd>An array of the files attached to the current wiki document; each object in the array is as described under {{ anch("File objects") }} below</dd> + <dt><code>env.review_tags</code></dt> + <dd>An array of the review tags on the article ("technical", "editorial", etc.)</dd> + <dt><code>env.locale</code></dt> + <dd>The locale of the current wiki document</dd> + <dt><code>env.title</code></dt> + <dd>The title of the current wiki document</dd> + <dt><code>env.slug</code></dt> + <dd>The URL slug of the current wiki document</dd> + <dt><code>env.tags</code></dt> + <dd>An array list of tag names for the current wiki document</dd> + <dt><code>env.modified</code></dt> + <dd>Last modified timestamp for the current wiki document</dd> + <dt><code>env.cache_control</code></dt> + <dd><code>Cache-Control</code> header sent in the request for the current wiki document, useful in deciding whether to invalidate caches</dd> +</dl> + +<h4 id="File_objects">File objects</h4> + +<p>Each file object has the following fields:</p> + +<dl> + <dt><code>title</code></dt> + <dd>The attachment's title</dd> + <dt><code>description</code></dt> + <dd>A textual description of the current revision of the file</dd> + <dt><code>filename</code></dt> + <dd>The file's name</dd> + <dt><code>size</code></dt> + <dd>The size of the file in bytes</dd> + <dt><code>author</code></dt> + <dd>The username of the person who uploaded the file</dd> + <dt><code>mime</code></dt> + <dd>The MIME type of the file</dd> + <dt><code>url</code></dt> + <dd>The URL at which the file can be found</dd> +</dl> + +<h4 id="Trabalhar_com_listas_de_etiqueta">Trabalhar com listas de etiqueta</h4> + +<p>The <code>env.tags</code> and <code>env.review_tags</code> variables return arrays of tags. You can work with these in many ways, of course, but here are a couple of suggestions.</p> + +<h5 id="Looking_to_see_if_a_specific_tag_is_set">Looking to see if a specific tag is set</h5> + +<p>You can look to see if a specific tag exists on a page like this:</p> + +<pre class="brush: js notranslate">if (env.tags.indexOf("tag") != −1) { + // The page has the tag "tag" +} +</pre> + +<h5 id="Iterating_over_all_the_tags_on_a_page">Iterating over all the tags on a page</h5> + +<p>You can also iterate over all the tags on a page, like this:</p> + +<pre class="brush: js notranslate">env.tag.forEach(function(tag) { + // do whatever you need to do, such as: + if (tag.indexOf("a") == 0) { + // this tag starts with "a" - woohoo! + } +});</pre> + +<h3 id="APIs_e_Módulos"><em>APIs </em>e Módulos</h3> + +<p>KumaScript offers some built-in methods and APIs for KumaScript macros. Macros can also use <code>module.exports</code> to export new API methods.</p> + +<p>API changes require updating the KumaScript engine or macros via a pull request to the <a href="https://github.com/mdn/kumascript">KumaScript repository</a>.</p> + +<h4 id="Métodos_integrados">Métodos integrados</h4> + +<p>This manually-maintained documentation is likely to fall out of date with the code. With that in mind, <a class="link-https" href="https://github.com/mdn/kumascript/blob/master/lib/kumascript/api.js#L175" title="https://github.com/mdn/kumascript/blob/master/lib/kumascript/api.js#L208">you can always check out the latest state of built-in APIs in the KumaScript source</a>. But here is a selection of useful methods exposed to templates:</p> + +<dl> + <dt><code>md5(string)</code></dt> + <dd>Returns an MD5 hex digest of the given string.</dd> + <dt><code>template("name", ["arg0", "arg1", ..., "argN"])</code></dt> + <dd>Executes and returns the result of the named template with the given list of parameters.</dd> + <dd>Example: <code><%- template("warning", ["foo", "bar", "baz"]) %></code>.</dd> + <dd>Example using the <code>domxref</code> macro: <code><%- template("domxref", ["Event.bubbles", "bubbles"]) %></code>.</dd> + <dd>This is a JavaScript function. So, if one of the parameters is an arg variable like $2, do not put it in quotes. Like this: <code><%- template("warning", [$1, $2, "baz"]) %></code>. If you need to call another template from within a block of code, do not use <code><%</code> ... <code>%></code>. Example: <code>myvar = "<li>" + template("LXRSearch", ["ident", "i", $1]) + "</li>";</code></dd> + <dt><code>require(name)</code></dt> + <dd>Loads another template as a module; any output is ignored. Anything assigned to <code>module.exports</code> in the template is returned.</dd> + <dd>Used in templates like so: <code><% var my_module = require('MyModule'); %></code>.</dd> + <dt><code>cacheFn(key, timeout, function_to_cache)</code></dt> + <dd>Using the given key and cache entry lifetime, cache the results of the given function. Honors the value of <code>env.cache_control</code> to invalidate cache on <code>no-cache</code>, which can be sent by a logged-in user hitting shift-refresh.</dd> + <dt><code>request</code></dt> + <dd>Access to <a class="link-https" href="https://github.com/mikeal/request" title="https://github.com/mikeal/request"><code>mikeal/request</code></a>, a library for making HTTP requests. Using this module in KumaScript templates is not yet very friendly, so you may want to wrap usage in module APIs that simplify things.</dd> + <dt><code>log.debug(string)</code></dt> + <dd>Outputs a debug message into the script log on the page (i.e. the big red box that usually displays errors).</dd> +</dl> + +<h4 id="Módulos_de_API_integrados">Módulos de <em>API </em>integrados</h4> + +<p>There's only one API built in at the moment, in the <code>kuma</code> namespace. You can see the most up to date list of methods under <code>kuma</code> from <a href="https://github.com/mdn/kumascript/blob/master/lib/kumascript/api.js#L74">the KumaScript source code</a>, but here are a few:</p> + +<dl> + <dt><code>kuma.inspect(object)</code></dt> + <dd>Renders any JS object as a string, handy for use with <code>log.debug()</code>. See also: <a href="http://nodejs.org/api/util.html#util_util_inspect_object_options">node.js <code>util.inspect()</code></a>.</dd> +</dl> + +<dl> + <dt><code>kuma.htmlEscape(string)</code></dt> + <dd>Escapes the characters <code>&, <, >, "</code> to <code>&amp, &lt;, &gt;, &quot;</code>, respectively.</dd> + <dt><code>kuma.url</code></dt> + <dd>See also: <a href="http://nodejs.org/api/url.html">node.js <code>url</code> module</a>.</dd> + <dt><code>kuma.fetchFeed(url)</code></dt> + <dd>Fetch an RSS feed and parse it into a JS object. See also: <a href="https://github.com/mdn/kumascript/blob/master/macros/InsertFeedLinkList.ejs"><code>InsertFeedLinkList</code></a></dd> +</dl> + +<h4 id="Criar_módulos">Criar módulos</h4> + +<p>Using the built-in <code>require()</code> method, you can load a template as a module to share common variables and methods between templates. A module can be defined in a template like this:</p> + +<pre class="notranslate"><% +module.exports = { + add: function (a, b) { + return a + b; + } +} +%> +</pre> + +<p>Assuming this template is saved under <a href="https://github.com/mdn/kumascript/tree/master/macros">https://github.com/mdn/kumascript/tree/master/macros</a> as <code>MathLib.ejs</code>, you can use it in another template like so:</p> + +<pre class="notranslate"><% +var math_lib = require("MathLib"); +%> +The result of 2 + 2 = <%= math_lib.add(2, 2) %> +</pre> + +<p>And, the output of this template will be:</p> + +<pre class="notranslate">The result of 2 + 2 = 4 +</pre> + +<h4 id="Módulos_carregados_automaticamente">Módulos carregados automaticamente</h4> + +<p>There are a set of modules editable as wiki templates that are automatically loaded and made available to every template. This set is defined in the configuration file for the KumaScript service - any changes to this requires an IT bug to edit configuration and a restart of the service.</p> + +<p>For the most part, these attempt to provide stand-ins for legacy DekiScript features to ease template migration. But, going forward, these can be used to share common variables and methods between templates:</p> + +<ul> + <li><code>mdn.*</code> - <a class="link-https" href="https://github.com/mdn/kumascript/blob/master/macros/MDN-Common.ejs" title="MDN:Common">MDN-Common</a></li> + <li><code>Page.*</code> - <a class="link-https" href="https://github.com/mdn/kumascript/blob/master/macros/DekiScript-Page.ejs" title="DekiScript:Page">DekiScript-Page</a></li> + <li><code>String.*</code> - <a class="link-https" href="https://github.com/mdn/kumascript/blob/master/macros/DekiScript-String.ejs" title="DekiScript:String">DekiScript-String</a></li> + <li><code>Uri.*</code> - <a class="link-https" href="https://github.com/mdn/kumascript/blob/master/macros/DekiScript-Uri.ejs" title="DekiScript:Uri">DekiScript-Uri</a></li> + <li><code>Web.*</code> - <a class="link-https" href="https://github.com/mdn/kumascript/blob/master/macros/DekiScript-Web.ejs" title="DekiScript:Web">DekiScript-Web</a></li> + <li><code>Wiki.*</code> - <a class="link-https" href="https://github.com/mdn/kumascript/blob/master/macros/DekiScript-Wiki.ejs" title="DekiScript:Wiki">DekiScript-Wiki</a></li> +</ul> + +<p><strong>Note:</strong> You might notice that the DekiScript modules use a built-in method named <code>buildAPI()</code>, like so:</p> + +<pre class="notranslate"><% module.exports = buildAPI({ + StartsWith: function (str, sub_str) { + return (''+str).indexOf(sub_str) === 0; + } +}); %> +</pre> + +<p>The reason for this is because DekiScript is case-insensitive when it comes to references to API methods, whereas JavaScript is strict about uppercase and lowercase in references. So, <code>buildAPI()</code> is a hack to try to cover common case variations in DekiScript calls found in legacy templates.</p> + +<div class="note"> +<p>Com isso em mente, por favor, não utilize <code>buildAPI()</code> nos novos módulos.</p> +</div> + +<h2 id="Dicas_e_avisos">Dicas e avisos</h2> + +<h3 id="Depuração">Depuração</h3> + +<p>A useful tip when debugging. You can use the <code>log.debug()</code> method to output text to the scripting messages area at the top of the page that's running your template. Note that you need to be really sure to remove these when you're done debugging, as they're visible to all users! To use it, just do something like this:</p> + +<pre class="notranslate"><%- log.debug("Some text goes here"); %> +</pre> + +<p>You can, of course, create more complex output using script code if it's helpful.</p> + +<h3 id="Colocação_em_cache">Colocação em cache</h3> + +<p>KumaScript templates are heavily cached to improve performance. For the most part, this works great to serve up content that doesn't change very often. But, as a logged-in user, you have two options to force a page to be regenerated, in case you notice issues with scripting:</p> + +<ul> + <li>Hit Refresh in your browser. This causes KumaScript to invalidate its cache for the content on the current page by issuing a request with a <code>Cache-Control: max-age=0</code> header.</li> + <li>Hit Shift-Refresh in your browser. This causes KumaScript to invalidate cache for the current page, as well as for any templates or content used by the current page by issuing a request with a <code>Cache-Control: no-cache</code> header.</li> +</ul> + +<h3 id="Utilizar_palavras-chave_na_pesquisa_para_abrir_páginas_modelo">Utilizar palavras-chave na pesquisa para abrir páginas modelo</h3> + +<p>When using templates, it's common to open the template's code in a browser window to review the comments at the top, which are used to document the template, its parameters, and how to use it properly. To quickly access templates, you can create a Firefox <a href="http://kb.mozillazine.org/Using_keyword_searches">search keyword</a>, which gives you a shortcut you can type in the URL box to get to a template more easily.</p> + +<p>To create a search keyword, open the bookmarks window by choosing "Show all bookmarks" in the Bookmarks menu, or by pressing <kbd>Control</kbd>-<kbd>Shift</kbd>-<kbd>B</kbd> (<kbd>Command</kbd>-<kbd>Shift</kbd>-<kbd>B</kbd> on Mac). Then from the utility ("Gear") menu in the Library window that appears, choose "New Bookmark...".</p> + +<p>This causes the bookmark editing dialog to appear. Fill that out as follows:</p> + +<dl> + <dt>Name</dt> + <dd>A suitable name for your search keyword; "Open MDN Template" is a good one.</dd> + <dt>Location</dt> + <dd><kbd>https://github.com/mdn/kumascript/blob/master/macros/%s</kbd></dd> + <dt>Tags {{optional_inline}}</dt> + <dd>A list of tags used to organize your bookmarks; these are entirely optional and what (if any) tags you use is up to you.</dd> + <dt>Keyword</dt> + <dd>The shortcut text you wish to use to access the template. Ideally, this should be something short and quick to type, such as simply "t" or "mdnt".</dd> + <dt>Description {{optional_inline}}</dt> + <dd>A suitable description explaining what the search keyword does.</dd> +</dl> + +<p>The resulting dialog looks something like this:</p> + +<p><img alt="" src="https://mdn.mozillademos.org/files/14432/Screen%20Shot%202016-11-28%20at%203.08.39%20PM.png" style="height: 289px; width: 500px;"></p> + +<p>Then click the "Add" button to save your new search keyword. From then on, typing your keyword, then a space, then the name of a macro will open that macro in your current tab. So if you used "t" as the keyword, typing <kbd>t ListSubpages</kbd> will show you the page at {{TemplateLink("ListSubpages")}}.</p> + +<h2 id="Cookbook"><em>Cookbook</em></h2> + +<p>This section will list examples of common patterns for templates used on MDN, including samples of legacy DekiScript templates and their new KumaScript equivalents.</p> + +<h3 id="Force_templates_used_on_a_page_to_be_reloaded">Force templates used on a page to be reloaded</h3> + +<p>It bears repeating: To force templates used on a page to be reloaded after editing, hit Shift-Reload. Just using Reload by itself will cause the page contents to be regenerated, but using cached templates and included content. A Shift-Reload is necessary to invalidate caches beyond just the content of the page itself.</p> + +<h3 id="Recovering_from_Unknown_Error">Recovering from "Unknown Error"</h3> + +<p>Sometimes, you'll see a scripting message like this when you load a page:</p> + +<pre class="notranslate">Kumascript service failed unexpectedly: <class 'httplib.BadStatusLine'></pre> + +<p>This is probably a temporary failure of the KumaScript service. If you Refresh the page, the error may disappear. If that doesn't work, try a Shift-Refresh. If, after a few tries, the error persists - <a class="link-https" href="https://bugzilla.mozilla.org/enter_bug.cgi?product=mozilla.org&format=itrequest">file an IT bug</a> for Mozilla Developer Network to ask for an investigation.</p> + +<h3 id="Broken_wiki.languages_macros">Broken wiki.languages() macros</h3> + +<p>On some pages, you'll see a scripting error like this:</p> + +<pre class="notranslate">Syntax error at line 436, column 461: Expected valid JSON object as the parameter of the preceding macro but... +</pre> + +<p>If you edit the page, you'll probably see a macro like this at the bottom of the page:</p> + +<pre class="notranslate">\{{ wiki.languages({ "zh-tw": "zh_tw/Core_JavaScript_1.5_教學/JavaScript_概要", ... }) }} +</pre> + +<p>To fix the problem, just delete the macro. Or, replace the curly braces on either side with HTML comments <code><!-- --></code> to preserve the information, like so:</p> + +<pre class="notranslate"><!-- wiki.languages({ "zh-tw": "zh_tw/Core_JavaScript_1.5_教學/JavaScript_概要", ... }) --> +</pre> + +<p>Because Kuma supports localization differently, these macros aren't actually needed any more. But, they've been left intact in case we need to revisit the relationships between localized pages. Unfortunately, it seems like migration has failed to convert some of them properly.</p> + +<h3 id="Finding_the_Current_Pages_Language">Finding the Current Page's Language</h3> + +<p>In KumaScript, the locale of the current document is exposed as an environment variable:</p> + +<pre class="notranslate">var lang = env.locale; +</pre> + +<p>The <code>env.locale</code> variable should be reliable and defined for every document.</p> + +<h3 id="Reading_the_contents_of_a_page_attachment">Reading the contents of a page attachment</h3> + +<p>You can read the contents of an attached file by using the <code>mdn.getFileContent()</code> function, like this:</p> + +<pre class="notranslate"><% + var contents = mdn.getFileContent(fileUrl); + ... do stuff with the contents ... +%> +</pre> + +<p>or</p> + +<pre class="notranslate"><%-mdn.getFileContent(fileObject)%> +</pre> + +<p>In other words, you may specify either the URL of the file to read or as a file object. The file objects for a page can be accessed through the array <code>env.files</code>. So, for example, to embed the contents of the first file attached to the article, you can do this:</p> + +<pre class="notranslate"><%-mdn.getFileContent(env.files[0])%> +</pre> + +<div class="note"><strong>Nota: </strong>provavelmente não quer tentar incorporar o conteúdo de um ficheiro não texto desta forma, já que o conteúdo bruto seria injetado como texto. Isto serve para permitir que aceda aos conteúdos dos anexos de texto.</div> + +<p>If the file isn't found, an empty string is returned. There is currently no way to tell the difference between an empty file and a nonexistent one. But if you're putting empty files on the wiki, you're doing it wrong.</p> + +<h3 id="Localizar_conteúdo_de_modelo">Localizar conteúdo de modelo</h3> + +<p>Templates are not translated like wiki pages, rather any single template might be used for any number of locales.</p> + +<p>So the main way to output content tailored to the current document locale is to pivot on the value of <code>env.locale</code>. There are many ways to do this, but a few patterns are common in the conversion of legacy DekiScript templates:</p> + +<h4 id="Ifelse_blocks_in_KumaScript">If/else blocks in KumaScript</h4> + +<p>The KumaScript equivalent of this can be achieved with simple if/else blocks, like so:</p> + +<pre class="notranslate"><% if ("fr" == env.locale) { %> +<%- template("CSSRef") %> « <a title="Référence_CSS/Extensions_Mozilla" href="/fr/docs/Référence_CSS/Extensions_Mozilla">Référence CSS:Extensions Mozilla</a> +<% } else if ("ja" == env.locale) { %> +<%- template("CSSRef") %> « <a title="CSS_Reference/Mozilla_Extensions" href="/ja/docs/CSS_Reference/Mozilla_Extensions">CSS リファレンス:Mozilla 拡張仕様</a> +<% } else if ("pl" == env.locale) { %> +<%- template("CSSRef") %> « <a title="Dokumentacja_CSS/Rozszerzenia_Mozilli" href="/pl/docs/Dokumentacja_CSS/Rozszerzenia_Mozilli">Dokumentacja CSS:Rozszerzenia Mozilli</a> +<% } else if ("de" == env.locale) { %> +<%- template("CSSRef") %> « <a title="CSS_Referenz/Mozilla_CSS_Erweiterungen" href="/de/docs/CSS_Referenz/Mozilla_CSS_Erweiterungen">CSS Referenz: Mozilla Erweiterungen</a> +<% } else { %> +<%- template("CSSRef") %> « <a title="CSS_Reference/Mozilla_Extensions" href="/en-US/docs/CSS_Reference/Mozilla_Extensions">CSS Reference:Mozilla Extensions</a> +<% } %> +</pre> + +<p>Depending on what text editor is your favorite, you may be able to copy & paste from the browser-based editor and attack this pattern with a series of search/replace regexes to get you most of the way there.</p> + +<p>My favorite editor is MacVim, and a series of regexes like this does the bulk of the work with just a little manual clean up following:</p> + +<pre class="notranslate">%s#<span#^M<span#g +%s#<span lang="\(.*\)" .*>#<% } else if ("\1" == env.locale) { %>#g +%s#<span class="script">template.Cssxref(#<%- template("Cssxref", [# +%s#)</span> </span>#]) %> +</pre> + +<p>Your mileage may vary, and patterns change slightly from template to template. That's why the migration script was unable to just handle this automatically, after all.</p> + +<h4 id="String_variables_and_switch">String variables and switch</h4> + +<p>Rather than switch between full chunks of markup, you can define a set of strings, switch them based on locale, and then use them to fill in placeholders in a single chunk of markup:</p> + +<pre class="notranslate"><% +var s_title = 'Firefox for Developers'; +switch (env.locale) { + case 'de': + s_title = "Firefox für Entwickler"; + break; + case 'fr': + s_title = "Firefox pour les développeurs"; + break; + case 'es': + s_title = "Firefox para desarrolladores"; + break; +}; +%> +<span class="title"><%= s_title %></span> +</pre> + +<h4 id="Utilizar_mdn.localString">Utilizar <code>mdn.localString()</code></h4> + +<p>A recent addition to the <code>MDN:Common</code> module is <code>mdn.localString()</code>, used like this:</p> + +<pre class="notranslate"><% +var s_title = mdn.localString({ + "en-US": "Firefox for Developers", + "de": "Firefox für Entwickler", + "es": "Firefox para desarrolladores" +}); +%> +<span class="title"><%= s_title %></span> +</pre> + +<p>This is more concise than the switch statement, and may be a better choice where a single string is concerned. However, if many strings need to be translated (e.g., as in <a class="link-https" href="https://github.com/mdn/kumascript/blob/master/macros/CSSRef.ejs" title="CSSRef">CSSRef</a>), a switch statement might help keep all the strings grouped by locale and more easily translated that way.</p> + +<p>When the object does not have the appropriate locale, the value of "en-US" is used as the initial value.</p> + +<h2 id="Consulte_também">Consulte também</h2> + +<ul> + <li><a href="http://kuma.readthedocs.io/en/latest/" title="Getting started with Kuma">Começar com Kuma</a></li> + <li><a href="https://github.com/mdn/kumascript" title="Project:en/KumaScript reference">Referência de KumaScript</a></li> + <li><a class="link-https" href="https://wiki.mozilla.org/MDN/Kuma" title="https://wiki.mozilla.org/MDN/Kuma">Wiki de Kuma</a></li> +</ul> diff --git a/files/pt-pt/mdn/tools/vigiar_pagina/index.html b/files/pt-pt/mdn/tools/vigiar_pagina/index.html new file mode 100644 index 0000000000..b7f9de52b0 --- /dev/null +++ b/files/pt-pt/mdn/tools/vigiar_pagina/index.html @@ -0,0 +1,49 @@ +--- +title: Subscrição de página +slug: MDN/Tools/Vigiar_pagina +tags: + - Ferramentas + - Guia(2) + - Metadados MDN + - Nível de Página +translation_of: MDN/Tools/Page_watching +--- +<div>{{MDNSidebar}}</div> + +<p><span class="seoSummary">A great way to stay involved with content on MDN that you care about is to subscribe to pages, so that you're notified via email when the pages get changed.</span> Every page on MDN offers a button offering options to monitor the page (and optionally its subpages) for changes. To access these options, hover over the Watch button to disclose the Watch menu, which looks like this:</p> + +<p><img alt="Screenshot of MDN's Watch menu" src="https://mdn.mozillademos.org/files/12551/MDN_-_Watch_Menu.png" style="height: 298px; width: 463px;"></p> + +<p>Then choose the option specifying whether to watch only that one page or that page and its sub-pages, as described in the following sections.</p> + +<h2 id="Subscrever_uma_página">Subscrever uma página</h2> + +<p>To subscribe to a single page, simply hover the mouse cursor over the Watch menu to display the Watch menu as described above, then select the first option, "Subscribe to <em>Page Title</em>". Once you've done this, each time a user makes a change to that one page, you'll get email describing the change.</p> + +<h2 id="Vigiar_várias_páginas">Vigiar várias páginas</h2> + +<p>Choosing the second option in the Watch menu, "Subscribe to <em>Page Title</em> and all its sub-articles", will register you to receive email for each change made to that page as well as all of its sub-pages. This includes sub-pages added after you requested the subscription, so if more sub-pages are created in the future, you'll get notifications for those as well.</p> + +<h2 id="Cancelar_a_subscriçção_de_uma_página">Cancelar a subscriçção de uma página</h2> + +<p>If you eventually need to unsubscribe from, or stop watching, a page, open the Watch menu again, and see that the "Subscribe" link has changed to "Unsubscribe." Click that, and you're unsubscribed!</p> + +<h2 id="Mensagens_de_alteração_de_página">Mensagens de alteração de página</h2> + +<p>Each time a change is saved to the page, you'll get an email. These emails come from notifications@developer.mozilla.org and are sent to the email address you used when registering your MDN account. Each message has a title of the form:</p> + +<pre class="notranslate">[MDN] Page "<em>Page title</em>" changed by <em>username</em></pre> + +<p>The message starts with a repeat of the information in the title, then presents a standard diff of the content, showing exactly what changed. The changes are shown as HTML source code, which can be a little weird to read if you're not used to it in the context of MDN.</p> + +<p>After the diff itself comes a list of useful links that you can use to act on the change in some way, including:</p> + +<ul> + <li>View the MDN profile of the user that made the change</li> + <li>Compare the previous and new versions of the page using MDN's on-site history feature</li> + <li>View the article itself in your browser</li> + <li>Edit the article</li> + <li>See the article's history</li> +</ul> + +<p>At the end of the email you see text telling you what subscription generated the email, such as "You are subscribed to edits on: HTML element reference and all its sub-articles", as well as a link you can click to unsubscribe from the messages for this watch request.</p> diff --git a/files/pt-pt/mdn/troubleshooting/index.html b/files/pt-pt/mdn/troubleshooting/index.html new file mode 100644 index 0000000000..4282a39570 --- /dev/null +++ b/files/pt-pt/mdn/troubleshooting/index.html @@ -0,0 +1,71 @@ +--- +title: Resolução de Problemas +slug: MDN/Troubleshooting +tags: + - resolução de problemas +translation_of: MDN/Troubleshooting +--- +<div>{{MDNSidebar}}</div><p>Este artigo descreve problemas comuns que podem ocorrer durante a utilização da MDN, e como os resolver.</p> + +<h2 id="Não_consegue_guardar_uma_página">Não consegue guardar uma página</h2> + +<dl> + <dt>Sintoma</dt> + <dd>You try to save some change that you have made, and you get an error message indicating that your change couldn't be saved.</dd> + <dt>Causa</dt> + <dd>Your change has been caught in MDN's spam trap.</dd> + <dt>Solução</dt> + <dd>Save a copy of your revision, and send an email to the <a href="mailto://mdn-admins@mozilla.org">MDN site administrators</a>, as instructed in the error message. One of the admins will verify that it is, in fact, a legitimate change, then train the spam filter not to block edits like yours, and add you to a whitelist so that you don't encounter this problem in the future.</dd> +</dl> + +<h2 id="As_suas_alterações_não_aparecem_na_página">As suas alterações não aparecem na página</h2> + +<dl> + <dt>Sintoma</dt> + <dd>You make some changes to an article and click <strong>Publish</strong>; the changes that you just made are not reflected in the normal view of the page.</dd> + <dt>Causa</dt> + <dd>The page content is cached on the server, and has not been refreshed since the page was changed.</dd> + <dt>Solução</dt> + <dd>Force a refresh of the page in your browser (for example, Shift+Reload). You might see the updated content, or you might see a message indicating that an update to the page is being processed. In the second case, wait a few minutes and refresh the page again.</dd> +</dl> + +<h2 id="Macro-generated_content_is_out_of_date">Macro-generated content is out of date</h2> + +<dl> + <dt>Sintoma</dt> + <dd>You see a page that contains content generated by a macro. You know that this macro has been updated and put into production, but the page is showing outdated values.</dd> + <dt>Causa</dt> + <dd>The macro output is cached, and has not been refreshed since the macro was updated.</dd> + <dt>Solução</dt> + <dd>Force a refresh of the page in your browser (for example, Shift+Reload). You might see the updated output, or you might see a message indicating that an update to the page is being processed. In the second case, wait a few minutes and refresh the page again.</dd> +</dl> + +<h2 id="Erro_de_scripting_numa_página">Erro de <em>scripting</em> numa página</h2> + +<dl> + <dt>Sintoma</dt> + <dd>You see a scary red box like this on a page:<br> + <img alt="There was a scripting error on this page. While it is being addressed by site editors, you can view partial content below. More information about this error" src="https://mdn.mozillademos.org/files/15259/macro_error_box.png" style="height: 114px; width: 590px;"></dd> + <dt>Causa</dt> + <dd>This is caused by a Kumascript error in a macro on the page. This issue is less common in production now that macros are stored on Github and go through a review and testing process before being put into production. You might see it if you modify a macro call or its arguments in a way that breaks the macros. You might also see it if you are editing macros on a local build of the MDN platform.</dd> + <dt>Solução</dt> + <dd>If you modified a macro call, you can check the name and parameters of the macro against the <a href="https://github.com/mdn/kumascript/tree/master/macros">Kumascript Github repo</a>. If you are in the midst of modifying the macro in question, <a href="/en-US/docs/MDN/Contribute/Tools/KumaScript/Troubleshooting">Troubleshooting Kumascript errors</a> may be helpful.</dd> +</dl> + +<h2 id="Scripting_error_while_previewing_a_page">Scripting error while previewing a page</h2> + +<dl> + <dt>Sintoma</dt> + <dd>You are editing a page, and click the <strong>Preview</strong> button. The preview of the page contains a scripting error message (as shown in the previous section).</dd> + <dt>Causa</dt> + <dd>Either there was an existing scripting error in the page you were editing, or you have introduced an error, possibly by changing arguments to a macro.</dd> + <dt>Solução</dt> + <dd> + <p>Be assured that as long as you have not modified or added any macros or templates in the page, you can safely ignore this error; you can expect it to go away when the edited page is finally saved and viewed normally again (unless the error was already there in the normal view).</p> + + <p>If you are still unsure whether <em>you</em> introduced the error, then you can open a <em>copy</em> of the normal page in a new window, enter Edit mode, and immediately click <strong>Preview</strong>. If any errors occur now, you can be confident that you did not cause them, and that they will likely disappear as previously described. As for your changes, if these new errors are the same as the old errors from the old window, then close the new window and continue working in the old one. However, if they are different errors, then you indeed might have damaged something in the old window, so just start carefully copying your changes to the new window, and click <strong>Preview</strong> after each copy. If the old errors suddenly appear here too, then your last changes have likely caused them, and you should carefully examine that work. Finally, as a side benefit, if you click <strong>Preview</strong> frequently and always leave that Preview window open, you will have a quick but unsaved copy of most of your changes in case the editor fails or somehow loses your work (as may happen when trying to use Discard.)</p> + + <p> </p> + </dd> + <dt> </dt> +</dl> |