Como escrever um bom wikilivro/Criando o wikilivro

Origem: Wikilivros, livros abertos por um mundo aberto.

<< Acautelai-vos com...

Dicas e macetes >>

Tabela de conteúdo 1 Planejando o projeto 2 Iniciando um novo livro 2.1 Incluindo o livro na biblioteca 2.2 Entendendo a estrutura do livro 2.3 Criando o índice 2.3.1 Organização por "/" 2.4 Preparando os capítulos e sub-capítulos 3 Criando as categorias 4 Melhorando a estrutura

[editar] Planejando o projeto

Antes de iniciar o projeto do livro verifique se o tema a ser abordado não existe em nenhum dos livros da biblioteca, depois vá a seção de Pedidos de wikilivros e verifique as necessidades das pessoas que tentam encontrar material no wikilivros.

Após certificar-se de que não há nenhum livro que contenha o tema ou a abordagem que deseja iniciar, consulte os padrões para livros didáticos, aconselha-se uma estrutura mista, que comporte uma conjunção dos programas dos países que falam a língua portuguesa. Lembre-se que pt.wikibooks.org é um projeto internacional, portanto é sempre bom manterem-se materiais que sejam úteis para todos os países falantes do português.

Cada livro é composto por um conjunto de módulos (páginas), os nomes dos módulos são definidos de acordo com a densidade de cada tópico e a maneira como estão relacionados entre si.

A estrutura dos livros é basicamente esta:

1. Índice (primeira página)
2. Capítulos organizacionais <- Prefácio,Preâmbulo,Introdução,...
3. Capítulos temáticos

Porém caso o editor queira se organizar melhor sugerimos:

1. Índice (primeira página)
2. Capa <- Opcional
3. Capítulos organizacionais <- Prefácio,Preâmbulo,Introdução,...
4. Capítulos temáticos
5. Subcapítulos <- Opcional
6. Módulos de exercícios <-Opcional
7. Apêndices <-Opcional
8. Bibliografia <-Opcional

Obviamente, se o conteúdo é relativamente pequeno, os módulos opcionais podem ser incluídos dentro da estrutura básica, provendo um livro mais compacto.

[editar] Iniciando um novo livro

Os tópicos a seguir instruem um roteiro básico para criação de um wikilivro dentro do nosso projeto, seguindo os passos abaixo você poderá criar o seu wikilivro facilmente.

[editar] Incluindo o livro na biblioteca

Depois que temos o título do livro, iremos à biblioteca para incluir o livro na mesma, verificamos que a mesma está organizada da seguinte forma:

Título da prateleira 1

• Título da subprateleira
  • Livro 1
  • Livro 2
  • Livro 3

-

-

-

Título da prateleira 2

• Título da subprateleira
  • Livro A
  • Livro B
  • Livro C

-

-

-

Como criar esta lista

Usamos a linguagem de formatação do software MediaWiki nos livros, faremos uma breve introdução de algumas regras e estruturas que aplicamos aqui, para mais detalhes consulte Ajuda:Como editar uma página.

Temos as seguintes estruturas dentro do índice:

