Raul Hacker Club

Editar

Como contribuir com o Site do RaulHC

Wiki = colaborção

Todo o nosso site é um wiki (mesmo que não pareça), um wiki estruturado (significa que podemos fazer aplicações manipulando dados) baseado no Foswiki.

O que é um Wiki

Wiki é uma página web ou (wiki de uma página só está em desuso) site web editável sob uma notação simples o suficiente para ser dominada por qualquer usuário e humanamente legível mesmo na forma de código. Além disso wikis mantém o histórico de versões o que nos permite saber quem fez o que e quando; permite ver a evolução do conteúdo; permite a edição sem medo, já que basta desfazer o erro, caso ocorra.

Veja como é simples editar:

Exemplo de sintaxe do Foswiki

"Take some more [[tea]]," the March Hare said to Alice, very earnestly.

"I've had *nothing* yet," Alice replied in an offended tone, "so I can't take more."

"You mean you can't take _less_?" said the Hatter. "It's very easy to take _more_ than nothing."

HTML Equivalente

<p>"Take some more <a href="Tea">tea</a>," the March Hare said to Alice, very earnestly.</p>

<p>"I've had <strong>nothing</strong> yet," Alice replied in an offended tone, "so I can't take more."</p>

<p>"You mean you can't take <em>less</em>?" said the Hatter. "It's very easy to take <em>more</em> than nothing."</p>

Resultado

"Take some more tea," the March Hare said to Alice, very earnestly.

"I've had nothing yet," Alice replied in an offended tone, "so I can't take more."

"You mean you can't take less?" said the Hatter. "It's very easy to take more than nothing."

Leia "Regras de Formatação" para saber mais detalhes, mas antes é bom ler "Hipertextualidade" sobre como criar e linkar páginas.

Como editar páginas do site do RaulHC

Para contribuir com este wiki, registre-se e então você poderá logar e clicar nos botões editar no topo e no rodapé das páginas.

Algumas páginas são restritas, para reduzir o risco de vandalismo ou de bem intencionados sem habilidade para certas páginas que implementam funcionalidades críticas ou complexas. Caso você queira editar uma dessas páginas, peça na lista para entrar no RaulGroup.

Existem outros detalhes da cultura wiki, que fariam esse texto ficar enorme, então, tente seguir o padrão de escrita e formatação que você encontrou no resto da documentação e use o bom senso.

A estrutura deste site

O site do RaulHC usa o conceito de webs do Foswiki para separar tipos de informação e sites independentes. Webs são diretórios de páginas, que além de separá-las, ajudando na organização, também provem configuração própria, podendo ter restrições de acesso diferenciada, macros independentes e identidade visual própria.

Webs que temos hoje:
  • Agenda – Eventos no clube, do clube e de interesse do clube.
  • Doc – Documentação do Raul Hacker Club
  • LampiaoSec – Site do grupo de estudos em segurança mantido por membros do RaulHC.
  • Main – Web do sistema, para gestão de usuários e configurações globais.
  • Projetos – Projetos do Raul Hacker Club
  • Sandbox – Sandbox test area to experiment in an unrestricted hands-on web.
  • System – Discover the details, and how to start your own site with Foswiki - The Free and Open Source Wiki.
  • WebSnippets – Pequenos experimentos com tecnologia web.

Em outras documentações você poderá ver a palavra "tópico" sendo usada no lugar de "página". Os conceitos são muito próximos, mas para ser mais simples, essa documentação usa a palavra "página", mesmo sendo menos exata em uma analise mais profunda, mas é mais inteligível.
Dentro de cada uma dessas webs existe uma coleção de páginas que respeita as configurações da web, definidas na página WebPreferences. Essas páginas referenciar e "consumir" conteúdos de páginas em outras webs.

Sabendo que toda página está dentro de uma web, ao visitar http://raulhc.cc/Casa/Banheiro, você pode entender que Casa é a web e Banheiro é a página. Também existem as sub-webs, tão podemos encontrar algo do tipo http://raulhc.cc/Casa/SegundoAndar/Banheiro, ou mesmo com mais níveis de aninhamento.

As webs Agenda e Projetos fazem uso extensivo de dados estruturados, por meio de data forms dentro de páginas. Esses dados estruturados geram conteúdo dinâmico, como as listagens filtráveis na home dos projetos e o calendário de eventos na home do site. Além disso a própria existência do data form em uma página permite dar-lhe identidade visual própria, o que fizemos foi colocar uns detalhes a mais de informação específica em cada página de evento e projeto, sem que seja necessário escrever aquele conteúdo padronizado no corpo do texto.

Hipertextualidade

