Mais documentação

This commit is contained in:
aabm 2020-08-20 22:09:25 -03:00
parent b8341b619d
commit e2a2b77e99
1 changed files with 35 additions and 3 deletions

View File

@ -13,7 +13,9 @@ O objetivo a longo prazo é incluir uma suíte completa de configurações, com
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.
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 básica como Markdown, mas todas as capacidades de uma linguagem completa como LaTeX.
O org-mode suporta exportação para vários formatos além de LaTeX, incluindo Markdown e HTML, e pode ser usado até para criação de páginas da web. Esta documentação está escrita em org, e assim recebe a formatação adequada na página do git do Emacs Humanities.
** Guia rápido de org-mode
@ -27,6 +29,8 @@ Muitos dizem que o org-mode é inspirado pelo Markdown, outra linguagem de marca
*** Exemplo de org-mode
Vale notar que as vírgulas no início das linhas não são presentes no org normal. Estão aqui só para que o texto não seja formatado pela página.
#+begin_src org
,* Títulos (chamados headings) se denotam com um asterisco.
,** Dois asteriscos indicam um subtítulo (subheading).
@ -34,9 +38,35 @@ Muitos dizem que o org-mode é inspirado pelo Markdown, outra linguagem de marca
,*** e assim vai...
,**** Existem níveis infinitos de subsubsubsubs...títulos.
Títulos podem conter texto dentro de si. É
Títulos podem conter texto dentro de si.
,** Texto!
Para inserir texto, basta apenas... inserir texto. Nada de tags de <p> ou qualquer coisa.
Para separar dois blocos de texto em parágrafos, apenas inclua uma linha vazia entre os dois.
Podemos também fazer algumas formatações básicas, como *negrito*, /itálico/, =realçado=, etc.
- Fazer listas também é fácil, basta usar um hífen seguido por um espaço logo ao início da linha, antes do texto
- Outro item de exemplo
- Listas também suportam sub-itens, que são indicados por um espaço antes do hífen do início
- outro subitem
- [ ] As listas também podem ser /checklists/, se possuírem colchetes separados por um espaço no início
- [-] As checklists são interativas. Elas se relacionam com seus subitens.
- [X] Subitem completo. Este é marcado por um X entre os colchetes. Para facilitar, não é necessário inserir o X manualmente. Há uma tecla de atalho para isso, C-c C-c, que torna a ação mais rápida.
- [ ] Subitem incompleto. Este marca o item acima com o sinal de compleção parcial, o hífen.
1. Pode-se fazer listas numeradas também, usando um número e um ponto.
2. Outro item numerado
1) Há outro formato para listas numeradas também, usando um parêntese.
2) Listas numeradas não suportam
,**
#+end_src
** Por onde começar
@ -93,3 +123,5 @@ Experimente apertar alguma tecla de prefixo, como C-x, e sem apertar mais nada,
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.