• Negrito: Representa palavras em negrito (atributo bold), para isto usamos três apóstrofos ''' antes e depois da palavra:

'''Palavra'''

Que nos dá:

Palavra.

---

• Marcadores simples: Para indicar tópicos dentro de uma lista usamos o caractere "*" (asterisco), podemos usar um ou mais para cada tópico, para cada nível da lista acrescenta-se um caractere "*":

*A
*B
**Ba
**Bb
***Bba

Que é mostrado desta forma:

• A
• B
  • Ba
  • Bb
    • Bba

---

• Marcadores numerados: Para numerar uma lista usamos o caractere "#" (sustenido), o efeito disto é que o servidor enumera as linhas de acordo com a seqüência da mesma automaticamente, veja:

#A
#B
##Ba
##Bb
###Bba

Que é mostrado desta forma:

1. A
2. B
   1. Ba
   2. Bb
      1. Bba

---

• Marcadores mistos: Para criar uma lista com tópicos enumerados e não enumerados usamos as combinações de "#" e "*", veja:

*A
*B
*#Ba
*#Bb
**BB
**#Bba

Que é mostrado desta forma:

• A
• B
  1. Ba
  2. Bb
  • BB
    1. Bba

---

• Link/Ligação/URL - local: Para criar um link local, ou seja, para acessar um endereço dentro do projeto, usamos os colchetes: [[ ]], indicamos o nome da página dentro do projeto separamos com "|" e depois colocamos o nome que deve aparecer na nossa página, veja:

[[Livro B|Livro B]]
Aparecerá como:

Livro B

Ou seja quando clicar em Livro B o leitor será levado ao endereço: Livro B dentro do projeto.

---

• Imagem: Para inserir uma imagem dentro da página colocamos o link [[Imagem:Nome_da_imagem]], diversos desenhos estão disponíveis no wikimedia commons para que possamos incluir em nossos livros, porém se for necessário incluir alguma imagem dentro do projeto podemos fazer o carregamento do arquivo, contudo não devemos nos esquecer de colocar a licença adequada da imagem dentro da página de descrição da mesma, para mais detalhes sobre inclusão de imagens veja: Ajuda:Adicionando novas imagens.

---

Editando a biblioteca

Agora que temos uma idéia de como a linguagem wiki funciona, abrimos a biblioteca para edição usando o link Editar, no topo da página, veremos uma estrutura similar a esta:

<div class="Título_prateleira">Título da prateleira 1</div>

*'''Título da subprateleira'''
**[[Livro 1]] [[Imagem:25%.svg]]
**[[Livro 2/Capa|Livro 2]] [[Imagem:50%.svg]]

-

-

-

<div class="Título_prateleira">Título da prateleira 2</div>

*'''Título da subprateleira'''
**[[Livro A]] [[Imagem:100%.svg]]
**[[Livro B/Capa|Livro B]] [[Imagem:75%.svg]]

-

-

-

Observando cada linha abaixo do "Título da subprateleira" temos um exemplo de uma das formas de se criar o link para o livro:

1. No "caso 1" fornecemos apenas o nome do livro, o que nos possibilita criar a capa ou uma capa com índice na mesma página;
2. No "caso 2" fornecemos o link para a capa do livro usando o delimitador "/", este é o novo padrão, que como veremos, facilita a criação de módulos, mas lembre-se que mesmo no caso 1 ainda podemos colocar um link para a primeira página na capa e criá-lo no formato Livro/Capítulo.

Notamos ainda que é adotado um link no formato: [[Imagem:XX%.svg]], onde XX representa a quantidade e qualidade do conteúdo do livro, opcionalmente podemos adotar o mesmo indicador de progresso de edição para cada link dentro do índice do livro, as porcentagens disponíveis são:

.

Também podem ser incluídas imagens que possibilitam subdividir o desenvolvimento do livro em 9 fases, para isto usamos o formato: [[Imagem:Xde8.svg]], onde X varia de 0 a 8, que representam os seguintes valores:

inteiro

Uma interpretação funcional destas imagens pode ser observada abaixo:

Mais detalhes sobre estes padrões de formato estão em Wikilivros:Nomenclaturas.

[editar] Entendendo a estrutura do livro

Antes de iniciar o livro, vejamos como é organizado um livro dentro do projeto. Antes de tudo devo lembrar que existem três métodos para criar o livro, em todos existe um método de relacionar todas as páginas de um mesmo livro entre elas para que não sejam confundidas com páginas de outros livros. A estrutura é esta:

(Livro) + (Delimitador) + (Índice) + (Delimitador) + (Capítulo) + (Delimitador) + (subcapítulo)

ou

(Livro) + (Delimitador) + (Capítulo) + (Delimitador) + (subcapítulo)

Os primeiros delimitadores usados aqui no wikilivros eram: ":" - Dois pontos, "-" - Hífen. Ainda podemos encontrar poucos livros que estejam neste padrão, simplesmente porque não houve tempo para modificar a estrutura de todos.

Sendo que o delimitador hífen só deve ser usado em sub-capítulos, portanto poderíamos fazer as seguintes combinações:

1. Livro: Índice: Capítulo: Subcapítulo (formato com capa e índice)
2. Livro: Índice: Capítulo - Subcapítulo

Ou

1. Livro: Capítulo: Subcapítulo (formato com capa_índice)
2. Livro: Capítulo - Subcapítulo

Hoje usamos o delimitador "/" - Barra para organizar os livros de forma que todos os livros devem ser organizados usando este caractere para separar as partes do livro. A estrutura é montada da seguinte forma:

1. Livro/Capítulo/Subcapítulo

As páginas do livro são chamadas de módulos, elas são identificadas facilmente através da estrutura de relacionamento por delimitadores. Temos o índice dentro da mesma página que pode ser usada como capa, que chamamos de capa_índice, ou podemos colocar a capa separada. vejamos a figura abaixo:

Na página inicial, aquela com a qual o leitor se depara ao clicar o link dentro da biblioteca, temos uma apresentação do livro e seus objetivos, figuras e imagens podem ser adicionadas para fazer com que o mesmo seja mais atraente, onde temos a estrutura do índice geral. Todas estas partes podem ficar na própria página inicial, o que nos fornece uma "Capa_índice", ou podemos separar a capa deixando-a em uma página a parte. Um livro de ramificação simples pode ser conseguido criando capítulos para cada tópico a ser abordado dentro do tema a que se propõe o livro, este tipo de estrutura se desenvolve até os capítulos "A1...An", porém se o livro pede que os capítulos sejam ramificados em sub-capítulos, teremos uma estrutura mais subdividida e a navegação entre as páginas será mais complexa.

Em termos gerais podemos facilitar a navegação do leitor pelo livro usando estruturas chamadas de navegações, a navegação é um modelo predefinido de desenho com links, dentro do wikilivros e em outros projetos wiki podemos criar modelos, que são chamados de predefinições, estas predefinições são partes de páginas que são usadas como moldes para se colocar alguma informação, elas possibilitam a reutilização destes moldes em várias páginas. Veja por exemplo a predefinição {{Navegação|Índice|A1|A3}}, utilizada nos desenhos acima, ela aparece desta forma:

Para o primeiro caso onde o índice fica em uma página separada. No segundo caso onde a página inicial é Capa_índice, temos: {{Navegação|Livro|A1|A3}}

Usando estes modelos (predefinições), o leitor poderá ir para o capítulo anterior, para o próximo capítulo, ou voltar para o índice.

Se a navegação for colocada em um sub-capítulo teremos a seguinte forma: {{Navegação|A1|B1|B3}}, que aparece assim:

Isto, porque o link acima da estrutura "B" é a estrutura "A" e não o índice, o objetivo da estrutura é de permitir que o leitor volte para as páginas anteriores qu já visitou. Se colocássemos o índice como objeto para retorno do link "Acima", o leitor seria obrigado a navegar todos os links que já teria percorrido para poder alcançar as páginas do nível "A", imagine se o mesmo estivesse no nível "C".

Este processo é um pouco trabalhoso, por isso foi criada outra maneira de editar os livros, observemos a figura abaixo:

Para facilitar a edição e reduzir os erros de formatação da estrutura de navegação, foi criado um formato de organização de páginas especial para o wikilivros: A estrutura com barras "/", com ela o nosso servidor consegue organizar todas as páginas de um livro como uma estrutura de diretórios, ou pastas de computador... O mais interessante é que podemos criar links como se fizéssemos referências a pastas de computador, além de termos menos trabalho o servidor ainda nos fornece, automaticamente, links para as páginas que estão dentro de cada conjunto de barras no nome da página, ou seja, imagine que temos a página: /Livro/Índice/A1/B2, então, os links para Livro - Índice - A1 estarão numa lista dentro da página B2, o que possibilitará que o leitor volte, não só para a estrutura anterior, mas para qualquer das páginas anteriores que quiser.

Para navegar entre as páginas que estão dentro do mesmo nível, ou seja, de A1 até An ou de B1 até Bn, etc... Foi criado um novo modelo (predefinição) chamado {{Nav2}}, esta predefinição nos dá a possibilidade de usar dois links: um para a página mais próxima anterior e outro para a página mais próxima posterior a atual, onde colocamos a mesma, além existe um local para colocar uma pequena imagem que identifique o conteúdo do livro, se fizermos: {{Nav2|[[Imagem:Exemplo.jpg|30px]]|A1|A3}}, provavelmente estamos na página A2 e o resultado será este:

<< A1

A3 >>

Observe que não precisamos que a predefinição nos dê links para cima, uma vez que quando criamos as páginas do livro separando os capítulos por barras ("/"), será criada uma lista das páginas anteriores que estão na lista separadas por barras, o que possibilitará ao leitor voltar para estas.

[editar] Criando o índice

Quando criar a capa, índice ou capa-índice na biblioteca, o nome do livro aparecerá em um link vermelho, ao acessar o link vazio você entra na janela de edição, nesta página deve ser criada a estrutura de acesso ao livro, caso opte para a criação da capa deve haver um link dentro da mesma para acessar a primeira página do livro, da mesma forma que criamos o nome do livro na biblioteca criamos o link dentro da capa:

• [[Nome do livro]]

resultam num link mostrado desta forma:

Nome do livro

Quando você acessa este link vazio é levado ao endereço:

• Nome do livro;

Como o link está vazio você poderá incluir o índice dentro desta página, que será a primeira página do livro, onde podemos criar os links para os capítulos:

[editar] Organização por "/"

Este é o novo formato, suas vantagens são a automatização de algumas tarefas e algumas facilidades que permitem evitar erros comuns de edição.

Basicamente, o princípio é o mesmo dos anteriores, ou seja, separar as parte do livro, relacionando-as pelo endereço do link, a diferença é que este formato usa o mesmo caractere usado para referenciar diretórios dentro de um servidor, o que faz com que o mesmo crie uma árvore parecida com a estrutura usada em nossos computadores pessoais: cada livro é uma "pasta" ou "diretório", como preferirem chamar, fazendo com que seja possível criar um caminho de volta da página atual para as páginas anteriores.

A maneira de estruturar um índice para este delimitador é muito simples, apenas criamos links da seguinte forma:

Temos um livro: Nome do livro

Na capa, colocamos:

[[Nome do livro]]

isto aparece desta forma:

Nome do livro

o que nos leva ao endereço: [[Nome do livro]]

Dentro colocamos:

[[/Capitulo/]]

isto aparece desta forma:

Capítulo

o que nos leva ao endereço: [[Nome do livro/Índice/Capítulo]]

Desta forma o processo de criação da estrutura do livro é basicamente este:

1. Criar a capa na biblioteca no formato: [[Nome do livro]][[Imagem:00%.png]];
2. Criar os capítulos dentro da primeira página: [[/Capítulo/]];
3. Se houver subcapítulos ou tópicos dentro dos capítulos, criar links no formato: [[/subcapítulo/]] ou [[/tópico/]].

Sempre que entramos em um link dentro desta estrutura, o servidor criará uma estrutura no topo da página, com o caminho do início até a página onde estamos, facilitando o nosso acesso ao caminho que já percorremos.

Em livros muito ramificados, a estrutura nos dá a possibilidade de acessar, aleatoriamente, qualquer uma das páginas anteriormente visitadas, um grande avanço em relação de predefinições de navegação, que se tornam extremamente trabalhosas de serem criadas para esses casos, ou são visivelmente ineficientes quando contemplam apenas o índice e as páginas anterior e posterior. Por outro lado, o uso da estrutura de organização com barras "/" e as predefinições de navegação juntas, fornecem um conjunto de acesso às páginas do livro bem mais completo do que quando são usadas separadamente. O livro que contempla seus leitores com as duas possibilidades de acesso ao conteúdo permite que os mesmos naveguem livremente, item por item, pelo conteúdo do índice através da predefinição de navegação, enquanto que o mesmo pode voltar para a página que quiser dentro dos sub-capítulos do mesmo tópico através do menu criado automaticamente pela estrutura ramificada em barras.

[editar] Preparando os capítulos e sub-capítulos

Tendo criado o índice contamos com um conjunto de links vazios para os capítulos, ao entrar em um destes links teremos a janela de edição, onde poderemos incluir o conteúdo do capítulo. Para criar a estrutura básica do capítulo escolha os tópicos sobre o assunto de forma que estejam didaticamente bem distribuídos, facilitando a consulta e a referência em outras páginas, para subdividir os capítulos usamos seções.

As seções são partes do texto que têm uma hierarquia, de forma a criar uma estrutura na lista de tópicos do capítulo, para criar esta estrutura usamos os secionadores.

Os secionadores são sinais "=" (igual a) no início de linha, ou seja, deve haver um return ou Enter antes do sinal "=" para que este seja considerado um delimitador de seção. São usados para iniciar e finalizar o nome da seção , desta forma:

=Seção 1=
=Seção 2=
=Seção 3=

A hierarquia pode ser estabelecida criando subseções, que são criadas adicionando mais um sinal "=" para iniciar um sub-nível, ou seja:

Seção 1

Este é o texto da seção 1.

Subseção 1

Este é o texto da subseção 1.

Pode ser feito assim:

=Seção 1=

Este é o texto da seção 1.

==Subseção 1==

Este é o texto da subseção 1.

Por questões estéticas muitos livros iniciam as seções com o nível 2 "==", mas a escolha dos níveis fica por conta do autor.

Para criar um sub-capítulo basta criar um link dentro do capítulo, porém verifique qual a forma de organização o livro está utilizando, dependendo do padrão usado para os links podemos usar:

[[Nome do livro: Capítulo: Subcapítulo]]

[[Nome do livro: Capítulo - Subcapítulo]]

[[/Subcapitulo/]]

[editar] Criando as categorias

O que são categorias?

São conjuntos de temas inter-relacionados, que quando agrupados em uma janela específica podem ser facilmente encontrados. O sistema de categorização do wikilivros funciona de forma a criar grupos de assuntos e facilitar a sua localização por parte dos leitores, para isso devemos colocar uma marca especial dentro de cada página de nossos livros, é costume criarmos uma categoria específica para cada página de um determinado livro e incluir o índice em categorias globais também.

Vejamos como funciona o sistema de categorização:

Todas as categorias são derivadas de uma das categorias mestras do projeto, existem 3 categorias globais mais utilizadas, que são:

1. Wikilivros - Páginas do projeto wikilivros;
2. Principal - Páginas de livros;
3. Ajuda - Páginas de ajuda;

Ou seja, a maioria das categorias criadas dentro do projeto deve estar dentro de uma destas categorias, porém pode haver outras aqui não relacionadas, que não são muito usadas, para nosso caso estas são suficientes.

Como funciona

Digamos que desejemos criar a categoria "Plantas ornamentais", e desejamos criá-la para um livro com o mesmo título, então devemos criá-la na seguinte estrutura:

  Principal
      |
      |
  Biologia
      |-----------+--------  ....  ----+ 
      |           |                    |                      
  Botânica     Citologia     ....    Zoologia
      |
      |
      |--------------+-----.....        
      |              |
  Plantas         Ambientes
  ornamentais     de cultivo.

Considere que as categorias "Botânica" e "Plantas ornamentais" não existam, desta forma introduzimos o link:

[[Categoria:Plantas ornamentais|*]]

Dentro do índice do livro, geralmente coloca-se no final da página.

Uma breve explicação

O link acima representa um comando de inclusão da referida página a uma categoria, a primeira parte, Categoria: Nome da categoria representa o nome da categoria onde queremos incluir a nossa página índice do livro, a segunda parte, |* representa o indexador dentro da categoria, ou seja, quando visualizamos a página da categoria, este é o local dentro da lista onde esta página irá aparecer. Neste caso que é a página índice do livro, colocamos "*" e veremos este como o primeiro da lista.

Continuando

Agora, quando salvamos a página, esta aparecerá dentro da categoria e veremos o link para a categoria no final da página, observe que o link está vazio, por isso devemos definir a categoria da seguinte forma:

Entramos no link da mesma e quando a página de edição aparecer digitamos:

[[Categoria:Botânica]]

E um descritivo, que é opcional.

Observe que agora não precisamos colocar o indexador. Ao salvarmos a página teremos outro link vazio, note que nem sempre precisamos definir um livro em uma categoria que não existe ainda, se a categoria "Botânica" já existisse ela apareceria em azul e já estaria definida, mas como devemos ver como fazê-lo iremos acompanhar o processo. Para definir "Botânica", colocamos o link:

[[Categoria:Principal]]

Agora, quando um leitor estiver navegando pelas categorias, poderá selecionar "Botânica" e depois "Plantas ornamentais", porém se o usuário estiver querendo examinar algo específico dentro do livro podemos facilitar ainda mais o acesso à informação colocando as páginas do livro dentro da categoria específica "Plantas ornamentais", desta forma:

Para o capítulo: Orquídeas, podemos incluir dentro desta página o link:

[[Categoria:Plantas ornamentais|{{SUBPAGENAME}}]]

Novamente usamos o indexador "|Criando o wikilivro", o que faz com que dentro da categoria este capítulo esteja dentro dos que começam pela letra "O", isso é necessário, pois o servidor pode identificar a categoria pelo nome do link, como todos os links do livro começam pela letra "P" --> "Plantas ornamentais/Orquídeas" todas as páginas sem indexador ficariam nesta letra.

Finalmente, colocamos mais um link de categoria dentro do índice:

[[Categoria:Botânica|*{{SUBPAGENAME}}]]

Isto para que o leitor que queira ir diretamente ao conteúdo do livro ao entrar em "Botânica", sem querer ver os outros livros da categoria tenha acesso facilitado.

[editar] Melhorando a estrutura

Alguns recursos podem ser incluídos para que tenhamos uma melhor apresentação das páginas, dentre eles estão as Predefinições, o HTML e o TeX e LaTeX.