Wikilivros:Nomenclaturas

Origem: Wikilivros, livros abertos por um mundo aberto.
Ir para: navegação, pesquisa

Ao comparar os diversos livros de uma biblioteca, é possível identificar alguns elementos que estão presentes em todos eles, indiferente do assunto abordado. Em geral um livro possui:

  • Uma capa
  • Um prefácio ou uma introdução
  • Um índice
  • Vários capítulos
  • Uma página com a bibliografia

Os textos didáticos que figuram no Wikilivros também devem compartilhar uma estrutura comum, para evitar que este projecto se desorganize. Deste modo, fica mais fácil para os leitores chegarem até determinado conteúdo, e também para fazer a leitura contínua das páginas que compõe certo livro.

Neste módulo são apresentadas as convenções que ajudam a manter o projeto organizado.

A organização de um wikilivro[editar código-fonte]

Ao contrário do que ocorre em uma enciclopédia (como a Wikipédia), as diversas páginas de um livro devem estar em sintonia umas com as outras, pois todas falam sobre um mesmo tema. Como há vários livros no Wikilivros (cerca de 507), é necessário permitir que um leitor consiga saber quais páginas do projeto são de um livro, e quais são de outro. O software usado no Wikilivros, o MediaWiki, fornece duas formas muito eficientes de dar a cada trabalho sua própria identidade, fazendo com que suas páginas não se misturem com as de outros textos:

  1. O uso de subpáginas
  2. A colocação de categorias

O uso de subpáginas[editar código-fonte]

Nesta seção é explicado como se deve utilizar o recurso de subpáginas para organizar um wikilivro. Para conhecer os motivos que levaram a adoção desta estrutura, pode-se consultar algumas das discussões que ocorreram sobre o assunto, como esta.

Para ter um exemplo em mente, imagine que se pretende escrever um livro hipotético que terá as seguintes páginas:

  • Capa
  • Prefácio
  • Índice
  • Introdução
  • Capítulo 1
  • Capítulo 2
  • Capítulo 3
  • Bibliografia

Antes de criar páginas e subpáginas para abrigar estes tópicos, o primeiro passo é escolher bem o nome do livro, e também o de cada capítulo. É sempre recomendável utilizar um título simples e descritivo, em vez de expressões pouco esclarecedoras (como "Capítulo 1"), ou abrangentes demais (como "Ciência"), ou mesmo exageradas (como "Tudo sobre Isto" e "Manual completo sobre aquilo"). Utilize o bom senso, e leve em consideração que dependendo do título escolhido, os leitores podem ou não encontrar o seu trabalho, e no futuro outros editores podem ou não ter interesse em melhorar o material que você produzir. Lembre-se que esta é uma wiki. Recomenda-se também que não se utilizem subtítulos e siglas no título: os subtítulos apenas deixam o nome dos módulos muito grande, enquanto as siglas podem deixar o título incompreensível para a maioria dos leitores.

O uso de páginas e subpáginas para organizar os livros do projeto é bem simples. Todas as páginas de conteúdo de um livro (também chamadas de módulos), devem ter um título em um dos seguintes formatos:

  • Nome do livro
  • Nome do livro/Nome da página do livro

A primeira opção só deve ser usada na página do livro onde será colocado o seu índice. O título de todas as outras páginas do livro deve ser como no segundo caso, onde há o nome do livro seguido de uma barra "/" e depois um nome para a página propriamente dita. No caso de um livro muito extenso, pode-se separar o "Nome da página do livro" em duas partes usando mais uma barra, resultando em

  • Nome do livro/Primeira parte do nome da página do livro/Segunda parte do nome da página do livro

Como se pode ver, se for usado mais de uma barra, o título completo pode ficar muito comprido. Por isso, só use várias barras se for realmente muito importante ressaltar a hierarquia entre as páginas do seu livro, caso contrário acabará criando um livro cheio de páginas, mas cada uma delas terá pouco conteúdo.

