PageRenderTime 27ms CodeModel.GetById 22ms app.highlight 2ms RepoModel.GetById 1ms app.codeStats 0ms

/doc/Portuguese/writing-book-pt.t2t

http://txt2tags.googlecode.com/
Unknown | 327 lines | 224 code | 103 blank | 0 comment | 0 complexity | fe028bcf8364a29f5b80dcf9588ef9f6 MD5 | raw file
  1Escrevendo Livros com o Txt2tags
  2
  3por Aurélio Jargas
  4
  5
  6%!target : xhtml
  7%!encoding: UTF-8
  8%!style  : ../English/writing-book.css
  9%!options: -n --toc --css-sugar --css-inside -o writing-book-pt.html
 10
 11%!preproc: URL_RE_BOOK  http://guia-er.sourceforge.net/
 12%!preproc: URL_HTMLDOC	http://www.easysw.com/htmldoc/
 13%!preproc: DESCULPE     o txt2tags não pode lhe ajudar
 14%!postproc: URL_PC_BOOK http://www.picocontainer.org/Contructor+Dependency+Injection+...+Book+Announcement
 15
 16
 17	Esse documento é um guia rápido que mostra os benefícios de usar
 18	a ferramenta txt2tags no processo de composição de livros. Também aplicado
 19	para outros documentos extensos como Manuais e Teses.
 20
 21
 22= Prefácio =
 23
 24Eu sou o autor do txt2tags``[1]`` e escrevi duas publicações usando 
 25ele: um [Livro de Expressões Regulares URL_RE_BOOK] (96 páginas) e um Curso de 
 26Programação Shell (108 páginas). O processo de composição foi fácil e 
 27indolor, então eu quero compartilhar essa experiência.
 28
 29Um livro é um verdadeiro trabalhão para ficar pronto, mas isso não tem que ser
 30um processo complicado. Escrever é organizar idéias em estruturas de texto
 31como seções, parágrafos e listas. O txt2tags é uma ferramenta que faz essa
 32tarefa simples e fácil.
 33
 34Escrevendo sozinho ou em equipe, com ou sem controle de versão, conteúdo
 35técnico ou não, apenas texto ou com gráficos. Em qualquer caso o txt2tags pode ser
 36usado como a principal ferramenta para criação de livros.
 37
 38Há [um livro URL_PC_BOOK] sendo escrito agora, usando txt2tags.
 39
 40	``[1]`` O txt2tags lê um arquivo de texto com um mínimo de marcações como 
 41	""**negrito**"" e ""//itálico//"" e as converte para documentos
 42	como HTML, LaTeX e Adobe PageMaker. Mais informações:
 43	http://txt2tags.org.
 44
 45
 46
 47= Editores Visuais VS Marcações =
 48
 49As duas maneiras comuns para escrever um livro são usar um Editor Visual
 50(//Microsoft Word//, //Adobe Pagemaker//) ou uma linguagem de Marcação
 51(//LaTeX//, //docbook//).
 52
 53Em Editores Visuais você escreve e formata o conteúdo no mesmo tempo.
 54Essa abordagem é legal para textos pequenos, mas para um livro de 300 páginas,
 55a formatação consome tempo e distrai o escritor.
 56
 57Em linguagens de marcação você escreve o conteúdo e o marca, então um
 58programa externo irá convertê-lo para a forma final. O escritor não se
 59preocupa com a formatação, mas o processo de incluir ``<tags></tags>`` e 
 60``\mais{tags}`` é chato e passível de erro, tornando o conteúdo difícil para ler
 61a partir das fontes.
 62
 63O txt2tags também usa o esquema de marcação, mas a grande diferença é que
 64suas marcas são mínimas, algumas certamente são quase naturais, como usar
 65o hífen para itens de lista. Então o escritor pode focalizar somente no
 66conteúdo e a fonte permanece legível.
 67
 68
 69= A Abordagem do Txt2tags =
 70
 71Usando txt2tags, o processo de composição do livro segue estes passos:
 72
 73+ O(s) autor(es) aprendem as simples regras de marcação do txt2tags.
 74
 75+ O autor escreve o conteúdo do livro, esquecendo coisas supérfluas como
 76  margem da página, tipo da fonte, cores e tamanhos.
 77
 78+ O autor (ou o editor) abre o conteúdo num processador de texto gráfico
 79  que lê HTML (ou LaTeX ou ...) e conclui a formatação do livro.
 80
 81
 82O passo 1 é rápido, apenas alguns minutos, o passo 2 deverá levar meses, e
 83o passo 3 pode levar dias ou semanas.
 84
 85Escrever o conteúdo é quando você gastará mais tempo no livro, então
 86é realmente importante fazer esse processo uma simples, produtiva e
 87agradável tarefa.
 88
 89Seguem argumentos mostrando que txt2tags pode ser usado para isso.
 90
 91
 92= Veloz e Furioso =
 93
 94Tempo é a chave. Usando o txt2tags você experimentará um período
 95de produtividade elevado porque você escreve o conteúdo, sem formatação.
 96
 97- **Lançamento Inicial Rápido**
 98
 99  É muito difícil começar algo, mas o txt2tags tem uma abordagem agradável para
100  esse problema. Apenas sente e escreva em texto puro. Quando você tiver
101  concluído, em poucos minutos você pode adicionar todas as marcas do txt2tags
102  no texto e o documento está pronto para ser convertido e publicado.
103
104- **Visualização Instantânea**
105
106  Não importa qual será o formato final do livro, HTML é o formato
107  preferido para usar na hora de escrever. Um panorama do estágio atual
108  do livro pode ser feito a qualquer momento, convertendo as fontes para
109  uma página HTML, então qualquer sistema com um navegador pode lê-lo. Se
110  você precisa de uma versão impressa, converta o HTML para PDF com a
111  excelente ferramenta [htmldoc URL_HTMLDOC].
112
113- **Visão geral do Conteúdo do Livro**
114
115  Para rapidamente ter uma visão geral do conteúdo do livro a qualquer momento,
116  use a opção //somente TOC// do txt2tags. O programa mostrará o
117  índice do livro, com a lista dos capítulos e seções, numeradas
118  ou não, em toda profundidade.
119
120- **Escreva Rápido**
121
122  As marcas do Txt2tags são simples e mínimas, muito fácil para aprender.
123  Sem nomes, sem opções, sem parâmetros. Você não tem que parar de escrever
124  o conteúdo para inserir marcas, elas fluem junto com o texto. Se você não
125  lembra uma marca especifica no momento, esqueça-a e continue escrevendo.
126  No fim você faz uma revisão geral no texto e rapidamente insere a marca
127  que faltava.
128
129- **Conversão Rápida**
130
131  Mesmo se você tem um livro de 500 páginas, o processo de conversão
132  demorará apenas um instante. É porque o txt2tags age como um filtro,
133  convertendo de um formato a outro. Ele não indexa, compila, calcula,
134  compacta, desenha ou faz qualquer outro processamento pesado nas fontes.
135  Esqueça os pesadelos de bibliotecas, catálogos e DTDs.
136
137
138= Organize as Fontes em Pastas =
139
140O txt2tags tem um comando para incluir arquivos externos em
141qualquer parte do documento, na hora da conversão. Isso possibilita a
142divisão das fontes em diversos arquivos.
143
144- **Cada capítulo em uma pasta**
145
146  Você pode criar uma pasta para cada capítulo, armazenando as
147  fontes em uma estrutura de árvore. Dentro da pasta do capítulo,
148  você pode igualmente criar sub-pastas para armazenar imagens, 
149  arquivos incluídos e configurações.
150
151- **Sem conflito de arquivos**
152
153  Separando capítulos, diferentes equipes podem trabalhar em diferentes
154  capítulos com nenhuma interação entra elas. Cada equipe trabalha na
155  sua própria pasta, evitando conflito de arquivos devido as atuais
156  mudanças.
157
158- **Controle de acesso flexível**
159
160  Arquivos e pastas organizadas, você pode implementar regras de controle
161  de acesso, definindo propriedades e permissões para qualquer arquivo ou
162  capítulo. Faça uso das ferramentas padrões do sistema para configurar
163  as permissões de leitura/escrita, como o esquema "usuários e grupos".
164
165- **Visão global das fontes**
166
167  Estruturar as fontes também ajuda também ter uma visão global do livro,
168  usando qualquer navegador de arquivos para saber rapidamente a quantidade
169  de texto e imagens de qualquer capítulo. (sugestão: no UNIX, comandos
170  ``tree`` e ``du``)
171
172- **Trabalhe no seu capítulo, esqueça os outros**
173
174  Separando as fontes em arquivos, você pode converter seu capítulo sozinho,
175  não precisa esperar para processar todo o livro. Além de ser rápido para
176  converter, o capítulo sozinho pode ser enviado para revisores ou publicado
177  sozinho, como uma amostra do livro completo.
178
179- **Você separa, o txt2tags junta**
180
181  Durante a conversão, o txt2tags juntará automaticamente todos os capítulos na
182  edição final do livro, não importa quão profunda é a árvore de pastas.
183
184
185= Controle de Versões Facilitado =
186
187O txt2tags ajuda no controle de versão do livro com ferramentas baseadas em linhas 
188(como //CVS// e //Subversion//). As fontes são texto puro, nada de dados compilados.
189
190- **Trabalhe com linhas curtas**
191
192  Você pode criar linhas curtas, quebrando elas em 72 colunas. Isso ajudará
193  no controle de revisão, porque ele é baseado em linhas. Se o formato final
194  precisa que um parágrafo seja composto por uma simples linha comprida (como
195  PageMaker), o txt2tags irá juntar ela para você automaticamente.
196
197- **Fontes Legíveis**
198
199  Como o mínimo de marcações, as fontes ficam legíveis. Todos podem ver 
200  o que foi alterado de uma versão para outra, as marcas não escondem ou
201  poluem o texto.
202
203- **Conteúdos grandes, fontes pequenas**
204
205  Como é texto puro, você pode ter uma quantidade enorme de conteúdo, 
206  com baixo uso de disco. Pessoas podem fazer checkouts completos e 
207  commits rápidos mesmo em conexões lentas.
208
209- **Versionamento de capítulo**
210
211  Como visto antes, as fontes podem ser organizadas dentro de pastas.
212  Isso faz o controle de versão separada por capítulos, ou mesmo as  
213  seções dos capítulos, dependendo de quão granulado o controle precisa ser.
214
215
216= Material de Qualidade =
217
218Você pode escrever um livro, ou você pode escrever O Livro. O txt2tags
219tem ótimas características para aumentar a qualidade do seu trabalho.
220
221- **Verificador Ortográfico**
222
223  Como todas marcas do txt2tags são símbolos e não palavras, você
224  pode usar qualquer verificador de ortografia nas fontes. Ele
225  cuidará somente do texto, não tentará corrigir as marcas.
226
227- **Banco de dados de palavras-chave**
228  
229  O txt2tags tem um //Filtros de Entradas//
230  onde você pode definir pares de palavra-chave/valor. Onde quer que a
231  palavra chave seja encontrada nas fontes, ela será expandida ao valor dado
232  na hora da conversão. Por exemplo, você coloca a palavra ``URL_GOOGLE``
233  no seu texto e aparecerá como ``http://www.google.com`` no livro. Se a
234  URL do Google mudar, você apenas muda a definição do filtro e todas as 
235  ocorrências serão atualizadas. Você pode definir quantas palavras chaves
236  precisar, sem nenhum limite máximo.
237  
238- **Conteúdo Dinâmico**
239
240  O txt2tags também tem um comando para incluir textos pré-formatados
241  dentro do documento. Útil para incluir textos como um exemplo
242  de código fonte de software. Dessa maneira você pode manter esse 
243  exemplo de código separado do texto do livro e atualizá-lo manual ou
244  automaticamente. Uma idéia legal é marcar o código
245  fonte do software com comentários especiais, e um pequeno programa
246  extrai essas partes marcadas dentro de arquivos separados.
247
248- **Controle o Resultado**
249  
250  Txt2tags tem um //Filtros de Saída//
251  onde você pode definir regras que fazem os ajustes no documento
252  resultante. Então se a conversão padrão do txt2tags não satisfaz
253  completamente suas necessidades, você pode melhorá-la com seus próprios
254  filtros. Você pode usar o poder das Expressões Regulares para casar
255  padrões.
256
257
258= Outras Vantagens =
259
260E tem mais!
261
262- **Formatação Separada do Conteúdo**
263  
264  Usando HTML como o formato de desenvolvimento, você também pode usar
265  arquivos CSS para experimentar diferentes visuais para o livro. O CSS 
266  define formatações para páginas HTML, e há editores gráficos para criar
267  arquivos CSS. Uma equipe de designers pode trabalhar na criação de
268  arquivos CSS para o livro, enquanto os escritores continuam escrevendo.
269  
270- **Inclua Estruturas Complicadas**
271
272  O txt2tags tem suporte para todas estruturas usadas em textos: listas,
273  definições, citações, área pré-formatada e tabelas. Mas se alguma parte do 
274  seu livro precisar de uma estrutura complicada, você pode usar a
275  //inclusão literal//, onde você
276  insere o texto que já está formatado, como uma tabela HTML
277  complicada. Com o txt2tags, as exceções não são um 
278  problema!
279  
280- **Use Qualquer Editor**
281
282  Como os arquivos fontes são texto puro, mesmo o editor de textos mais
283  modesto no mundo pode ser usado para escrever um livro. Não precisa ter
284  nenhum característica além de escrever e salvar o texto. Se você usa os
285  editores com suporte ao txt2tags, você terá //Syntax Highlight// (destaque
286  da sintaxe), que ajuda a identificar as marcas do txt2tags. Eles são:
287  Vim, Emacs, Kate e Nano.
288
289- **Suporte Técnico**
290
291  O txt2tags tem vários canais para se obter suporte técnico: duas listas de 
292  email (inglês e português), um canal de IRC e uma comunidade no Orkut. E
293  para projetos de livros, você pode enviar um email diretamente para o
294  autor do programa, que lhe dará prioridade na resposta.
295
296
297= Nenhuma Ferramenta Serve Para Tudo =
298
299Há alguns casos especiais onde o txt2tags não é uma boa ferramenta
300para escrever livros.
301
302- **Livros Muito Complexos**
303
304  Livros que usam muitas tabelas complicadas, fórmulas ou estruturas
305  específicas, precisam de um editor gráfico ou uma linguagem de
306  marcação complexa, como LaTeX. Se seu livro bate com essa descrição,
307  DESCULPE.
308
309- **Notas de Rodapé**
310
311  O txt2tags não tem suporte a notas de rodapé. Se você usará apenas um
312  pouco, você pode adicioná-las depois. Mas se você planeja fazer uso
313  intenso de notas de rodapé, DESCULPE.
314
315- **Referências para Páginas, Tabelas e Imagens**
316
317  Você pode usar um editor gráfico na hora da finalização do livro para incluir
318  índices para páginas, tabelas e imagens. Mas se você
319  planeja referi-los dentro do texto como 
320   "//Veja a tabela 4.11 na página 35//", DESCULPE.
321
322  
323----------------------------------------------------------------------
324//Escrevendo Livros com o Txt2tags - Oct/2004//
325([veja o arquivo fonte %%infile])
326
327Traduzido por Ielton Ferreira Carneiro Pinto