Differences between revisions 3 and 4
Revision 3 as of 2018-05-25 18:47:02
Size: 19832
Editor: RuiBranco
Comment: Updated pt translation
Revision 4 as of 2018-05-29 20:43:44
Size: 20028
Editor: RuiBranco
Comment: Updated pt translation
Deletions are marked like this. Additions are marked like this.
Line 70: Line 70:
 * execute {{{git clone git@salsa.debian.org:publicity-team/dpn.git}}}. Este comando irá criar um directório {{{dpn}}} contendo o Debian Project News. A versão actual está no sub-diretório {{{current}}} do directório {{{dpn}}}. Se quiser pode mudar o nome daquele directório para algo que lhe seja mais conveniente.
## Stopped here ##
 * Change into that directory. Whatever you do: never delete or otherwise touch the {{{.git}}} folder therein! It contains some meta data needed to let everything work properly.

You can now edit the Debian Project News. Don't worry if you are unexperienced with Git or the Website Meta Language / HTML (which is used for Debian's website). Nothing you do will directly appear on the website and all errors you might do can be revoked relatively painlessly.

=== Accessing the Git repository anonymously ===

If you don't have a Salsa account, you can access the Git repository anonymously.

You can check out the current draft for the Debian Project News by using the following command: {{{git clone https://salsa.debian.org/publicity-team/dpn.git}}}. This command will create a {{{dpn}}} folder containing Debian Project News. The latest draft is located in the {{{dpn/current}}} folder.

=== Editing ===

 * Change into the folder containing the checkout. Unless you renamed it, that would be {{{dpn}}}.
 * Before editing, you should run {{{git pull}}}. This will get your local copy up to date.
 * You may now edit {{{index.wml}}} as you like. See below for details on the format.
 * Commit your changes with {{{git commit index.wml}}}
 * After you changed {{{index.wml}}}, please run {{{git update --rebase}}}, Just in case someone changed that document while you where working on it.
  * Git tries to be smart, when applying foreign changes to your changed document. Unless you changed the very same line, everything should work out pretty fine.
  * Should you have changed the very same lines, you have created a so called conflict, which must be resolved.
Please see [[http://githowto.com/resolving_conflicts|this page]] on how to do so.
 * Once your local copy is up to date, you can send your changes to the central repository by running {{{git push}}}.
 * Congrats you just contributed to next issue of the Debian Project News!

Also note, that there are several graphical front ends for Git. But as the writer lacks experience with any of them, he can't recommend them.

 * executar {{{git clone git@salsa.debian.org:publicity-team/dpn.git}}}. Este comando irá criar um directório {{{dpn}}} contendo o Debian Project News. A versão actual está no sub-diretório {{{current}}} do directório {{{dpn}}}. Se quiser pode mudar o nome daquele directório para algo que lhe seja mais conveniente.

 * Coloque-se naquele directório. Qualquer coisa que faça: nunca apague ou altere o conteúdo do directório {{{.git}}}! Contém alguma meta data necessária para que tudo funcione correctamente.

Pode agora editar o Debian Project News. Não se preocupe se não tem muita experiência com Git ou a linguagem Website Meta Language / HTML (que é usada para o site web Debian). Nada que faça aparece directamente no site e todos os erros que possa fazer podem ser desfeitos com relativa facilidade.

=== Acesso anónimo ao repositório Git ===

Se não possuir uma conta Salsa pode aceder ao repositório Git anonimamente.

Pode verificar o rascunho actual do Debian Project News utilizando o comando: {{{git clone https://salsa.debian.org/publicity-team/dpn.git}}}. Este comando irá criar um directório {{{dpn}}} contendo o Debian Project News. O último rascunho encontra-se no directório {{{dpn/current}}}.

=== Edição ===

 * Mude para o directório contendo o checkout. A não ser que tenha alterado o nome, deverá ser {{{dpn}}}.
 * Antes de editar deverá correr {{{git pull}}}. Assim actualizará a sua cópia local com qualquer alteração que exista.
 * Pode agora editar {{{index.wml}}} à sua vontade. Veja abaixo para detalhes sobre os formatos.
 * Submeta as suas alterações com {{{git commit index.wml}}}
 * Depois de alterar o {{{index.wml}}}, por favor corra {{{git update --rebase}}}, para o caso de alguém ter modificado o documento enquanto você estava a trabalhar nele.
  * O Git tenta ser inteligente quando se aplica alterações exteriores ao seu documento modificado. A não ser que tenha modificado a mesma linha, tudo deverá funcionar correctamente.
  * Se modificou as mesmas linhas, terá então sido criado um conflito, que tem que ser resolvido.
Por favor veja [[http://githowto.com/resolving_conflicts|esta página]] para saber como proceder.
 * Assim que a sua cópia local esteja actualizada, pode enviar as suas alterações para o repositório central executando {{{git push}}}.
 * Parabéns, acabou de contribuir para a próxima publicação do Debian Project News!

Note também que existem diversos frontends gráficos para o Git. No entanto como o escritor deste artigo não tem experiência com qualquer um deles, não os recomenda.

## STOPPED HERE ##

Translation(s): English - Español - Français- Italiano - 한국어 - Português

(!) ?/Discussion


  • Esta página explica como contribuir para o Debian ProjectNews e o que TU podes fazer para ajudar.

Como contribuir para a DPN

Contribuir para ProjectNews é fácil mas depende dos suas habilidades e do tempo disponível que lhe pode dedicar.

/!\ Todo o material fornecido ao repositório publicity (p.e. as suas contribuições) serão publicadas no site web Debian sob os termos das licenças MIT (Expat) ou GPL2+

Envie notícias interessantes

O modo mais simples de nos ajudar é informar sobre acontecimentos interessantes que ocorram no universo Debian. Debian é um projecto bastante grande e não possuímos os recursos humanos necessários para monitorizar conteúdo para adicionar ao nosso ProjectNews em todas as listas de correio, blogues e sites de notícias. Assim diga-nos se reparar em algo interessante que ocorra. Pode geralmente fazê-lo através do envio de um E-Mail para debian-publicity@lists.debian.org .

O que deve enviar

De um modo geral: tudo o que possa ter algum impacto de notícia em larga escala sobre o projecto Debian e relacionado com os utilizadores em particular.

Algumas ideias:

  • Discussões que ocorram numa mailing list, que:
    • tenham um impacto de notícia em Debian (p.e. Discussão sobre licenças, uma transição planificada de software)
    • contenham um debate interessante relacionada com o Projecto X ao Projecto Y e suas Resoluções Gerais, etc.)

  • Pequenos anúncios de sub projectos:
    • debian installer perto do lançamento da versão beta3, necessário testes
    • traduções debconf no idioma Francês atinge 100%
    • o cdrkit é capaz de gravar discos blue ray
    • mail "Notícias de "
    • etc...
  • Relatórios de erros interessantes (alguma vez olhou para o 245047?)

  • Representa Debian numa conferência ou exibição (com um stand, comunicação, etc.)
    • Escreveu um relatório depois de ter representado Debian numa conferência ou exibição
  • Foi entrevistado sobre o seu trabalho em Debian
  • Análises / testes / artigos noutros suportes / sites web / mailing lists / blogues
  • Conferências, mini ?DebConfs, FOSDEM, CeBIT, etc.

  • etc...

O que não necessita de assinalar

Claro que a lista acima está longe de estar completa. Gostaríamos de salientar que não podemos monitorizar outros suportes de media , sites web, blogues e tudo o resto. É assim valiosíssimo qualquer possa assinalar qualquer coisa que considere encaixar no ProjectNews, enviando para a nossa mailing list debian-publicity@lists.debian.org.

Tenha em mente que para nós um dos objectivos primários, além de manter os outros utilizadores informados, é mostrar que somos uma comunidade viva e trabalhadora! Ou seja mostrar que Debian está a vingar, que está viva!

Ajuda de falantes nativos

Actualmente o editor principal não é falante nativo Inglês. Ele sabe-o e provavelmente já reparou também. Assim uma das coisas em que pode ajudar como falante nativo é corrigir o seu en_DE para Inglês correcto. As publicações são criadas em rascunho no repositório Git. Abaixo encontram-se detalhes de como aceder ao cliente Git na seccão "Tornar-se um editor"..Mesmo que não seja familiar com o Git, pode sempre descarregar a publicação actual a partir do repositório Inglês do DPN, revê-lo e enviar comentários para a mailing list debian-publicity. Preferiríamos receber as suas alterações como diff ou wdiff, se possível: Faça apenas uma cópia do ficheiro descarregado, edite-o e envie-nos o resultado do diff -u <ficheiro antigo> <novo ficheiro>.

Tornar-se um editor

Se desejar contribuir directamente e adicionar pequenos artigos ao ProjectNews sinta-se livre para se juntar à equipa:

  • Deverá subscrever a mailing list debian-publicity em http://lists.debian.org/debian-publicity, já que toda a discussão ocorre lá.

  • Pode também querer subscrever a mailing list publicity-commits em http://lists.alioth.debian.org/mailman/listinfo/publicity-commits. Sempre que uma alteração é enviada (commit) para o repositório Git um email é enviado para a lista. Torna-se assim muito fácil estar actualizado.

  • Se for um Developer Debian deverá ter já acesso de escrita ao repositório Git.
  • Se não for um Developer Debian, necessitará de uma conta Salsa.
    • Se já possui uma conta, pode simplesmente fazer um pedido para se juntar ao projecto publicity.

    • Se não tiver uma conta, por favor registe-se no Salsa e efectue um pedido para se juntar ao projecto publicity.

  • Neste ponto deverá mesmo ler as nossas ?Guias para artigos do ProjectNews.

Acesso ao repositório Git DPN

Antes de aceder ao repositório Git, poderá querer ler a documentação Salsa para usar o repositório Git mais convenientemente.

  • executar git clone git@salsa.debian.org:publicity-team/dpn.git. Este comando irá criar um directório dpn contendo o Debian Project News. A versão actual está no sub-diretório current do directório dpn. Se quiser pode mudar o nome daquele directório para algo que lhe seja mais conveniente.

  • Coloque-se naquele directório. Qualquer coisa que faça: nunca apague ou altere o conteúdo do directório .git! Contém alguma meta data necessária para que tudo funcione correctamente.

Pode agora editar o Debian Project News. Não se preocupe se não tem muita experiência com Git ou a linguagem Website Meta Language / HTML (que é usada para o site web Debian). Nada que faça aparece directamente no site e todos os erros que possa fazer podem ser desfeitos com relativa facilidade.

Acesso anónimo ao repositório Git

Se não possuir uma conta Salsa pode aceder ao repositório Git anonimamente.

Pode verificar o rascunho actual do Debian Project News utilizando o comando: git clone https://salsa.debian.org/publicity-team/dpn.git. Este comando irá criar um directório dpn contendo o Debian Project News. O último rascunho encontra-se no directório dpn/current.

Edição

  • Mude para o directório contendo o checkout. A não ser que tenha alterado o nome, deverá ser dpn.

  • Antes de editar deverá correr git pull. Assim actualizará a sua cópia local com qualquer alteração que exista.

  • Pode agora editar index.wml à sua vontade. Veja abaixo para detalhes sobre os formatos.

  • Submeta as suas alterações com git commit index.wml

  • Depois de alterar o index.wml, por favor corra git update --rebase, para o caso de alguém ter modificado o documento enquanto você estava a trabalhar nele.

    • O Git tenta ser inteligente quando se aplica alterações exteriores ao seu documento modificado. A não ser que tenha modificado a mesma linha, tudo deverá funcionar correctamente.
    • Se modificou as mesmas linhas, terá então sido criado um conflito, que tem que ser resolvido.

Por favor veja esta página para saber como proceder.

  • Assim que a sua cópia local esteja actualizada, pode enviar as suas alterações para o repositório central executando git push.

  • Parabéns, acabou de contribuir para a próxima publicação do Debian Project News!

Note também que existem diversos frontends gráficos para o Git. No entanto como o escritor deste artigo não tem experiência com qualquer um deles, não os recomenda.

Two more guidelines for committing your changes:

  1. Please use a useful commit message (the description of your changes behind the "-m" Parameter).
  2. Try not to write too long lines. Tracking changes / viewing diffs is easier, when the line length is shorter than ~80 characters. Most Editors can be configured to automatically break the line for you.

Format of the index.wml file

The Debian Project News are available in three formats:

All these formats are generated from the index.wml file. Debian's website uses the website meta language (WML) to create the web pages. Roughly speaking WML is HTML with embedded macros (e.g. for common elements on various sites) and the possibility to embed perl scripts, e.g. to create a list of DPN issues based on the available files. But don't worry: you don't need to know WML or perl (and only basic HTML) to contribute to the DPN. Luckily nearly everything is already in place and we just need to create the content with minimal HTML markup.

If you look at an empty index.wml (you can look at this one which is used as a template) you'll notice that it starts as follows:

#use wml::debian::projectnews::header PUBDATE="2017-MM-DD" SUMMARY=""
#use wml::debian::acronyms

The first line says to the wml compiler that it should use the project-news template for the header. It also sets two variables for the publishing date and a small summary. The summary is used for example at the index page for recent issues. It shouldn't be too long.

The acronyms line allows the use of specific acronyms, which will show the explanation as a hover text over the acronym.

At the end you'll see something similar to this:

#use wml::debian::projectnews::footer editor="The Publicity Team with contributions from contributor1, contributor2, contributor3"

That tells the wml compiler to add the normal footer to the web page. With the editor variable, it will also add the names of the contributors listed there.

Everything between these lines, is almost regular HTML, which in our case mostly means: some headlines (<toc-add-entry>...</toc-add-entry>), some paragraphs (<p>...</p>) or some lists (<ul><li>...</li><li>...</li></ul>).

Every article should start with a unique entry name:

<toc-add-entry name="$unique_anchor">$my_beautiful_title</toc-add-entry>
<p>This is the content of my small article, where I can insert <a href="http://debian.org/">links</a> and other regular HTML markup.</p>

The stuff between the <toc-add-entry> and </toc-add-entry> is the actual headline.

After that follows the actual article between <p> and </p>. You may use several of these paragraphs, but note that only the first one will appear in the RSS-feed. (Which might be a bug worth fixing, if you know enough perl...)

As explained, you may use normal HTML in these paragraphs. This means:

  • <q>...</q> for quotes, citations or release names:

    • Debian 6.0 <q>squeeze</q>, Steve McIntyre said: <q>Booh!</q>

  • <a href="..."> for links:

    • The Secretary <a href="http://lists.debian.org/debian-devel-announce/2010/03/msg00000.html">called for nominates</a> for the project leader elections.

  • <!-- ... --> for comments, which won't appear on the website:

    • {<!-- TODO:  Add a link once this discussion has come to a conclusion! -->

As the Project News is also read by users not very familiar with the Debian internal jargon and acronyms, please also use the <acronym ...> </acronym> tag (not part of HTML but one of our wml templates). See the following example:

One topic discussed was: <q>Race against <acronym lang="en" title="None of the above">NOTA</acronym>.</q>

While it won't work in the text version for e-mails, at least the HTML version for the websites and the RSS feed will mark the acronym so, that when the user moves the mouse cursor over the acronym the explanation is displayed. You can see an example on http://www.debian.org/News/project/2009/02/ (search for DPL).

Translating the Debian Project News

Feel free to use the Git repository for your translation work, too. In these cases it is easier to just check out the complete DPN hierarchy of the Git repository by doing:

  • git clone git@salsa.debian.org:publicity-team/dpn.git

  • cd dpn

  • Now check if there is already a directory for your language. If not
    • Create one, e.g. mkdir fr

    • Create the corresponding year/issue subdirectory (e.g mkdir -p 2015/07)

    • Add a first version (unfinished is ok) of your translation as index.wml

    • Add it to the repository, e.g. git add fr/

    • Commit locally your changes git commit -m"first step in the translation"

    • And push your changes to the central Server, e.g. git push

  • Now you can mimic the same directory layout used under the en folder. Old Issues are kept in the specific en/<year>/<issue> directories, the one currently worked on is in en/current. You'll also notice the en/index.wml-template which is an empty issue, used as a template to start a new one.

  • Please see Becoming an editor yourself for some usage guidelines for Git and a small description of the format of the wml files. But note:

    • Translations should also use a #use wml::debian::translation-check translation="<revision>" header, to mark which revision of the original issue the translation follows.

  • Just like the editor field in the #use wml::debian::projectnews::footer line, translators can also add a translator field in a similar fashion. See the following example (for French:

#use wml::debian::projectnews::footer editor="L'équipe en charge de la publicité avec des contributions de Thomas Lange et Paulo Henrique de Lima Santana et Jean-Pierre Giraud" translator="Jean-Pierre Giraud, l\'équipe francophone de traduction"

Using Translation check to track original document versions

If you use the publicity Git repository you can use the script in scripts/trans-check to track which of your translations are up to date. Your translations need a translation check for this to work. For example:

#use wml::debian::translation-check translation="45"

This will tell the script (and later Debian's website), that your translation was based upon revision 45 of the original document.

The only parameter it takes is the language to be checked or to be more precise: the folder it should compare against the en/ folder. See the following example:

alex@rusalka:publicity/dpn$ scripts/trans-check fr
Found 'fr/current/index.wml' is outdated!
  Please run 'svn diff -r 9:18 "en/current/index.wml"' to review the changes to the original document.

Getting your translation published

As shortly explained in section Format of the index.wml file, the Debian Project News are published in three ways:

  • HTML on the Debian web site
  • RSS feed (also on the Debian web site)
  • Text mail sent to various lists

To get your translation published on Debian's website, it will need to be added to the CVS repository. See http://www.debian.org/devel/website/ for more details about that.

To send your translation out as e-mail on one of our user mailing lists, note that the debian-news-language lists are moderated, so please get in contact with the respective moderators / your translation team (e.g. via the debian-l10n-language lists). If there's no debian-news-language list for your language, but a debian-user-language list, you may send your translation to that list (depending on what the members of that list think about it).

Regardless of where you send it, you will find the script scripts/DPNhtml2mail.pl quite handy: when your translation is available on the website, you can just run it, and it will create the text version for you. You can call it in a way similar to scripts/DPNhtml2mail.pl -d -l en -i 2008/06. It doesn't work perfectly, yet, but it makes it very easy to create a "good looking" text version.

Translation Workflow

This section documents the current workflow used by the French translation team to translate and send out issues of the Debian Project News. It welcomes other team experience in order to give some hints to each other.

It relies on the current workflow, and likewise, the following states only the ideal workflow. Because of some constraints of the editors or due to expected events (e.g. when one ftp-master ask the issue to be delayed for a couple of hours, so the mail he is about to send out can be mentioned in the issue) the following timeline might be stretched.

Current workflow

(As practised more or less by the French translation team.)

  1. After every release https://salsa.debian.org/publicity-team/dpn/tree/master/LL/current is moved to the proper location (e.g. 2010/01). Then a new current folder is created and the index.wml-template is copied in there, to start with an empty and fresh translation of the news.

  2. Around a week before the issue is to be published, begin to translate what is already available (in order to avoid last minute, hurry and possibly dirty work).
  3. If enough articles are already in place (say four or five), sent the WIP draft to the debian-l10n-language@l.d.o for review.

  4. When the DPN is string-frozen, try to finish it as quickly as possible, asking for help in debian-l10n-language@l.d.o can be a good idea, and offers to any member the ability to provide at least one translated article (ask explicitly to mention on which article she or he works in order to avoid duplicate).

  5. When the translated DPN is finished hopefully Friday or Saturday, ask for a formal review on debian-l10n-language@l.d.o.

  6. On the next Monday, publish the translated DPN on the website following the original one, and launch a last call for comment on debian-l10n-language@l.d.o.

  7. Two or three days later, send the DPN on debian-news-language@l.d.o.

Remarks and problems with the current workflow

  • The time allowed for contributors to review the issue is still short, thus the proposition to provide partial WIP draft for review one week before.
  • It heavily depends on a DPN which is not edited at the last minute ;-).

  • It is still sent two or three days after its targeted date.