Retornado ao exemplo do livro, os títulos de cada página seriam:

  • Nome do livro
  • Nome do livro/Capa
  • Nome do livro/Prefácio
  • Nome do livro/Introdução
  • Nome do livro/Capítulo 1
  • Nome do livro/Capítulo 2
  • Nome do livro/Capítulo 3
  • Nome do livro/Bibliografia

Note que a primeira palavra no nome dos capítulos deve começar com letra maiúscula, e as demais devem ser minúsculas.

A primeira página desta lista, como já foi dito, é a que contém o índice do livro. Procedendo desta maneira, ao criar cada uma das páginas já será exibida no topo uma ligação que leva ao índice do livro, facilitando a navegação.

Se preferir, você pode mesclar o índice e a capa em uma página só (uma capa-índice). Neste caso, a página que leva o nome do livro exibirá a capa logo no topo e mais abaixo estará uma seção com o índice.

Observações[editar código-fonte]

  • Em uma página cujo título possui uma barra "/", como em "Isso/Aquilo/E assim/Por diante", se diz que a parte do título "Isso" é o nome base da página e que "Aquilo/E assim/Por diante" é o nome da subpágina. Estes nomes também estão acessíveis ao longo da página através das palavras-chave {{BASEPAGENAME}} e {{SUBPAGENAME}}, oferecidas pelo MediaWiki. O nome inteiro da página está associado a palavra-chave {{PAGENAME}}.
  • Em alguns livros mais antigos, você poderá encontrar títulos que não usam a barra "/" para separar o nome do livro e o nome de suas páginas. Em vez disso, tais livros usavam dois pontos ":", ou hífen "-", ou os dois. No entanto, estes delimitadores não produzem a ligação para a página do índice automaticamente, e as palavras-chave mencionadas também não funcionam como esperado. Por estes e outros motivos apresentados nesta discussão, ficou decidido pela comunidade que os novos livros e módulos devem utilizar a barra ("/"). Com a mudança, antes de editar uma página existente, que possua os delimitadores ":" ou "-" e seja considerada orfã (ou esteja sem edição a algum tempo), deve-se movê-la para uma página que siga o padrão descrito nesta página, pois a adoção de uma convenção para as nomenclaturas facilita muito a organização e consulta do material no Wikilivros.

A criação de um wikilivro[editar código-fonte]

Para criar um livro dentro do projeto, primeiro planeje quais capítulos ele terá, e a ordem dos mesmos, pois esta estrutura irá aparecer no índice do livro, que é a sua página base, sua página principal. Também verifique se os títulos escolhidos seguem o formato recomendado, exposto no tópico acima.

Dentro do índice do livro, são colocadas várias ligações internas que apontam para os módulos do livro. Uma ligação interna é criada usando um código como este:

[[Título da página|Texto exibido]]

Há várias maneiras de formatar o índice. Por exemplo, pode ser feita uma lista numerada dos módulos que compõe o livro, e colocar em cada um dos itens uma ligação interna para a página correspondente. Neste caso, para cada página do livro seria inserido um código neste estilo:

# [[Nome do livro/Nome do capítulo|Nome do capítulo]]

Para cada '#' o servidor irá associar um número seqüencial, assim o índice é automaticamente enumerado.

Pode-se ainda poupar tempo e trabalho usando uma interessante e útil característica da organização de livros com "/": para criar ligações para uma subpágina, não é preciso escrever o nome da página principal. Assim, cada uma das ligações pode ser simplificada para:

# [[/Nome do capítulo/]]

O servidor coloca automaticamente a página "Nome do capítulo" dentro da estrutura [[Nome do livro/Nome do capítulo]]. O mesmo acontece para nas ligações colocadas dentro de capítulos e subcapítulos.