Hipertexto é o texto que aponta outros conteúdos através de referências de acesso direto, por exemplo, os links da web. Por isso HTML dignamente significa Hypertext Markup Language.

É da natureza dos Wikis promover a hipertextualidade. Enquanto em HTML é preciso escrever <a href="OutraPágina">Outra Página</a>, no Foswiki basta [[OutraPágina][Outra Página]], ou mesmo [[Outra Página]], ou simplesmente coloque OutraPágina no meio do texto e ele se tornará um link.

Como assim?
Quando você escreve uma WikiWord (duas ou mais palavras, unidas e com iniciais maiúsculas), o wiki subentende que você está fazendo uma referência a outra página desta mesma web, então ele automaticamente faz desta palavra um link, no modo de visualização.

Porque?
Por convenção todo nome de página deve ser uma WikiWord, isso reduz a complexidade da busca por referências e a necessidade de se usar notações para hipertextualidade.

E se a página não existir?
Então um link em vermelho é criado e clicando nele você é enviado para o modo de edição desta nova página. Você já deve ter visto links vermelhos na Wikipédia. O funcionamento é idêntico.

E se eu não quiser que as palavras fiquem coladas no texto? Nem com maiúsculas!
Basta usar a notação do duplo colchete: [[outra página]] linka para OutraPágina.

E se eu quiser que o texto do link seja diferente do nome da página?
Existe uma notação de colchetes mais avançada: [[OutraPágina][leia outro texto]].

E se eu quiser apontar para uma página de outra web?
Basta colocar o nome da web antes, com um ponto, usando colchetes ou não: OutraWeb.OutraPágina ou [[OutraWeb.OutraPágina][leia outro texto]].

