Adicionei bastante documentação, e exemplo de org-mode
This commit is contained in:
parent
0cbae00c05
commit
e2cc6e7ac8
58
README.org
58
README.org
|
@ -3,15 +3,41 @@
|
|||
|
||||
* Sobre
|
||||
|
||||
O Emacs Humanities é uma configuração do GNU Emacs feita para a produção de documentos acadêmicos das Ciências Humanas. O objetivo é incluir ferramentas que facilitem o trabalho de pesquisa, incluindo o processo de fichamento e anotação de textos, até a editoração de publicações finais.
|
||||
O Emacs Humanities é uma configuração do GNU Emacs feita para a produção de documentos acadêmicos das Ciências Humanas. O objetivo é providenciar uma configuração acessível de ferramentas facilitadoras do trabalho de pesquisa, desde os processos de fichamento, anotação, e síntese de textos, passando pela organização de informação de pesquisa até a editoração de publicações acadêmicas finais.
|
||||
|
||||
Aqui incluímos, até este momento, apenas configuração para uso do org-mode e org-roam, duas ótimas (possivelmente as melhores existentes) ferramentas para anotações, fichamentos e organização de mapas mentais.
|
||||
Aqui incluo, até este momento, apenas configuração para uso do org-mode e org-roam, duas ótimas (se não as melhores existentes) ferramentas para anotações e organização de mapas mentais. Demonstrações podem ser encontradas abaixo
|
||||
|
||||
O objetivo a longo prazo é incluir uma suíte completa de configurações, incluindo para a editoração em LaTeX por meio dos pacotes AucTeX e latex-mode, e análise de dados estatísticos em R, Julia e outros por meio do pacote ESS (Emacs Speaks Statistics).
|
||||
O objetivo a longo prazo é incluir uma suíte completa de configurações, com suporte para a editoração em LaTeX por meio dos pacotes AucTeX e latex-mode, e até análise de dados estatísticos em R, Python, Julia e outros por meio do pacote ESS (Emacs Speaks Statistics).
|
||||
|
||||
* Para aqueles que nunca usaram o Emacs
|
||||
* Anotações com org-mode
|
||||
|
||||
Para aqueles que não são familirizados com o GNU Emacs, temos aqui algumas recomendações:
|
||||
O org-mode é uma extensão muito popular para o Emacs. É o principal motivo pelo qual muitas pessoas não ligadas à programação ou computação fazem uso frequente do Emacs, tanto para fins pessoas quanto fins acadêmicos.
|
||||
|
||||
Em termos simples, o org-mode é uma linguagem de marcação, editoração, ou markup, feita para organização pessoal. Ele possibilita a criação de listas de afazeres, entradas de agenda, e outras formas de anotação pessoal, mas também permite a exportação destas anotações para documentos completos, usando uma conversão pelo LaTeX. Isto torna o org-mode uma ferramenta de alta utilidade: tem a simplicidade de uma linguagem simples como Markdown, mas todas as capacidades de uma linguagem completa como LaTeX.
|
||||
|
||||
** Guia rápido de org-mode
|
||||
|
||||
*** Formato simples
|
||||
|
||||
Arquivos do org-mode usam a extensão .org. A extensão é utilizada apenas para indicar a uso da linguagem na escrita do arquivo; o formato em si é texto simples, como arquivos .txt, e podem ser acessados por qualquer outro editor.
|
||||
|
||||
*** Sintaxe simples
|
||||
|
||||
Muitos dizem que o org-mode é inspirado pelo Markdown, outra linguagem de marcação comum, devido à similaridade das sintaxes de ambos. O org-mode é, na verdade, mais antigo que o Markdown, e possui uma sintaxe que é, em geral, mais simples, consistente e padronizada, e ao mesmo tempo mais abrangente e capaz.
|
||||
|
||||
*** Exemplo de org-mode
|
||||
|
||||
#+begin_src org
|
||||
,* Títulos (chamados headings) se denotam com um asterisco.
|
||||
,** Dois asteriscos indicam um subtítulo (subheading).
|
||||
,*** Três asteriscos indicam um subsubtítulo.
|
||||
,*** e assim vai...
|
||||
,**** Existem níveis infinitos de subsubsubsubs...títulos.
|
||||
|
||||
Títulos podem conter texto dentro de si. É
|
||||
|
||||
,**
|
||||
#+end_src
|
||||
|
||||
** Por onde começar
|
||||
|
||||
|
@ -19,6 +45,8 @@ O Emacs já vem com um tutorial em si, que contém informações básicas sobre
|
|||
|
||||
É recomendado que você faça o tutorial antes de ler o resto dessa documentação. A maior parte do conteúdo daqui é explicada em mais detalhes no tutorial. Esta documentação apenas sintetiza os conceitos do tutorial em uma referência rápida.
|
||||
|
||||
Outra coisa a mencionar: esse documento pode parecer longo e complexo, mas não se intimide; Não há porque ler esse manual todo de uma vez. Leia-o aos poucos, conforme precisar de alguma informação.
|
||||
|
||||
** Notação das teclas de atalho
|
||||
|
||||
Lendo o parágrafo acima, você já deve ter percebido a forma incomum de se denotar teclas de atalho. Esta notação é usada em toda a documentação do Emacs, e é explicada no tutorial. A forma é simples, fácil de ler, e curta para se escrever, mas não é utilizada por outros programas, então pode ser confusa para iniciantes. Segue aqui uma explicação rápida:
|
||||
|
@ -51,11 +79,17 @@ Não incluímos as teclas de navegação textual descritas no tutorial, pois pod
|
|||
- Teclas para manipular janelas:
|
||||
- C-x o para focar para a pŕoxima janela
|
||||
- C-x 0 para deletar a janela atual
|
||||
- C-x 1 para deletar todas as /outras/ janelas
|
||||
- C-x 2 para abrir uma janela abaixo da atual
|
||||
- C-x 3 para abrir uma janela à direita da atual
|
||||
- E finalmente teclas para acessar documentação, ajuda e o tutorial:
|
||||
- C-x 1 para deletar todas as /outras/ janelas exceto a atual
|
||||
- E finalmente, as teclas para acessar ajuda, documentação, e o tutorial. A auto-documentação é explicada em mais detalhes em seguida;
|
||||
- C-h k para descrever a função realizada por alguma tecla
|
||||
- C-h t para acessar o tutorial
|
||||
- C-h f para acessar a auto-documentação de uma função
|
||||
- C-h v para acessar a auto-documentação de uma variável (útil para fazer suas próprias configurações)
|
||||
- C-h ? para acessar a ajuda para o comando de ajuda
|
||||
- C-h m para descrever o modo atual e suas teclas de atalho (org-mode, por exemplo)
|
||||
- C-h f e C-h v para descrever funções e variáveis, respectivamente.
|
||||
|
||||
Experimente apertar alguma tecla de prefixo, como C-x, e sem apertar mais nada, esperar por um momento. O menu do which-key aparecerá, indicando todas as teclas de atalho disponíveis a partir da sua tecla de prefixo. Uma maneira intuitiva de explorar os comandos existentes. O which-key funciona para qualquer prefixo ou combinação de teclas, a qualquer momento. Não tenha medo de utilizá-lo.
|
||||
|
||||
** Acessando a documentação interna do Emacs
|
||||
|
||||
O Emacs possui um sistema único de auto-documentação, não encontrado em nenhum outro editor. Algumas funções são capazes de analisar e descrever informações sobre outras funções, variáveis, pacotes, e muito mais, essecialmente gerando documentação, instruções e ajuda para o usuário automaticamente. Isso torna o processo de aprendizagem e exploração das funcionalidades do editor muito mais orgânico; o usuário não precisa ler o manual de instruções inteiro para aprender sobre o editor. Basta apenas acessar a documentação para cada ponto individual que precisar.
|
||||
|
||||
As teclas de atalho da auto-documentação podem ser acessadas pelo prefixo C-h, como descrito na seção de teclas de atalho acima.
|
||||
|
|
Loading…
Reference in New Issue