Como escrever artigos na wiki

De Área31 Hackerspace
Revisão de 01h48min de 4 de fevereiro de 2019 por Coffnix (discussão | contribs)
(dif) ← Edição anterior | Revisão atual (dif) | Versão posterior → (dif)

Básico

Aqui está uma lista de informações básicas do wiki que você precisa saber para começar:

  • Primeiro, para realizar edições no wiki, você deve possuir uma conta na wiki e efetuar login.
  • Você pode criar uma nova página, navegando até https://area31.net.br/wiki/New_Page_Name. Sublinhados são o equivalente de espaços. Em seguida, selecione "Criar" no menu "Ações".
  • Seja criando uma nova página ou editando uma página existente clicando em "Editar", você será presenteado com um editor de texto baseado na Web que permite modificar o "wikitexto" da página. O wikitexto é renderizado para produzir o documento que você vê quando visualiza a página normalmente.


Upload de imagens

Para fazer upload de imagens, vá para Special:Upload e envie um arquivo. Certifique-se de que todas as imagens enviadas tenham as mesmas dimensões. Ao fazer upload, anote o campo Nome do arquivo de destino - esse é o nome que o upload usará quando você fizer referência a ele no slide. Recomenda-se escolher um nome descritivo simples que termine com ".jpg" ou ".png" para o nome de arquivo de destino.


Visual dos artigos

   Dica:

As seções a seguir documentam como usar os templates wikitext na nossa wiki.


Parágrafos

Para criar um novo parágrafo, insira uma linha em branco entre duas linhas de texto. Se não existir uma linha em branco entre duas linhas de wikitexto, elas serão combinadas em um único parágrafo fluente. Assim:


foobar


Se você deixar espaços em branco iniciais no início de uma linha, nossa wiki os processará como texto pré-formatado <pre>. Cuidado com isso. Isso irá cagar o visual ao especificar parâmetros de templates, então você obterá isso:


foobar


Hierarquia nos artigos

Use cabeçalhos de seção para criar uma hierarquia de documentos para sua página. Estes irão definir o índice que aparece no topo da página wiki. Crie capítulos, seções e subseções da seguinte maneira:

= Título da página =

== Título do capítulo ==

=== Título da seção ===

==== Título da subseção ====

   Nota:

Por padrão, o índice está desativado no wiki. Se você gostaria de ativar o TOC, você pode colocar um__TOC__ em uma linha em branco onde você gostaria que o Sumário fosse exibido ou colocado __FORCETOC__ em uma linha em branco em qualquer lugar do wikitexto para forçar o TOC a aparecer no topo da página.

Em geral, ao criar novos documentos, é melhor usar Títulos da Seção do nível 3 (três "=") para dividir o conteúdo. Títulos de seção de nível 2 são melhor usados para seções principais de documentos maiores. Use-os com pouca frequência. Títulos da Seção de Nível 1 geralmente não precisam ser usados.


Links

Links internos para outras páginas wiki podem ser especificados como [[pagename]]. Para especificar um nome alternativo para o link, use [[pagename|my link name]].

