WikiPages/pt-br

Esta página é uma extensão da página Help:Editing e dá orientações comuns para escrever e atualizar a documentação do wiki FreeCAD. Resume várias discussões e sessões de troca de ideias.

Antes de começar

 * Esta documentação wiki é baseada no MediaWiki, o mesmo ‘software’ que alimenta a Wikipédia. Se você já contribuiu para a Wikipédia, a edição de páginas wiki FreeCAD deve ser fácil.
 * Ao contrário da Wikipedia, o wiki FreeCAD está protegido contra ‘spam’. É necessário solicitar uma conta no forum.
 * Se nunca utilizou ‘software’ wiki antes, por favor leia Help:Editing para se familiarizar com a marcação que é utilizada.
 * Para o uso avançado do ‘software’ wiki, ver MediaWiki Ajuda:Conteúdo. Nem todas as características do MediaWiki estão disponíveis neste wiki FreeCAD, mas muitas estão.
 * Gostamos de manter a documentação de fácil leitura, por isso evite utilizar características complexas. Mantenha-a simples.
 * Use uma sandbox para testar o seu código, por exemplo, FreeCADDocu:Sandbox ou uma página específica com o seu nome Sandbox:Yourname.
 * Por favor, esteja atento às traduções. O wiki FreeCAD utiliza suporte de tradução automática para fornecer páginas em diversas línguas. Para cada página podem existir várias versões linguísticas. Em muitas páginas vê-se etiquetas como   e muitas etiquetas individuais como  . Estas últimas são criadas pelo sistema de tradução. Elas ligam os títulos e parágrafos às suas versões traduzidas. Não devem ser alterados, já que isso destruiria essas ligações. No entanto, não há problema em mover parágrafos ou alterar a redação, desde que as etiquetas permaneçam com eles. Se remover um título ou um parágrafo, deve também remover a etiqueta correspondente. Tenha em conta que as alterações nos títulos e parágrafos existentes influenciam as traduções existentes. As suas modificações devem valer a pena. Não se preocupe quando adicionar novo material porque o sistema irá adicionar novas etiquetas automaticamente após as suas edições. Para mais informações ver  Localisation e a página original Help:Extensão:Translate/Exemplo de tradução de página.

Descrições concisas
Ao descrever o FreeCAD tente ser conciso e direto e evite a repetição. Descrever o que o FreeCAD "faz", e não o que o FreeCAD "não faz". Evite também expressões coloquiais. Utilizar "alguns" quando se lida com um número indeterminado, ou especificar a quantidade correta.


 * Descrição ruim
 * PartDesign Workbench a PartDesign é uma bancada de trabalho para a concepção de peças que visa fornecer ferramentas para a modelação de peças sólidas complexas.


 * Boa descrição
 * PartDesign Workbench visa fornecer ferramentas para modelação de peças sólidas complexas.

Informação centralizada
Evitar duplicar informações. Insira a informação numa nova página, e crie um link para esta, e utilize o quando precisar reutilizar informação.

