Inserir rapidamente blocos de origem no modo organizacional

61

org-mode tem a capacidade de renderizar código-fonte, com blocos da seguinte sintaxe:

#+NAME: <name>
#+BEGIN_SRC <language> <switches> <header arguments>
    <body>
#+END_SRC

Existe um comando existente para inserir rapidamente esses blocos org-modeou preciso usar uma ferramenta externa como yasnippet?

org-mode org-babel Matthew Piziak
fonte
7
Existem várias maneiras: (1) Modelos fáceis internos (2) Usando o hydrapacote: blogpost (3) Outro trecho para facilitar a inserção do bloco de origem.
precisa
Se você está colando de Emacs, Emacs pode preencher o major-mode e backlink para você: github.com/unhammer/org-rich-yank#org-rich-paste
unhammer

Respostas:

89

Como @kaushalmodi menciona nos comentários, você pode usar (org) Easy Templatespara acelerar a inserção de diferentes tipos de blocos.

O procedimento geral é inserir <seguido por um seletor de modelo (geralmente uma única letra) em uma linha vazia e pressionar TAB.

O seletor de modelo para um modelo de bloco de origem genérico é s, portanto, digitar <sseguido de TABdará a você o seguinte:

#+BEGIN_SRC 

#+END_SRC

O ponto será posicionado no final da primeira linha.

Esta é uma boa primeira aproximação do que você deseja alcançar, mas este é o Emacs, então vamos torná-lo melhor!

Você pode definir modelos personalizados adicionando uma ou mais entradas a uma variável chamada org-structure-template-alist. Por exemplo:

(add-to-list 'org-structure-template-alist '("n" "#+NAME: ?"))

Esse código adiciona um #+NAME:modelo a org-structure-template-alist, usando ncomo um seletor de modelo. Após a expansão, esse ponto do modelo será posicionado no local de ?.

Se você sempre nomear seus blocos de código, também poderá sobrescrever a versão original do modelo de bloco de origem por uma versão estendida que inclua a #+NAME:linha:

(add-to-list 'org-structure-template-alist
             '("s" "#+NAME: ?\n#+BEGIN_SRC \n\n#+END_SRC"))

A digitação <sseguida por TABdará a você:

#+NAME: 
#+BEGIN_SRC 

#+END_SRC

Esta é apenas a ponta do iceberg; você pode usar uma abordagem semelhante para definir modelos adicionais para blocos de código específicos de idioma, blocos de código com argumentos de cabeçalho específicos etc.

itsjeyd
fonte
2
Nota: O Easy Template é substituído por um modo incompatível no HEAD do modo organizacional. Eu recomendo usar o yasnippet.
Lurdan #
@urdan ainda é esse o caso? Eu apenas tentei <s TABno Emacs 25 no Mac OS X e parecia funcionar.
precisa
1
@RudolfOlah Sim, pelo menos para o modo org (git) HEAD. Mesmo com o emacs26, o modo org incluído ainda tem org-try-structure-completionfunção (para Easy-templates). Mas, de qualquer maneira, ele será substituído pelos modelos de estrutura no futuro. cf. code.orgmode.org/bzg/org-mode/commit/…
lurdan #
14

Por que não escrever você mesmo?

(defun org-insert-source-block (name language switches header)
  "Asks name, language, switches, header.
Inserts org-mode source code snippet"
  (interactive "sname? 
slanguage? 
sswitches? 
sheader? ")
  (insert 
   (if (string= name "")
       ""
     (concat "#+NAME: " name) )
   (format "
#+BEGIN_SRC %s %s %s

#+END_SRC" language switches header
)
   )
  (forward-line -1)
  (goto-char (line-end-position))
  )
Adobe
fonte
6

Na minha caixa, 99% do tempo estou criando blocos de origem e 1% do tempo estou fazendo todo o resto. Os modelos Easy de 1% são perfeitos e os 99% eu tenho um YaSnippet.

  • Ele cria um NAMEuso exclusivo, org-idmas isso não importa apenas para nós) e, em seguida, pergunta-me qual idioma eu quero usar, limitando-o àqueles que eu disse à Programação Literada em Modo Orgânico (babel)
  • Apresenta uma lista de tipos de idioma que você informou ao Modo Orgânico que deseja usar e escolher, em vez de digitar todos os tipos (embora eu não os utilize todos)
  • Se o idioma precisar gerar um arquivo, ele solicitará o nome do arquivo de saída

Aqui está o YaSnippet com meu código de suporte no final.

# -*- mode: snippet -*-
# key: sc
# name: Source Block
# group: HELP
# contributor: [email protected]
# expand-env: ((yas-indent-line 'fixed))
# --
#+NAME: ${1:`(help/org-id-new)`}
#+BEGIN_SRC ${2:$$(let ((langs (sort (-map (lambda (x) (symbol-name (car x))) (if (-contains? org-babel-load-languages '(js . t)) (-snoc org-babel-load-languages '(javascript . t)) org-babel-do-load-languages)) 'string<))) (yas-choose-value (if (-contains? langs "shell") (-snoc langs "sh") langs)))}${2:$(when (-contains? '("ditaa" "dot" "plantuml") yas-text) (concat " :file \\"./image/" (yas-field-value 1) ".png\\""))} $3
$0
#+END_SRC

Requer dash e modo org carregado.

(require 'org-id)
(setq org-id-link-to-org-use-id 'nil)
(setq org-id-prefix (concat "org_" (user-real-login-name) "_" (format-time-string "%Y-%m-%d") "_" (system-name)))
(setq org-id-method 'uuid)
(defun help/org-id-new ()
  "Re-purposing `org-id' hit a snag when colons were forbidden in Source-Block
  names. Adding support for a user-defined Org-Id separator would have fixed
  this but with no benefit to Org-Id. So this function removes the colon
  instead.
 "
  (interactive)
  (let* ((gend (org-id-new))
         (newid (replace-regexp-in-string ":" "_" gend)))
    newid))

Aqui está um exemplo de que você pode esta função de identificação:

C-u M-:
(insert (help/org-id-new))

Resulta em

org_gcr_2017-08-06_mara_DD608C9A-33B0-4A8D-9123-298746BE973Anil
Grettke
fonte
2 
;;; package --- Summary
;;; Commentary:
;;; Code:
(defvar org-sai-src-default "C++"
 "This is the list used to store the default label for source code section.")

(defun org-insert-src-block ()
  "Insert the source code section in `org-mode'."
  (interactive)
  (let* ((src-code-types
          '("emacs-lisp" "python" "C" "sh" "java" "js" "clojure" "C++" "css"
            "calc" "asymptote" "dot" "gnuplot" "ledger" "lilypond" "mscgen"
            "octave" "oz" "plantuml" "R" "sass" "screen" "sql" "awk" "ditaa"
            "haskell" "latex" "lisp" "matlab" "ocaml" "org" "perl" "ruby"
            "scheme" "sqlite"))
         (src-prompt-str
          (concat "Source code type (default "
                  org-sai-src-default
                  "): "))
         (temp-src-code-types 
          (cons org-sai-src-default src-code-types))
         (src-type-str
          (completing-read src-prompt-str temp-src-code-types
                           nil nil nil nil org-sai-src-default)))
    (setq org-sai-src-default src-type-str))
    (insert (format "#+BEGIN_SRC %s\n" src-type-str))
    (newline)
    (org-indent-line)
    (insert "#+END_SRC\n")
    (forward-line -2))))

(add-hook 'org-mode-hook
          (lambda ()
            ;; keybinding for inserting code blocks
            (local-set-key (kbd "C-c s") 'org-insert-src-block)))

(provide 'orgAuxiliary)
;;; orgAuxiliary.el ends here
yixun bian
fonte