Para facilitar a criação do índice, basta colocar o nome escolhido para o livro no campo abaixo, no lugar de "<Título do livro>", e clicar no botão "Criar índice". Será aberta uma janela de edição, com um esboço do código que deverá aparecer no índice do livro.

Utilize este campo para criar o índice do novo livro:

Devemos, então, criar na biblioteca uma ligação para a capa do livro:

[[Nome do livro/Capa|Nome do livro]] [[Imagem:00%.svg]]

ou

[[Nome do livro]] [[Imagem:00%.svg]]

conforme a capa esteja em uma página separada ou junto com o índice do livro.

Para que o autor de um livro e também os leitores possam ter uma idéia de qual o estágio de desenvolvimento do texto, bem como quais páginas estão mais desenvolvidas, utilizam-se as seguintes imagens:

Etapas de desenvolvimento do texto (5 ou 9 etapas)
Início: 0de8.svg Básico: 1de8.svg Criação: 2de8.svg Desenvolvimento: 3de8.svg Maturação: 4de8.svg Revisão: 5de8.svg Desenvolvido: 6de8.svg Finalização: 7de8.svg Abrangente: 8de8.svg
00%.svg 25%.svg 50%.svg 75%.svg 100 percent.svg

Para cada link de wikilivro, adota-se o indicador de progresso da edição, que consiste de uma imagem que fornece uma indicação da qualidade e densidade do conteúdo dentro do livro; esta imagem pode ser uma das seguintes:

[[Imagem:00%.svg]]

[[Imagem:25%.svg]]

[[Imagem:50%.svg]]

[[Imagem:75%.svg]]

[[Imagem:100%.svg]]

A colocação de categorias[editar código-fonte]

Agrupar páginas em uma categoria é uma forma de destacar que elas possuem algo em comum, seja no seu conteúdo, ou na sua finalidade.

Imagine que se quer categorizar um livro hipotético chamado "Cadeias neurais". O procedimento se resumiria a três etapas:

  • Categorizar o livro;
  • Categorizar a categoria que contém o livro (se ainda não estiver categorizada);
  • Categorizar os módulos do livro.

O código wiki usado para colocar uma categoria em uma página segue o padrão abaixo, onde "_" é usado para simbolizar um espaço em branco:

[[Categoria:Nome_da_categoria|Rótulo_do_indexador]]

Quando se lida com categorias, é muito útil usar algumas das variáveis fornecidas pelo software MediaWiki. As três principais são:

Os detalhes são mostrados nas seções abaixo:

Nos índices dos livros[editar código-fonte]

Normalmente se cria uma categoria para cada especialidade dentro de cada área. O índice, geralmente, deve conter todas as categorias (tanto a mestra como as especialidades) para facilitar o acesso a informação por parte de quem procura.

No índice (ou na capa_índice) de cada wikilivro, deve-se usar como indexador o caractere curinga (ou asterisco) (*) seguido do nome do livro. O código poderá ser qualquer um destes:

[[Categoria:Nome_da_categoria_da_especialidade|*{{SUBPAGENAME}}]]
[[Categoria:Nome_da_categoria_da_especialidade|*Nome_do_livro]]

No caso do livro "Cadeias neurais", deveriam ser colocadas todas as seguintes linhas no fim da página que contém o índice:

[[Categoria:Medicina|*Cadeias neurais]]
[[Categoria:Neurologia|*Cadeias neurais]]
[[Categoria:Cadeiras neurais|*Cadeias neurais]]

ou equivalentemente

[[Categoria:Medicina|*{{SUBPAGENAME}}]]
[[Categoria:Neurologia|*{{SUBPAGENAME}}]]
[[Categoria:Cadeiras neurais|*{{SUBPAGENAME}}]]

Veja que todas as categorias que enquadram o assunto a ser abordado no livro podem ser colocadas no mesmo. Aqui temos "Medicina" como a categoria mestra, mas também podemos colocar "Neurologia" dentro da definição da categoria "Medicina".

Nas categorias[editar código-fonte]