Para links externos, use [https://funtoo.org funtoo.org] para especificar um URL. Se você quiser que o URL apareça no wikitexto, você pode especificá-lo também sem colchetes: https://funtoo.org/


Listas

O MediaWiki suporta vários formatos de lista:

  • Lista não ordenada
  • Item não ordenado 2
    • Subitem não ordenado
  1. Lista ordenada
  2. Item pedido 2
    1. sub-item solicitado
Termo
Isso é chamado de "lista de definição". É usado ao definir vários termos.
   Nota:

Sempre use Tabelas em vez de listas de definição, quando possível. Elas são mais fáceis de ler.


Blockquotes

Se você precisar citar uma parte do texto de outro site, use <blockquote> do seguinte modo:

Wikipedia (ˌwɪkɨˈpiːdiə / ou wɪkiˈpiːdiə / wik-i-pee-dee-ə) é uma enciclopédia de conteúdo livre editada de forma colaborativa, multilíngüe, gratuita e gratuita, que é suportada e hospedada pela Fundação Wikimedia sem fins lucrativos. Voluntários de todo o mundo escrevem colaborativamente os 30 milhões de artigos da Wikipedia em 287 idiomas, incluindo mais de 4,5 milhões na Wikipédia em inglês. Qualquer pessoa que consiga acessar o site pode editar quase todos os seus artigos, que na Internet constituem [4] o maior e mais popular trabalho de referência geral. [5] [6] [7] [8] [9] Em fevereiro de 2014, o The New York Times informou que a Wikipédia está em quinto lugar mundial entre todos os sites, "Com 18 bilhões de visualizações de página e quase 500 milhões de visitantes únicos por mês ..., a Wikipedia apenas Yahoo, Facebook, Microsoft e Google maior com 1,2 bilhão de visitantes únicos. "[10]


Texto Literal e Símbolos HTML

Aqui está o wikitexto para a seção acima, que estou exibindo colocando o wikitexto literal entre um <pre> e </pre> tag. Se você quiser desabilitar o processamento de wikitexto para um intervalo de texto em linha, use <nowiki> e </nowiki>. Se você quiser imprimir uma tag literalmente, use &#60; e &#62; (No wikitexto, eu usei &amp;#60; e &amp;#62 para mostrar isso!)

* Lista não ordenada
* Item não ordenado 2
** Subitem não ordenado

# Lista ordenada
# Item pedido 2
## sub-item solicitado

; Termo: Isso é chamado de "lista de definição". É usado ao definir vários termos.

Se você precisar citar uma parte do texto de outro site, use <tt> <nowiki> <blockquote> </ nowiki> </ tt> da seguinte forma:
<blockquote>
Wikipedia (ˌwɪkɨˈpiːdiə / ou wɪkiˈpiːdiə / wik-i-pee-dee-ə) é um acesso livre, multilingue, editado e colaborativo,
enciclopédia de conteúdo livre na Internet que é suportada e hospedada pela Fundação Wikimedia sem fins lucrativos. Voluntários
em todo o mundo colaborativamente escrever 30 milhões de artigos da Wikipedia em 287 idiomas, incluindo mais de 4,5 milhões no
Wikipédia em inglês. Qualquer pessoa que possa acessar o site pode editar quase todos os seus artigos, que na Internet
compreende [4] o maior e mais popular trabalho de referência geral. [5] [6] [7] [8] [9] Em fevereiro de 2014, The New York
Times informou que a Wikipedia está em quinto lugar mundial entre todos os sites, afirmando: "Com 18 bilhões de page views
e quase 500 milhões de visitantes únicos por mês ..., a Wikipédia encalça apenas Yahoo, Facebook, Microsoft e Google,
o maior com 1,2 bilhão de visitantes únicos."[10]
</blockquote>


Exibindo código fonte

Para exibir o código-fonte, use o template FILE, especificando a linguagem de programação via parâmetro lang=:

Exemplo python

{{file|name=foobar|lang=python|desc=foobarosity|body=
import system
}}


Este exemplo produz a seguinte saída:

   foobar (python source code) - foobarosity
import system


Exemplo Perl

{{file|name=hello_world.pl|lang=perl|desc=Hello World in Perl|body=
print "Hello World\n";
}}


Este exemplo produz a seguinte saída:

   hello_world.pl (perl source code) - Hello World in Perl
print "Hello World\n";


OBS: Os parametros name (filename), lang (linguagem para realce de sintaxe) e desc (Descrição, aparecendo como legenda) são opcionais.


   Nota:

Até o momento, suportamos em nossa wiki as seguintes linguagens de programação e marcações: ActionScript * Ada * ANTLR * AppleScript * Assembly * Asymptote * Awk * Befunge * Boo * BrainFuck * C / C++ * C# * Clojure * offeeScript * ColdFusion * Common Lisp * Coq * Cryptol * Crystal * Cython * D * Dart * Delphi * Dylan * Elm * Erlang * Ezhil * Factor * Fancy * Fortran * F# * GAP * Gherkin (Cucumber) * GL shaders * Groovy * Haskell * IDL * Io * Java * JavaScript * Lasso * LLVM * Logtalk * Lua * Matlab * MiniD * Modelica * Modula-2 * MuPad * Nemerle * Nimrod * Objective-C * Objective-J * Octave * OCaml * PHP * Perl * PovRay * PostScript * PowerShell * Prolog * Python 2.x and 3.x * REBOL * Red * Redcode * Ruby * Rust * S, S-Plus and R * Scala * Scheme * Scilab * Smalltalk * SNOBOL * Tcl * Vala * Verilog * VHDL * Visual Basic.NET * Visual FoxPro * XQuery * Zephir * Apache config files * Bash shell scripts * BBCode * CMake * CSS * Diff files * DTD * Gettext catalogs * Gnuplot script * Groff markup * HTML * HTTP sessions * INI-style config files * IRC logs (irssi style) * Lighttpd config files * Makefiles * MoinMoin/Trac Wiki markup * MySQL * Nginx config files * POV-Ray scenes * Ragel * Redcode * ReST * Robot Framework * RPM spec files * SQL * Squid configuration * TeX * tcsh * Vim Script * Windows batch files * XML * XSLT * YAML * Cheetah templates * Django / Jinja templates * ERB * Genshi * JSP * Myghty * Mako * Smarty templates * Tea


Exibição do caractere pipe em nossa wiki

   Importante:

Se você precisar exibir um pipe ("|") dentro do campo do tipo arquivo ou console, substitua cada "|" (pipe) por {{!}} -- Caso contrário, o conteúdo do arquivo não será exibido corretamente. Isso é necessário porque {{file}} é um template e o caractere pipe ("|") é usado como um delimitador de argumentos para o template.


Exibindo o conteúdo do arquivo de texto ou de configuração

Para exibir o conteúdo de arquivos de texto em linguagem que não sejam de programação (como arquivos de configuração), você tem duas opções. Você pode colocar suas linhas dentro de tags <pre>, ou usar o novo file template. O template FILE é usado assim:

{{file|name=/etc/foo.conf|desc=My foo.conf file|body=
# /etc/host.conf:
# $Header: /var/cvsroot/gentoo/src/patchsets/glibc/extra/etc/host.conf,v 1.1 2006/09/29
}}


Este exemplo produz a seguinte saída:

   /etc/foo.conf - My foo.conf file
# /etc/host.conf:
# $Header: /var/cvsroot/gentoo/src/patchsets/glibc/extra/etc/host.conf,v 1.1 2006/09/29

Console

Para exibir a saída do console, use o template {{console}}:


Comandos como usuário root:

{{console|body=
###i## run a command as root
}}


Este exemplo produz a seguinte saída:

# run a command as root



Para um console não-root:

{{console|body=
$ ##i##run a command as user
}}


Este exemplo produz a seguinte saída:

$ run a command as user
   Importante:

Note que nós usamos um # prompt para root e o $ prompt para denotar um usuário não-root.

   Importante:

A tag de texto ##i## marca o resto da linha como sendo "entrada do usuário" ("i" é para "entrada"). Em seguida, é destacado em uma cor perceptível, de modo que se destaca do texto que não é digitado pelo usuário.

Se você precisar finalizar o destaque da entrada do usuário antes do final de uma linha, use ##!i## para marcar o final da área realçada.

As seguintes sequências especiais de caracteres também estão disponíveis:

  • ##g## - Verde
  • ##y## - Amarelo
  • ##bl## - Azul
  • ##r## - Vermelho
  • ##b## - Negrito


Por favor, use as opções de coloração acima com moderação. Às vezes é bom usá-los para obter a saída do console do wiki para corresponder às cores exibidas em um console do Linux. Observe também que, para cada cor acima, há uma opção de correspondência ##!(colorcode)## para desligar a cor antes do final da linha.

Aqui está um exemplo de seu uso:

# bluetoothctl 
[NEW] Controller 00:02:72:C9:62:65 antec [default]
[bluetooth]# power on
Changing power on succeeded
[bluetooth]# agent on
Agent registered
[bluetooth]# scan on
Discovery started
[bluetooth]# devices
Device 00:1F:20:3D:1E:75 Logitech K760
[bluetooth]# pair 00:1F:20:3D:1E:75
Attempting to pair with 00:1F:20:3D:1E:75
[CHG] Device 00:1F:20:3D:1E:75 Connected: yes
[agent] Passkey: 454358
[agent] Passkey: 454358
[agent] Passkey: 454358
[agent] Passkey: 454358
[agent] Passkey: 454358
[agent] Passkey: 454358
[agent] Passkey: 454358
[CHG] Device 00:1F:20:3D:1E:75 Paired: yes
Pairing successful
[CHG] Device 00:1F:20:3D:1E:75 Connected: no
[bluetooth]# connect 00:1F:20:3D:1E:75
Attempting to connect to 00:1F:20:3D:1E:75
[CHG] Device 00:1F:20:3D:1E:75 Connected: yes
Connection successful
[bluetooth]# quit
[DEL] Controller 00:02:72:C9:62:65 antec [default]
#

Mensagens informativas

Notas, avisos, dicas e modelos importantes podem ser usados para mensagens informativas que precisam ser deslocadas do fluxo de texto regular:

{{note|Isso é uma nota}}
   Nota:

Isso é uma nota

{{important|Isso é importante}}
   Importante:

Isso é importante

{{warning|Isso é um alerta}}
   Atenção:

Isso é um alerta

{{tip|Isso é uma dica}}
   Dica:

Isso é uma dica

Observe que esses templates costumavam ser chamadosfancynote, fancytip, etc. Os "fancy" foram descontinuados, mas continuarão a ser suportados no futuro previsível.


Kernelop

Para exibir as opções de configuração do kernel, nós encorajamos você a usar o template kernelop. Para usar o template kernelop, crie uma entrada semelhante ao exemplo a seguir:

{{kernelop|title=foo,bar|desc=
kernel options pasted from "make menuconfig"
}} 
   Nota:

O kernel é de cor azul para lembrar ligeiramente o fundo azulado do make menuconfig.

Adicionar esta entrada lhe dará a seguinte saída: Under foo-->bar:

kernel options

Aqui está um exemplo mais concreto: Under File systems:

<M> Second extended fs support          
[ ]   Ext2 extended attributes          
[ ]   Ext2 execute in place support     
<M> Ext3 journalling file system support


Código Inline

Para enfatizar comandos e outros jargões técnicos quando aparecem em linha em um parágrafo, use o template {{c}}. Ao referenciar arquivos, use o template {{f}}.

The {{f|/etc/fstab}} O arquivo é importante. Outro arquivo importante é {{f|/boot/grub/grub.cfg}}. O comando {{c|emerge}} é realmente bacana.

Este exemplo produz a seguinte saída:

The /etc/fstab O arquivo é importante. Outro arquivo importante é /boot/grub/grub.cfg. O comando emerge é realmente bacana.

   Importante:

A tag <tt> foi descontinuada para fins de codificação de código embutido, para estar em conformidade com HTML5 e o uso anterior da tag <code> é desencorajado. É mais fácil usar o template {{c}}.


Frames

Para incluir outras páginas externas, utilize o widget IFRAME. Crie uma entrada semelhante ao exemplo a seguir:

{{#widget:Iframe
|url=https://www.google.com/calendar/embed?src=agenda%40area31.net.br&ctz=America/Sao_Paulo
|width=400
|height=300
|border=0
}}



Este exemplo produz a seguinte saída:



Tabelas

Em vez de usar o wikitexto tradicional da tabela do MediaWiki, use o seguinte formato:

{{TableStart}}
<tr class="info"><th>Header 1</th><th>Header 2</th></tr>
<tr><td>Value 1</td><td>Value 2</td></tr>
<tr><td>Value 3</td><td>Value 4</td></tr>
{{TableEnd}}

Isso renderizará da seguinte maneira:

Header 1Header 2
Value 1Value 2
Value 3Value 4

Algumas macros auxiliares estão agora disponíveis, o que facilita a definição de tabelas de duas e três colunas. Use 2Col para linha normal de duas colunas, 2ColHead para cabeçalho de 2 colunas e3Col para linha de 3 colunas e 3ColHead para cabeçalho de 3 colunas:

{{TableStart}}
{{2ColHead|Sub-Profile|Description}}
{{2Col|{{c|arch}}|One arch profile is enabled, at build time, and is not changed. This defines CPU architecture-specific settings.}}
{{2Col|{{c|subarch}}|One subarch profile is typically enabled at build time, and defines the CPU optimizations in use.}}
{{2Col|{{c|build}}|One build profile is enabled, at build time, and is generally not changed. It defines the type of build, such as {{c|current}} or {{c|stable}}, and associated settings.}}
{{2Col|{{c|flavor}}|One flavor is enabled per system, and can be changed by the user. This defines the general use of the system, such as {{c|minimal}}, {{c|core}}, {{c|workstation}} or {{c|desktop}}}}
{{2Col|{{c|mix-ins}}|Zero or more mix-ins can be enabled that enable settings specific to a particular subset of features, such as {{c|gnome}}, {{c|kde}}, {{c|media}}, {{c|mate}}, {{c|X}}, {{c|hardened}}.}}
{{TableEnd}}

Qual é o seguinte:

Sub-ProfileDescription
archOne arch profile is enabled, at build time, and is not changed. This defines CPU architecture-specific settings.
subarchOne subarch profile is typically enabled at build time, and defines the CPU optimizations in use.
buildOne build profile is enabled, at build time, and is generally not changed. It defines the type of build, such as current or stable, and associated settings.
flavorOne flavor is enabled per system, and can be changed by the user. This defines the general use of the system, such as minimal, core, workstation or desktop
mix-insZero or more mix-ins can be enabled that enable settings specific to a particular subset of features, such as gnome, kde, media, mate, X, hardened.


   Dica:

Essa sintaxe de tabela tem um benefício adicional de criar uma tabela responsiva que renderiza adequadamente em dispositivos móveis.

É possível usar as seguintes classes CSS com tr (linhas) e td/th elementos para colori-los como desejado:


Class Name
success
info
warning
active
danger



Tipos de edições

Antes de começarmos, vamos analisar quais alterações podem ser feitas e quais mudanças não são bem vindas:

Tipos de mudançaPode ser feito?
Correções de gramática / ortografiaSim
Novo artigo na wikiSolicite autorização de um membro fundador
Novo projeto oficialSolicite autorização de um membro fundador
Adicionar informação a um artigo existenteSolicite autorização ao autor do artigo
Adicionando informações ausentes / incompletasSim
Efetuar correçõesSim
Adicionando soluções para problemas enfrentadosNUNCA!!! Sempre discuta qualquer alteração crítica com finalidade de resolução de problemas com um membro fundador


   Importante:

Observe que, se você tiver algum problema com as documentações oficiais, a ação correta não é adicionar uma solução alternativa à nossa documentação, mas "discutir sempre com um membro fundador". Isso é importante porque o problema que você experimentou pode ser um bug legítimo e a solução pode ser corrigir o erro em vez de adicionar uma solução alternativa à nossa documentação. Podemos acabar consertando um bug, consertando a documentação ou possivelmente ambos. Cada caso é um caso.