E se eu quiser apontar para uma página de outro site?
Simples: [[http://outrosite.net/página][leia outro texto]].
É importante colocar o protocolo, ou o link não será feito corretamente. Isso vale para links para e-mails: [[mailto:alguem@raulhc.cc][meu e-mail]].

E se eu a palavra (sigla, marca,...) é, por acaso, uma WikiWord e eu não quiser o link?
Coloque uma exclamação antes ou um <nop>: !RaulHC ou <nop>RaulHC é WikiWord, mas não se tornará link.

ATENÇÂO: Tenha cuidado ao criar nomes de páginas. Antes de tudo elas devem ter significado, ao mesmo tempo você não deve fazer uma frase. Tente equilibrar algum significado com uso reduzido de palavras. Ao usar a notação de link avançada, não use o texto "clique aqui" ou coisas do gênero, desconexas do significado daquilo que você aponta. "Clique aqui" não é bom e atrapalha os negócios e a acessibilidade.

Então, você não tem mais desculpas para fazer um texto sem links. Hipertextualidade é vida! wink

Sim, existem mais tecnicidades a saber sobre links, mas se vc quer ir mais fundo, leia as regras de formatação.

Enviando Arquivos

TODO... Você pode ler o tópico simples e direto "Use your browser to upload files as page attachments", no tutorial de introdução oficial. Veja mais detalhes na documentação sobre arquivos anexos.

Regras de Formatação

Usando as notações abaixo (conhecida como Shorthand) o código da página será legível por qualquer um, mesmo por quem não entende o significado dos asteriscos, colchetes e outros caracteres de notação que estejam permeando o texto. Assim qualquer um poderá contribuir ao menos corrigindo frases, atualizando descrições e estendendo o conteúdo.

As notações abaixo são diretamente convertidas para HTML, e o que não se encaixar com nenhuma delas não será transformado, portanto, é possível mesclar código HTML ao código Shorthand, para usos avançados. Você pode ver isso em algumas páginas deste site (por exemplo na agenda), para desenvolver novos recursos ou para usar propriedades rebuscadas do HTML que não seja possível representar com notações simplificadas como a Shorthand.

Formatting Command: You write: You get:
Paragraphs:
Blank lines will create new paragraphs.
1st paragraph

2nd paragraph

1st paragraph

2nd paragraph
Headings:
Three or more dashes at the beginning of a line, followed by plus signs and the heading text. One plus creates a top level heading, two pluses a second level heading, etc. The maximum heading depth is 6.

You can create a table of contents with the %TOC% macro. If you want to exclude a heading from the TOC, put !! after the ---+.

ALERT! Empty headings are allowed, but won't appear in the table of contents.
---++ Sushi
---+++ Maguro
---+++!! Not in TOC

Sushi

Maguro

Not in TOC

Bold Text:
Words get shown in bold by enclosing them in * asterisks.
*Bold*

Bold
Italic Text:
Words get shown in italic by enclosing them in _ underscores.
_Italic_

Italic
Bold Italic:
Words get shown in bold italic by enclosing them in __ double-underscores.
__Bold italic__

Bold italic
Fixed Font:
Words get shown in fixed font by enclosing them in = equal signs.
=Fixed font=

Fixed font

Bold Fixed Font:
Words get shown in bold fixed font by enclosing them in double equal signs.
==Bold fixed==

Bold fixed
TIP You can follow the closing bold, italic, or other (* _ __ = ==) indicator with normal punctuation, such as commas and full stops.

ALERT! Make sure there is no space between the text and the indicators.
_This works_,
_this does not _

This works,
_this does not _
Verbatim (Literal) Text:
Surround code excerpts and other formatted text with <verbatim> and </verbatim> tags.

TIP verbatim tags disable HTML code. Use <pre> and </pre> tags instead if you want the HTML code within the tags to be interpreted.

ALERT! Preferences settings (* Set NAME = value) are set within verbatim tags.
<verbatim>
class CatAnimal {
  void purr() {
    <code here>
  }
}
</verbatim>
class CatAnimal {
  void purr() {
    <code here>
  }
}
Verbatim (Literal) Code Highlighting:
Surround code excerpts and other formatted text e.g. with <verbatim class="bash"> and </verbatim> tags.

IDEA! This type of code highlighting is based on Chili - the jQuery code highlighter plugin. Please find supported class attributes in JQueryChili.

TIP verbatim tags disable HTML code. Use <pre class="bash"> and </pre> tags instead if you want the HTML code within the tags to be interpreted.

ALERT! Preferences settings (* Set NAME = value) are set within verbatim tags.
<verbatim class="bash">
#!/bin/bash
while [ -n "$(ls . ~/ \
~/pub* /var/www 2>/dev/null \
| fgrep foswiki )" ] ; do
 clear
 printf "\nFoswiki rules!\n"
 sleep 10
 clear
 printf "\nFoswiki still rules!\n"
 sleep 10
done; exit 0
</verbatim>
#!/bin/bash
while [ -n "$(ls . ~/ \
~/pub* /var/www 2>/dev/null \
| fgrep foswiki )" ] ; do
 clear
 printf "\nFoswiki rules!\n"
 sleep 10
 clear
 printf "\nFoswiki still rules!\n"
 sleep 10
done; exit 0

Separator (Horizontal Rule):
Three or more three dashes at the beginning of a line..
---


Bulleted List:
Multiple of three spaces, an asterisk, and another space.

HELP For all the list types, you can break a list item over several lines by indenting lines after the first one by at least 3 spaces.
   * level 1
      * level 2
   * back on 1
   * A bullet
     broken over
     three lines
   * last bullet

  • level 1
    • level 2
  • back on 1
  • A bullet broken over three lines
  • last bullet
Numbered List:
Multiple of three spaces, a type character, a dot, and another space. Several types are available besides a number:
Type Generated Style Sample Sequence
1. Arabic numerals 1, 2, 3, 4...
A. Uppercase letters A, B, C, D...
a. Lowercase letters a, b, c, d...
I. Uppercase Roman Numerals I, II, III, IV...
i. Lowercase Roman Numerals i, ii, iii, iv...
   1. Sushi
   1. Dim Sum
   1. Fondue

   A. Sushi
   A. Dim Sum
   A. Fondue

   i. Sushi
   i. Dim Sum
   i. Fondue

  1. Sushi
  2. Dim Sum
  3. Fondue

  1. Sushi
  2. Dim Sum
  3. Fondue

  1. Sushi
  2. Dim Sum
  3. Fondue
Definition List:
Three spaces, a dollar sign, the term, a colon, a space, followed by the definition.
   $ Sushi: Japan
   $ Dim Sum: S.F.

Sushi
Japan
Dim Sum
S.F.
Definition List: (deprecated)
Three spaces, the term (a single word, no spaces), a colon, a space, followed by the definition.
   Sushi: Japan
   Dim-Sum: S.F.

Sushi
Japan
Dim-Sum
S.F.
Table:
Each row of the table is a line containing of one or more cells. Each cell starts and ends with a vertical bar '|'. Any spaces at the beginning of a line are ignored.
  • | *bold* | header cell with text in asterisks
  • |   center-aligned   | cell with at least two, and equal number of spaces on either side
  • |      right-aligned | cell with more spaces on the left
  • | 2 colspan || and multi-span columns with multiple |'s right next to each other
  • |^| cell with caret indicating follow-up row of multi-span rows
  • You can split rows over multiple lines by putting a backslash '\' at the end of each line
  • Contents of table cells wrap automatically as determined by the browser
  • Use %VBAR% or &#124; to add | characters in tables.
  • Use %CARET% or &#94; to add ^ characters in tables.
TIP The TablePlugin provides the |^| multiple-span row functionality and additional rendering features
| *L* | *C* | *R* |
| A2 |  B2  |  C2 |
  | A3 |  B3  |  C3 |
| multi span |||
| A5-7 |  5  |  5 |
|^| six | six |
|^| seven | seven |
| split\
  | over\
  | 3 lines |
| A9 |  B9  |  C9 |
| %CARET% | B10 |%VBAR%|
| &#94; | B11 |&#124;|

L C R
A2 B2 C2
A3 B3 C3
multi span
A5-7 5 5
six six
seven seven
split over 3 lines
A9 B9 C9
^ B10 |
^ B11 |
WikiWord Links:
CapitalizedWordsStuckTogether (or WikiWords) will produce a link automatically if preceded by whitespace or parenthesis.
TIP If you want to link to a topic in a different web write Otherweb.TopicName.
To link to a topic in a subweb write Otherweb.Subweb.TopicName.
HELP The link label excludes the name of the web, e.g. only the topic name is shown. As an exception, the name of the web is shown for the WebHome topic.
ALERT! Dots '.' are used to separate webs and subwebs from topic names and therefore cannot be used in topic names.

It's generally a good idea to use the macros %SYSTEMWEB%, %SANDBOXWEB% and %USERSWEB% instead of System, Sandbox and Main.
%STATISTICSTOPIC%

%SANDBOXWEB%.WebNotify

%SANDBOXWEB%.WebHome

%SANDBOXWEB%.Subweb.TopicName

WebStatistics

WebNotify

Sandbox

TopicName
Acronym Links:
Words that are all capitals will produce a link automatically only if the topic already exists!.
ACRONYM

%SYSTEMWEB%.ACRONYM

ACRONYM

ACRONYM
Anchors:
You can define a reference inside a topic (called an anchor name) and link to that. To define an anchor write #AnchorName at the beginning of a line. The anchor name must be a WikiWord of no more than 32 characters. To link to an anchor name use the [[MyTopic#MyAnchor]] syntax. You can omit the topic name if you want to link within the same topic.
[[WikiWord#NotThere]]

[[#MyAnchor][Jump]]

#MyAnchor To here

WikiWord#NotThere

Jump

To here
Forced Links:
You can create a forced internal link by enclosing words in double square brackets.
Text within the brackets may contain optional spaces; the topic name is formed by capitalizing the initial letter and by removing the spaces; for example, [[wiki syntax]] links to topic WikiSyntax. You can also refer to a different web and use anchors.
TIP To "escape" double square brackets that would otherwise make a link, prefix the leading left square bracket with an exclamation point.
[[System.wiki syntax][wiki syntax]]

[[Main.Wiki groups]]

escaped:
![[System.wiki syntax][wiki syntax]]

wiki syntax

Main.Wiki groups

escaped: [[System.wiki syntax][wiki syntax]]
Specific Links:
You can create a link where you specify the link text and the URL separately using nested square brackets [[reference][text]]. Internal link references (e.g. WikiSyntax) and URLs (e.g. http://foswiki.org/) are both supported. The rules described under Forced Links apply for internal link references.
TIP Anchor names can be added as well, to create a link to a specific place in a topic.
[[WikiSyntax][wiki syntax]]

[[http://gnu.org][GNU]]

wiki syntax

GNU
Prevent a Link:
Prevent a WikiWord from being linked by prepending it with an exclamation point.
!SunOS
SunOS
Disable Links:
You can disable automatic linking of WikiWords by surrounding text with <noautolink> and </noautolink> tags.
HELP It is possible to turn off all auto-linking with a NOAUTOLINK preference setting.
 <noautolink>
 RedHat & SuSE
 </noautolink>

RedHat & SuSE
Mailto Links:
E-mail addresses are linked automatically. To create e-mail links that have more descriptive link text, specify subject lines or message bodies, or omit the e-mail address, you can write [[mailto:user@domain][descriptive text]].
a@b.com

[[mailto:a@b.com][Mail]]

[[mailto:?subject=Hi][Hi]]

a@b.com

Mail

Hi
Literal content:
Foswiki generates HTML code from TML shorthand. Experts surround anything that must be output literally in the HTML code, without the application of shorthand rules, with <literal>..</literal> tags.
ALERT! Any HTML within literal tags must be well formed i.e. all tags must be properly closed before the end of the literal block.
IDEA! Macros are expanded within literal blocks.
<literal>
| Not | A | Table |
</literal>
| Not | A | Table |
Protected content:
Experts protect text from mangling by WYSIWYG editors using <sticky>..</sticky> tags. Sticky tags don't have any effect on normal topic display; they are only relevant when content has to be protected from a WYSIWYG editor (usually because it isn't well-formed HTML, or because it is HTML that WYSIWYG would normally filter out or modify). Protected content appears as plain text in the WYSIWYG editor.
ALERT! Any HTML within sticky tags must be well formed i.e. all tags must be properly closed before the end of the sticky block.
IDEA! Macros are expanded within sticky blocks.
<sticky>
<div>
This div 
%RED%is%ENDCOLOR%
required
</div>
</sticky>

This div is required

Macros

TODO... Veja a documentação oficial sobre as macros padrão.

Plugins instalados

Conheça as funcionalidades que adicionamos para ir além do wiki padrão.
  • SpreadSheetPlugin (1.1.7, v1.1.7): Add spreadsheet calculations like "$SUM($ABOVE())" to Foswiki tables and other topic text
  • AttachmentListPlugin (1.5.0, $Rev: 12366 (2011-08-24) $): Displays a formattable list of topic attachments - from any topic - anywhere in a topic
  • AutoTemplatePlugin (2.01, $Rev: 12383 (2011-08-25) $): Automatically sets VIEW_TEMPLATE and EDIT_TEMPLATE
  • AvatarPlugin (1.0.0, $Rev: 11875 (2011-06-08) $): embed Avatars into foswiki
  • CommentPlugin (1.1.6, v1.1.6): Quickly post comments to a page without an edit/save cycle
  • CompareRevisionsAddonPlugin (1.1.11, v1.1.11):
  • DBCachePlugin (5.45, 5.45): Lightweighted frontend to the DBCacheContrib
  • DateTimePlugin (1.2, 4740): Display date and time with formatting options, relative date parameters and localized dates
  • EditTablePlugin (4.43, 4.43): Edit tables using edit fields, date pickers and drop down boxes
  • FilterPlugin (4.00, 4.00): Substitute and extract information from content by using regular expressions
  • FlexFormPlugin (2.81, 2.81): Flexible way to render DataForms
  • ForEachPlugin (1.102, $Rev: 10382 (2010-12-22) $): Loop over successive elements of a list, or a range of numbers.
  • HistoryPlugin (1.11, 1.11): Shows a complete history of a topic
  • HttpHeaderPlugin (1.0, $Rev: 9285 (2010-09-21) $): Add additional lines to the HTTP header of a page.
  • ImageGalleryPlugin (6.11, 6.11): Displays image gallery with auto-generated thumbnails from attachments
  • InterwikiPlugin (1.1.7, v1.1.7): Link ExternalSite:Page text to external sites based on aliases defined in a rules topic
  • JQueryPlugin (4.91, 4.91): jQuery JavaScript library for Foswiki
  • MailerContribPlugin (2.5.3, v2.5.3): Supports e-mail notification of changes
  • MimeIconPlugin (1.20, 1.20): Icon sets for mimetypes
  • NatEditPlugin (07 Aug 2013, 7.10): A Wikiwyg Editor
  • NatSkinPlugin (3.99_007, 3.99_007): Support plugin for NatSkin
  • PreferencesPlugin (1.1.5, v1.1.5): Allows editing of preferences using fields predefined in a form
  • RenderListPlugin (2.2.7, v2.2.7): Render bullet lists in a variety of formats
  • RenderPlugin (3.21, 3.21): Render WikiApplications asynchronously
  • SandboxPlugin (1.1.7, $Rev: 1 (2014-07-08) $): Perl Sandbox for advanced wiki apps
  • SlideShowPlugin (2.1.6, v2.1.6): Create web based presentations based on topics with headings
  • SmiliesPlugin (28 Nov 2012, v1.1.6): Render smilies like smile as icons
  • TablePlugin (1.142, 1.142): Control attributes of tables and sorting of table columns
  • TemGentePlugin (0.0.1, 0.0.1): Only include the "tem-gente" json by now.
  • TinyMCEPlugin (1.2.9, v1.2.9): Integration of the Tiny MCE WYSIWYG Editor
  • TopicInteractionPlugin (3.51, 3.51): Improved interaction with attachments and DataForms
  • TwistyPlugin (1.6.18, v1.6.18): Twisty section Javascript library to open/close content dynamically
  • WysiwygPlugin (16 May 2013, v1.1.16): Translator framework for WYSIWYG editors

logue para testar


Você está em RaulHCComoParticiparEditeNossoSite
Histórico: r3 < r2 < r1 — última revisão em 26 Jun 2015, por Aurélio