Se uma categoria não está em nenhuma categoria, ela aparece na lista de categorias não categorizadas. Por este motivo, deve-se categorizar as seguintes categorias:

  • A que leva o nome do livro;
  • As das especialidades que aparecem no índice do livro.

Todas elas devem ser colocadas na categoria de alguma grande área do conhecimento.

O código para a categoria que contém o livro pode ser qualquer um destes:

[[Categoria:Nome_da_categoria_da_especialidade|{{NOMEDOLIVRO}}]]
[[Categoria:Nome_da_categoria_da_especialidade|{{BASEPAGENAME}}]]
[[Categoria:Nome_da_categoria_da_especialidade|Nome_do_livro]]

No caso da "Categoria:Cadeias neurais", que contém os módulos do livro de mesmo nome, poderia ser colocado:

[[Categoria:Medicina|Cadeias_neurais]]

O código para as categorias das especialidades que contém o livro deve ser qualquer um destes:

[[Categoria:Nome_da_categoria_da_grande_área|{{PAGENAME}}]]
[[Categoria:Nome_da_categoria_da_grande_área|{{BASEPAGENAME}}]]
[[Categoria:Nome_da_categoria_da_grande_área|{{SUBPAGENAME}}]]
[[Categoria:Nome_da_categoria_da_grande_área|Nome_da_categoria_da_especialidade]]

pois neste caso todas as variáveis mencionadas retornarão o mesmo nome.

Nos módulos de um mesmo livro[editar código-fonte]

Os módulos de um um livro geralmente recebem apenas em uma categoria: a que tem o mesmo nome do livro. Para livros que não têm subcapítulos, ou seja, cuja estrutura é simplesmente "Livro/Capítulo", a variável {{BASEPAGENAME}} retorna o nome do livro. Para livros com mais subdivisões, pode-se usar a predefinição {{NOMEDOLIVRO}}.

Para categorizar os módulos de um livro, pode-se escolher uma das seguintes opções:

[[Categoria:{{NOMEDOLIVRO}}|{{SUBPAGENAME}}]]
[[Categoria:{{BASEPAGENAME}}|{{SUBPAGENAME}}]]
[[Categoria:Nome_do_livro|Nome_do_capítulo]]

A primeira opção funciona sempre, a segunda apenas para os livros com estrutura mais simples "Livro/Capítulo", e a terceira funciona até que se precise renomear o livro.

Note que a tarefa de categorizar os módulos de um mesmo livro é repetitiva, consistindo de colar o mesmo código (se escolhida a primeira ou a segunda opção) em todas as páginas do livro. Por isso foi criada a predefinição {{AutoCat}}, que unifica o código usado nos módulos com o código usado no índice. Para mais detalhes sobre o uso, consulte a página da predefinição.

No caso do livro "Cadeias neurais", deveria ser colocado no fim da página "Cadeias neurais/Neurotransmissores" qualquer uma destas opções:

{{AutoCat}}
[[Categoria:{{NOMEDOLIVRO}}|{{SUBPAGENAME}}]]
[[Categoria:{{BASEPAGENAME}}|{{SUBPAGENAME}}]]
[[Categoria:Cadeiras neurais|Neurotransmissores]]

Caso existam subcapítulos[editar código-fonte]

Podem ser criadas subcategorias para cada um, porém isto fica a critério do editor. Nestes casos coloca-se a página do subcapítulo na categoria do capítulo ao qual ele pertence.

No geral, se a densidade de tópicos do subcapítulo não for substancialmente grande não será necessária a criação de uma subcategoria específica para o subcapítulo.

O código para a categorização dos subcapítulos deverá ser qualquer um destes:

{{AutoCat}}
[[Categoria:{{BASEPAGENAME}}|*{{SUBPAGENAME}}]]
[[Categoria:Nome_do_capítulo|*Nome_do_subcapítulo]]

Veja também[editar código-fonte]