WikiPages/pt-br

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'.

Nomes de página

Os nomes das páginas de bancada de trabalho de alto nível devem ter este formato: em inglês XYZ Workbench em ‎português do Brasil Bancada de trabalho XYZ 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: XYZ Comando por exemplo, PartDesign Pad. Note que deve-se usar o nome do comando como ele aparece no código fonte.

Títulos

Links

Você deve usar o nome do link original para links sempre que possível. Isso esclarece a página referenciada na documentação impressa ou ‘offline’. Evite palavras sem sentido para o link.

Link ruim

Para obter mais informações sobre como desenhar objetos 2D, clique aqui.

Bom link

Para obter mais informações sobre o desenho de objetos 2D, consulte a Bancada de trabalho Draft.

O melhor formato para um link é:

Traduzido:

Note que o que vem antes de |, é o link real, isto é importante. Se o nome da sua página for Nome_da_página, o link falhará se você digitar Nome_da_Página (P em maiúsculo). Antes do caractere | todos os espaços devem ser substituídos por traço baixo (_). Isto é para ajudar os tradutores que utilizam programas de tradução, sem os sublinhados o link seria traduzido pelo ‘software’, o que é indesejável.

Para criar um link para um determinado parágrafo, adicione uma cerquilha # e o títulos a referenciar. Exemplo:

[[WikiPages#Name|WikiPages]]

Traduzido:

[[WikiPages/pt-br#Nome|PaginasWiki]]

Dentro da mesma página, você pode omitir o nome da página. Exemplo:

[[#Nomes|Nomes]]

Para criar um link para o topo da página você pode usar:

</translate>{{Top}}<translate>

Image link

To use an image as a link:

[[Image:Draft_Wire.svg|24px|Optional text that is shown when you hover the image|link=Draft_Wire]]

Image link + text link

Draft Wire

If you leave out the optional text the link itself will be shown when the image is hovered, which is preferable, and you should also add a text link after the image link:

[[Image:Draft_Wire.svg|24px|link=Draft_Wire]] [[Draft_Wire|Draft Wire]]

Páginas do Workbench

Uma página de bancada de trabalho de alto nível deve começar com:

• Uma descrição de para que serve a bancada de trabalho.
• Uma imagem para ilustrar a descrição.

Consulte #Captura de tela para obter convenções sobre a inclusão de imagens.

Páginas de comando

As páginas de comando que descrevem as ferramentas da bancada de trabalho não devem ser muito longas, elas devem apenas explicar o que um comando pode e o que não pode fazer, e como usá-lo. Você deve manter as imagens e os exemplos no mínimo possível. Tutoriais podem expandir os detalhes de como usar a ferramenta e fornecer detalhes passo a passo.

Consulte a página Modelo GuiCommand para obter mais detalhes.

Tutoriais

Um tutorial bem escrito deve ensinar como alcançar determinados resultados práticos rapidamente. Não deve ser muito longo, mas deve incluir instruções e imagens passo-a-passo suficientes para guiar o usuário. Conforme o FreeCAD evolui, os tutoriais podem tornar-se obsoletos, por isso é importante mencionar a versão FreeCAD usada nele, ou necessária para realizar o tutorial.

Para obter exemplos, visite a página Tutoriais.

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.

Modelo	Aparência	Descrição
Top	Top	Use it to add a link to the top of the page.
Emphasis	ênfase	Utilize-o para enfatizar um pedaço do texto.
KEY	Alt	Utilize-o para indicar a tecla que precisa ser pressionada.
ASCII		Utilize-o para indicar uma tecla ascii com uma imagem (.svg) que precisa de ser pressionada. É necessário fornecer o carácter desejado ou o número do código ascii.
Button	Cancelar	Utilize-o para indicar um botão na ‘interface’ gráfica do usuário que precisa de ser clicado.
RadioButton	Opção	Utilize-o para inserir um botão de opção na ‘interface’ gráfica do usuário que pode de ser Selecionado ou Não Selecionado.
CheckBox	Opção	Utilize-o para criar uma caixa de verificação na ‘interface’ gráfica do usuário que pode de ser Checado ou Não verificado.
SpinBox	1.50	Utilize-o para inserir um botão giratório na ‘interface’ gráfica do usuário para ele possa ajustar um valor.
ComboBox	Menu 1	Utilize-o para indicar uma caixa de combinação na ‘interface’ gráfica do usuário que precisa de ser modificada.
LineEdit	Metal Nickel (Ni)	Use it to indicate a LineEdit in the graphical user interface that needs to be modified.
FALSE, false	false, false	Use-o para indicar um valor booleano falso, por exemplo, como uma propriedade no editor de propriedade. Isto é um atalho. Como é um valor, prefira Modelo Value. false
TRUE, true	true, true	Use-o para indicar um valor booleano verdadeiro, por exemplo, como uma propriedade no editor de propriedade. Isto é um atalho. Como é um valor, prefira Modelo Value. true
MenuCommand	Arquivo → Salvar	Utilize-a para indicar a localização de um comando dentro de um determinado menu.
FileName	Nome do arquivo	Utilize-o para indicar um nome de um arquivo ou diretório.
SystemInput	Digite este texto	Use-o para indicar o texto de entrada digitado pelo usuário.
SystemOutput	Texto de saída	Use-o para indicar a saída de texto do sistema.
Incode	import FreeCAD	Use-o para incluir o código-fonte em linha com uma fonte monoespaçada. Ele deve caber em uma linha.
PropertyView	VistaCor	Use-o para indicar uma propriedade de Visualização no editor de propriedades. Exemplos de propriedades de visualização incluem Cor da linha, Largura da linha, Cor do ponto, Tamanho do ponto, etc.
PropertyData	DadosPosição	Use-o para indicar uma propriedade de Dados no editor de propriedades. As propriedades de dados diferem para diferentes tipos de objetos.
Properties Title / TitleProperty	Base	Use-o para indicar o título de um grupo de propriedade no editor de propriedades. O título não será incluído no índice automático.
Obsolete	obsolete in 0.19	Use-o para indicar que uma característica se tornou obsoleta na versão FreeCAD especificada.
VersionNoteObsolete	obsolete in 0.19	Idem (superscript variant).
Version	introduced in 0.18	Use-o para indicar que uma característica foi introduzida na versão FreeCAD especificada.
VersionNote	introduced in 0.18	Idem (superscript variant).
VersionMinus	0.16 and below	Use-o para indicar que um recurso está disponível na versão FreeCAD especificada e nas versões anteriores.
VersionNoteMinus	0.16 and below	Idem (superscript variant).
VersionPlus	0.17 and above	Use-o para indicar que um recurso está disponível na versão FreeCAD especificada e nas versões posteriores.
VersionNotePlus	0.17 and above	Idem (superscript variant).
ColoredText	Texto Colorido	Use este modelo para colorir o fundo, texto, ou fundo e texto. (Pagina ColoredText para mais exemplos)
ColoredParagraph	Parágrafo Colorido	Use este modelo para colorir o fundo, texto ou fundo e o texto de um parágrafo inteiro. (Página ColoredParagraph para mais exemplos)

Imagens e capturas de tela são necessárias para produzir uma documentação completa do FreeCAD. Elas são particularmente úteis para ilustrar exemplos e tutoriais. As imagens devem ser mostradas em seu tamanho original, para que apresentem detalhes suficientes e sejam legíveis se incluírem texto. As imagens Bitmap não devem ser redimensionadas.

Evite imagens animadas (GIF) nas páginas de ajuda geral. Animações e vídeos devem ser reservados para tutoriais não destinados a serem usados como documentação PDF offline.

As imagens podem ser carregadas através da página Enviar arquivo.

Nome

Captura de tela

Os tamanhos recomendados para as capturas de tela são:

• Nativo 400x200 (ou largura=400 e altura<=200), para páginas dereferência de comando, para permitir que a imagem caiba na parte esquerda da página, e para outras fotos padrão.
• Nativo 600x400 (ou largura=600 e altura<=400), para páginas dereferência de comando, quando você realmente precisa de uma imagem maior, e ainda permitir que a imagem caiba na parte esquerda da página, e para outras fotos padrão.
• Nativo 1024x768 (ou largura=1024 e altura<=768), apenas para imagens em tela cheia.
• Tamanhos menores são possíveis ao mostrar detalhes.
• Evite imagens com resoluções maiores, pois elas não serão muito portáteis para outros tipos de displays ou para a documentação PDF impressa.

Você não deve depender de uma configuração personalizada de sua área de trabalho ou sistema operacional quando criar capturas de tela e deve usar os padrões gráficos da plataforma do FreeCAD sempre que possível.

Para criar uma captura de tela você pode usar as opções fornecidas por seu sistema operacional, ou uma dessas macros: Macro de Corte e Macro de tela Wiki.

Texto

Para facilitar a tradução da documentação, tente evitar capturas de tela que contenham textos. Se você não puder evitar isto, considere tirar fotos separadas da ‘interface’ e da vista 3D. A imagem da visualização 3D pode ser reutilizada em cada tradução, enquanto um tradutor pode tirar uma captura de tela da ‘interface’ localizada, se necessário.

Ícones e imagens

Consulte a página Objetos gráficos para todas as ilustrações e ícones que foram criados para o FreeCAD, e que também podem ser utilizados em páginas de documentação. Se quiser contribuir com ícones, favor ler as Diretrizes para trabalhos gráficos.

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.

Algumas dicas para tradutores

Traduzir GuiCommand

{{GuiCommand
|Name=FEM EquationFlux
|MenuLocation=Solve → Flux equation
|Workbenches=[[FEM_Workbench|FEM]]
|Shortcut={{KEY|F}} {{KEY|S}}
|Version=0.17
|SeeAlso=[[FEM_tutorial|FEM tutorial]]
}}

Traduzido:

{{GuiCommand/fr
|Name=FEM EquationFlux
|Name/fr=FEM Équation d'écoulement
|MenuLocation=Solveur → Équation de flux
|Workbenches=[[FEM_Workbench/fr|Atelier FEM]]
|Shortcut={{KEY|F}} {{KEY|S}}
|Version=0.17
|SeeAlso=[[FEM_tutorial/fr|FEM Tutoriel]]
}}

Traduzir navi

{{FEM_Tools_navi}}

Traduzido:

{{FEM_Tools_navi/fr}}

Traduzir link

[[Part_Workbench|Part Workbench]]

Traduzido:

[[Part_Workbench/fr|Atelier Part]]

Traduzir Docnav

{{Docnav
|[[About_FreeCAD|About FreeCAD]]
|[[Installing_on_Windows|Installing on Windows]]
}}

Traduzido:

{{Docnav/fr
|[[About_FreeCAD/fr|À propos de FreeCAD]]
|[[Installing_on_Windows/fr|Installation sous Windows]]
}}

Exemplo com ícones:

{{Docnav
|[[Std_Save|Save]]
|[[Std_SaveCopy|SaveCopy]]
|[[Std_File_Menu|Std File Menu]]
|IconL=Std_Save.svg
|IconR=Std_SaveCopy.svg
|IconC=Freecad.svg
}}

Traduzido:

{{Docnav/fr
|[[Std_Save/fr|Enregistrer]]
|[[Std_SaveCopy/fr|Enregistrer une copie]]
|[[Std_File_Menu/fr|Menu fichier]]
|IconL=Std_Save.svg
|IconR=Std_SaveCopy.svg
|IconC=Freecad.svg
}}