Não utilizar a tranclusão de páginas (Help:Editing#Modelos e paginas Transcluidas), visto que isto torna o wiki difícil de traduzir. Utilize apenas os modelos descritos abaixo em #Modelos.

Estilo
Os modelos são usados para estilizar as páginas de ajuda. Eles dão à documentação uma aparência uniforme. Há um modelo para comandos de 'menu', Arquivo → Salvar, um modelo para mostrar as teclas a serem pressionadas,, para mostrar um valor booleano, , etc. Familiarize-se com a seção #Modelos antes de escrever páginas de ajuda.

Sinalizadores temporários
Se estiver a trabalho numa página grande é aconselhável marcar a página como em construção ou como inacabada. Isto assegura que os administradores do wiki não marquem a sua página como pronta para tradução enquanto ainda está a alterá-la.

Para sinalizar uma página, adicionar  ou   na primeira linha. Com   convidará outros a juntarem-se a ti para terminar a página, enquanto    indica que tu realizarás o trabalho e que outros devem esperar o autor concluir.

Uma vez terminado o trabalho, por favor não se esqueça de retirar os sinalizadores!

Exemplos
Para se familiarizar rapidamente com a estrutura e estilo do wiki FreeCAD veja a página modelo: Modelo GuiCommand.

Estrutura
A Central do Usuário fornece um Índice 'On-line' de Ajuda. Este é usado como referência principal para compilar automaticamente a ajuda 'offline' que se encontra no FreeCAD, bem como a documentação PDF 'offline'.

O Modelo:Docnav é utilizado para ligar páginas sequencialmente, seguindo a estrutura do Índice 'On-line' de Ajuda. Veja #Modelos para uma lista de todos os Modelos.

Nomes de página
Os nomes das páginas devem ser curtos, e eles devem usar o caso das sentenças: todas as palavras, exceto a primeira e os nomes próprios, tem de estar em caixa baixa. Este é o estilo adotado pela Wikipédia para seus artigos.


 * Nome de página ruim:
 * Construção de Aviões da AeroCompany


 * Bom nome de página:
 * Construção de aviões da AeroCompany

Os nomes das páginas de bancada de trabalho de alto nível devem ter este formato: em inglês  em  ‎português do Brasil   onde XYZ é o nome da bancada de trabalho, por exemplo, PartDesign Workbench,  Bancada de trabalho PartDesign. E os nomes das páginas que descrevem os comandos (ou ferramentas) pertencentes a um bancada de trabalho devem ter este formato:  por exemplo, PartDesign Pad. Note que deve-se usar o nome do comando como ele aparece no código fonte.

Uma convenção anterior previa a utilização de um caixa de título: cada palavra deveria começar com uma letra maiúscula, a menos que sejam artigos, preposições, conjunções, ou outras partículas gramaticais (por exemplo, 'de','para', 'em', 'no', 'um', 'uma', 'e'). Há muitas páginas existentes que utilizam este estilo, mas é desaconselhável o uso em novas páginas. Isto foi discutido no tópico do fórum (Lowercase links) Use a lower case title for a wiki page.

Títulos
Like page names, paragraph headings should be short and use sentence case. You should not use  headings  in your wiki markup since the page title is automatically added as the main   heading.

Links
You should use the original link name for links whenever possible. This clarifies the referenced page in printed or offline documentation. Please avoid non-meaningful words for the link.


 * Bad link
 * For more information on drafting 2D objects click here.


 * Good link
 * For more information on drafting 2D objects refer to the Draft Workbench.

The preferred format for a link is:

Traduzido:

Note that for the part before the  character, the actual link, case is relevant. If your page name is  the link will fail if you type   (upper case P). Before the  character all spaces should be replaced by underscores. This is to assist translators using translation software, without the underscores the link would be translated by the software which is undesirable.

To link to a certain paragraph add a  sign and its headings to the page name. Example:

Traduzido:

Within the same page you can omit the page name. Example:

To link to the top of the page you can use:

This link will even work if there is no 'Top' paragraph on the page. It is especially useful for long pages as it allows the user to quickly jump back to the table of content. You can put it at the end of each paragraph. Make sure there is an empty line before and after the link.

Páginas do Workbench
A top level workbench page should start with:
 * A description of what the workbench is used for.
 * An image to illustrate the description.

See #Screen capture for conventions on including images.

Páginas de comando
Command pages describing workbench tools should not be too long, they should only explain what a command can do and what it can't, and how to use it. You should keep pictures and examples to a minimum. Tutorials can expand on how to use the tool and provide step-by-step details.

Please refer to the GuiCommand model page for more details.

Tutoriais
A well written tutorial should teach how to achieve certain practical results quickly. It shouldn't be too long, but should include sufficient step-by-step instructions and images to guide the user. As FreeCAD evolves, tutorials may become obsolete, so it is important to mention the FreeCAD version used in, or required for, a tutorial.

For examples visit the Tutorials page.

Modelos
A estilização das páginas wiki do FreeCAD é conseguida através da utilização de modelos (Help:Editing#Templates_and_transcluding_pages). Garantem um aspecto e uma sensação padronizados em todas as páginas, e também tornam possível reestilizar o wiki. Para consultar a lista completa de modelos definidos, acesse Todas as páginas com prefixo (Template:). Mas, por favor, utilize apenas os modelos listados nas tabelas abaixo. Apenas em casos muito especiais deverá utilizar diretamente as marcações HTML.

Clique no link do modelo para ver as instruções de utilização de um modelo, e para ver a sua implementação. Os modelos são uma característica poderosa do ‘software’ MediaWiki. Deve ser um usuário wiki experiente se desejar propor adições e modificações aos modelos existentes. Se implementados de forma errada, os modelos dificultam a tradução de páginas para outras línguas, pelo que a sua utilização deve ser limitada à formatação de texto, a transclusão de páginas deve ser evitada. Veja MediaWiki Help:Predefinições para saber mais.

Modelos simples
Estes modelos aceitam um parâmetro de texto simples, e o formatam com um estilo particular.

Modelos complexos
Estes modelos requerem mais parâmetros de entrada, ou produzem um bloco de texto com um formato particular.

Artes gráficas
Images and screenshots are necessary to produce a complete documentation of FreeCAD. They are particularly useful to illustrate examples and tutorials. Images should be shown in their original size, so they present sufficient detail and are readable if they include text. Bitmap images should not be resized.

Avoid animated pictures (GIF) in the general help pages. Animations and videos should be reserved for tutorials not intended to be used as offline PDF documentation.

Images can be uploaded through the Special:Upload page.

Nome
Give meaningful names to your images. If you have an image that showcases the characteristics of a particular command, you should use the name of that command with at the end. For example for the command Draft Offset the image should be called.

Captura de tela
Recommended sizes for screen captures are:
 * Native 400x200 (or width=400 and height<=200), for command reference pages, to allow the picture to fit in the left part of the page, and for other standard snapshots.
 * Native 600x400 (or width=600 and height<=400), for command reference pages, when you really need a bigger picture, and still allow the picture to fit in the left part of the page, and for other standard snapshots.
 * Native 1024x768 (or width=1024 and height<=768), only for full screen images.
 * Smaller sizes are possible when showing details.
 * Avoid images with larger resolutions, as they won't be very portable to other kinds of displays or the printed PDF documentation.

You shouldn't depend on a custom configuration of your desktop or operating system when you create screenshots and you should use the visual defaults of the FreeCAD interface whenever possible.

To create a screenshots you can use the options provided by your operating system, or one of these macros: Macro Snip and  Macro Screen Wiki.

Texto
To ease documentation translations, try to avoid screenshots that contain texts. If you cannot avoid this, consider taking separate screenshots of the interface and the 3D view. The image of the 3D view can be reused in every translation, while a translator can take a screenshot of the localized interface if necessary.

Ícones e imagens
Refer to the Artwork page for all artwork and icons that have been created for FreeCAD, and which can also be used in documentation pages. If you would like to contribute icons, please read the Artwork Guidelines.

Traduções
Por consenso, a página de referência no wiki é a página em inglês, que deve ser criada primeiro. Se quiser alterar ou adicionar conteúdo a uma página, deve fazê-lo primeiro à página inglesa, e só após concluída a atualização, deve ser feita a modificação na página traduzida.

O wiki FreeCAD utiliza uma extensão de tradução que permite gerir traduções entre páginas mais facilmente; para mais detalhes, ver Localização Traduzir a wiki do FreeCAD.

Outros recursos úteis são:
 * código de idioma ISO para identificar o código de duas letras para uma linguagem específica para a qual se pretende traduzir.
 * Google Tradutor para ajuda com traduções.
 * Deepl Tradutor para ajuda com traduções.

Traduzir GuiCommand
Traduzido:

Traduzir navi
Traduzido:

Traduzir link
Part Module

Traduzido:

Atelier Pièces /

Traduzir Docnav
Traduzido:

Exemplo com ícones:

Traduzido:

Renomear páginas
Como o FreeCAD é um projeto em permanente desenvolvimento, é por vezes necessário rever o conteúdo do wiki. Se os nomes dos comandos forem alterados no código-fonte, as páginas wiki que os documentam têm de ser renomeadas também. Isto só pode ser feito pelos administradores do wiki. Para informar os administradores, abrir um tópico no fórum Wiki e listar a alteração de nome necessária nesta forma:

old name        new name Old_page_name_1 New_page_name_1 Old_page_name_2 New_page_name_2 ...

Excluir arquivos e páginas
Caso precise apagar um arquivo, vá à sua página e edite-o. Não importa se a página está em branco ou não, adicione isto como primeiro elemento:  e imediatamente abaixo descreva por que razão a página deve ser apagada. Além disso, abrir um tópico no fórum Wiki.

Para páginas, o procedimento é o mesmo.

Discussão
O subforum Desenvolvimento/Wiki no fórum FreeCAD oferece um espaço dedicado à discussão de tópicos da wiki, a aparência da wiki e tudo o mais relacionado com a wiki. Coloque lá as suas perguntas e sugestões.

Inglês
Consulte Glossário.

Outros idiomas

 * Italiano
 * Francês
 * Alemão
 * Polonês