Recomendações de Estilo

• Conteúdo Contents Recomendações de Estilo Resumo Recomendações Códigos Linha de comando

Resumo

Dentro das atividades normais deste Wiki serão utilizados diversos elementos de texto diferentes, como códigos, tabelas, links e etc. Para evitar uma diversidade que não demonstre o aspecto cooperativo deste esforço, estão resumidos aqui como tratar os diversos elementos de texto que possam se apresentar de tempos em tempos.

Para utiliza-los, basta pegar o código Wiki dos mesmos e adaptar a seus textos. Use a tabela de conteúdos para acessa-los rapidamente.

Recomendações

Códigos

Devem ser utilizados com as instruções de parsers com o tipo de linguagem apontado, se este wiki permitir tal formatação. Atualmente são permitidos:

• C/C++
  • código: cplusplus
• Java
  • código: java
• Python
  • código: python
• Pascal
  • código: pascal

Basta apenas seguir este exemplo:

{{{ #!<códigodalinguagem>
<código>}}}

O resultado é como o visto abaixo:

   1  def hello():
   2       print "Hello World!"
   3 

Linha de comando

Deve ser representada por um bloco selecionado de código, sempre usando os marcadores básicos na frente, ou seja, se o texto indicar um comando rodado pelo usuário, a linha começa com um $, no caso do usuário estar como Root deve-se usar um # no começo da linha.

Para chamar o bloco de código basta inserir o seguinte texto:
{{{
<comando>}}}

Se o texto pedir que seja rodado o comando "modprobe" como Root ele deve ser feito desta forma:
{{{
#modprobe}}}

No Wiki será exibido:

#modprobe