Tutorial do Org-mode

Published on October 2, 2014.

Está página é uma tradução para o português do tutorial de David O’Toole.

Introdução

Org-mode é um gerenciador de informações pessoais e ferramenta de resumos para o Emacs. Este documento pretende oferecer ao leitor um “gostinho” do org-mode e também ensinar seu uso básico com um passo-a-passo e alguns screenchots. Em nenhum momento ele objetiva substituir o manual e apenas um subconjunto das funcionalidades do org-mode é coberto.

Esse tutorial tem sido traduzido para Francês, Espanhol, Japonês, Chinês, e Coreano. Agradecimentos especiais aos tradutores.

Obtendo o org-mode

Org-mode é parte do Emacs 22 e 23 e, portanto, se você estiver utilizando uma versão recente do Emacs você já possui ele.

Caso contrário, você pode baixá-lo na página do org-mode, descomprimi-lo e informar o Emacs que ele deve carregar o diretório onde o org-mode foi descomprimido:

(add-to-list 'load-path "PATH_TO_WHERE_YOU_UNPACKED_ORGMODE/lisp")

Ativação

Adicione as seguintes linhas no seu .emacs:

(require 'org)
(define-key global-map "\C-cl" 'org-store-link)
(define-key global-map "\C-ca" 'org-agenda)
(setq org-log-done t)

Isso irá garantir que o org-mode será carregado e que alguns atalhos globais são carregados. Iremos voltar ao “org-store-link” e “org-agenda” posteriormente.

Mais uma coisa—é aconselhável criar um diretório para armazenar os arquivos utilizados pelo org-mode. Recomenda-se utilizar ~/org.

O básico

Essa seção ilustra o uso básico do org-mode ao mostrar como utilizar o org-mode para criar este documento.

Criando um novo arquivo

Se você configurou o arquivo de inicialização do seu Emacs como sugerido, Emacs irá utilizar o org-mode toda vez que você visitar ou criar um arquivo com a extensão “.org”.

Criamos um novo arquivo chamado “OrgTutorial.org” e verificamos o indicador “Org” no modeline, mostrando que estamos no org-mode.

Lista de tarefas

Primeiramente criamos um cabeçalho chamado “Tarefas” para armazenar as taregas dentro. Isso não é necessário mas normalmente é conveniente, especialmente quando você quer manter tarefas separadas do corpo do documento que você está escrevendo.

O primeiro cabeçalho inicia com um asterisco; o segundo cabeçalho inicia com dois asteriscos, e assim segue.

No org-mode, itens TODO são sempre cabeçalhos. Criamos um item TODO para “Iniciar novo arquivo org para o tutorial.”

Esse item é um pouco inútil pois acabamos de criar o arquivo. Vamos então marcá-lo como DONE movendo o cursor para essa linha e pressionando C-c C-t, que irá executar org-todo.

Depois disso teremos:

Note que org-mode registra o tempo de quando uma tarega foi marcada como concluída.

Vamos adicionar mais alguns itens na nossa lista. Posicione o cursor na linha seguinte e pressione M-shift-RET para chamar org-insert-todo-heading. Você pode pressionar esse atalho várias vezes para adicionar vários TODOs.

Utilizando cabeçalhos para organizar o documento

Normalmente, a melhor forma de organizar suas ideias é em um esboço. O próximo passo é esboçar os diferentes tópicos do tutorial. Ao fazer isso, você quebra a página vazia em uma série de pequenos blocos. Assim fica fácil adicionar novos tópicos.

Lembre-se que um asterisco no começo da linha inicia um cabeçalho primário e dois asteriscos um cabeçalho secundário. Se você precisar de mais subdivisões você pode utilizar três ou mais asteriscos.

Depois de terminarmos o esboço do nosso documento ele deve estar como:

Note que marcamos “Esboçar documento” como feito depois de concluir essa tarefa.

Preenchendo as seções

Você pode facilmente adicionar um corpo de texto debaixo de cada seção.

Na seção “Obtendo Org-mode” é necessário fornecer um link para o website do org-mode. Uma sintaxe especial é utilizada para isso:

[[link][description]]

Note que depois de digitar o link e a descrição, mas ainda com o colchete aberto:

Ao fechar o colchete, a sintaxe especial é substituída pela descrição apenas.

Mova o cursor para o link e pressione C-c C-o para org-open-at-point.

Você também pode criar link para arquivos locais. Tente visitar outro arquivo—por exemplo, o arquivo de inicialização do seu Emacs. Pressione C-c l para chamar org-store-link. Você irá ver uma mensagem informando que um link para o arquivo atual foi armazenado em memória.

Voltando ao buffer do org-mod podemos colar o link utilizando C-c C-l para chamar org-insert-link. Você irá precisar utilizar as setas direcionais para encontrar o link que você acabou de gravar.)

Visão geral do documento

Com o tempo, o documento vai aumentando e não mais caberá em uma janela. Org-mode torna fácil ter uma visão geral do documento ao pressionar shift-TAB.

Note que apenas as seções são mostradas. Você pode pressionar novamente shift-TAB para mostrar todas as seções e subseções, incluindo itens TODO:

Ao pressionar uma terceira vez você irá voltar para a visão normal do documento:

Adicionando notas para uma tarefa

Você pode adicionar quanto texto desejar debaixo de um item TODO. Na verdade você pode ter seções dentro de um item TODO e itens TODO dentro de um TODO!

A possibilidade de fazer anotações nas tarefas torna fácil coletar links relacionados e pensamentos durante a execução da tarefa. E a possibilidade de ter sub-tarefas ajuda a modelar a forma de trabalhar—muitas vezes, uma tarefa maior pode ser quebrada em várias tarefas menores que podem ser concluídas rapidamente.

Algumas funcionalidades avançadas

Antes de acabarmos, vamos falar sobre a lista global de itens TODO, do agendamento e do calendário. Estes são utilizados para combinar itens TODO relevantes de diferentes arquivos em uma ordem de prioridade cronológica. Você também pode utilizá-los para ver quais tarefas foram concluídas e quando.

Configuração

Primeiro é preciso configurar a variável org-agenda-files para que o org-mode saiba quais arquivos devem ser utilizados na procura por itens TODO.

Vamos imaginar que já tenhamos vários arquivos org—digamos que um para o trabalho, outro para casa e um terceiro para a escola.

Você então adiciona o seguinte no arquivo de inicialização do seu Emacs:

(setq org-agenda-files (list "~/org/trabalho.org"
                             "~/org/escola.org"
                             "~/org/casa.org"))

A lista global de tarefas

Pressionando C-c a t abre a lista global de tarefas. Org-mode irá procurar nos arquivos listados em org-agenda-files e apresentar todos os itens TODO:

Você pode mover entre diferentes itens TODO e pressionar “t” para marcar um item como concluído ou pressionar RET para ir ao arquivo onde esse item está armazenado.

Agendamento de tarefas e o calendário

Digamos que queremos agendar o encerramento da tarefa para hoje. Movemos o cursor para a linha depois do item “Concluir documento”, e pressionamos C-c C-s para rodar org-shedule. O calendário irá aparecer e podemos digitar ou clicar na data desejada:

Uma vez que selecionamos a data, o org-mode irá inserir um marcador de agendamento com a data desejada depois do item TODO:

Agora salve o arquivo e pressione C-c a a para org-agenda. Você irá ver os itens agendados para a semana atual:

Agora pressione “l” (L minúsculo) para ativar a função log. Você irá encontrar todas as tarefas finalizadas e quando elas foram concluídas.

file:../images/dto/tutorial-15.png

Considerações finais

Esse foi apenas um pequeno tour pelo org-mode. Mais coisas lhe esperam em outros tutorias ou no online org-mode manual.

Cheat Sheet

Existe uma ótima cheat sheet em http://orgmode.org/orgcard.pdf. Alguns dos comandos que eu sempre tento lembrar são:


Shortcut Action TAB Cycling M-RETURN Insert heading C-c C-x M Insert TODO heading M-LEFT Demote heading M-RIGHT Promote heading C-c C-l Insert link C-c C-o Open link C-c C-q Insert tag C-c C-s Insert schedule C-c C-d Insert deadline C-c C-z Insert note C-c C-t Mark as DONE C-c $ Archive subtree C-c ^ Sort C-c C-x C-i Clock in C-c C-x C-o Clock out C-c C-x C-c Clock cancel C-c C-y Recompute the time interval C-c C-x C-d Total times will be added to each headline C-c C-x C-r Clock report C-c a a Show agenda C-c [ Add current file to the list of agenda files C-c ] Remove current file from the list of agenda files C-c a t Global TODO list


Tags: