Быстро вставляйте исходные блоки в режиме орг.

61

org-mode имеет возможность визуализации исходного кода, с блоками следующего синтаксиса:

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

Существует ли существующая команда для быстрой вставки этих блоков org-modeили мне нужно использовать внешний инструмент, например yasnippet?

org-mode org-babel Мэтью Пизиак
источник
7
Есть несколько способов: (1) встроенные простые шаблоны (2) использование hydrapackage: blogpost (3) еще один фрагмент для легкой вставки исходного блока org.
Каушал Моди
Если вы вставляете из Emacs, Emacs может заполнить мажорный режим и обратную ссылку для вас: github.com/unhammer/org-rich-yank#org-rich-paste
unhammer

Ответы:

89

Как @kaushalmodi упоминает в комментариях, вы можете использовать, (org) Easy Templatesчтобы ускорить вставку различных типов блоков.

Общая процедура является вставка с <последующим селектор шаблона (обычно одной буквой) на другой пустой строке и нажмите TAB.

Селектор шаблонов для общего шаблона исходного блока есть s, поэтому <sпосле ввода введите TAB:

#+BEGIN_SRC 

#+END_SRC

Точка будет расположена в конце первой линии.

Это хорошее первое приближение к тому, чего вы хотите достичь, но это Emacs, так что давайте сделаем это лучше!

Вы можете определить пользовательские шаблоны, добавив одну или несколько записей в переменную с именем org-structure-template-alist. Например:

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

Этот код добавляет #+NAME:шаблон org-structure-template-alist, используя его nкак селектор шаблона. После расширения этого шаблона точка будет располагаться в месте расположения ?.

Если вы всегда называете свои блоки кода, вы также можете перезаписать исходную версию шаблона исходного блока расширенной версией, содержащей #+NAME:строку:

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

Набрав с <sпоследующим, TABвы получите:

#+NAME: 
#+BEGIN_SRC 

#+END_SRC

Это только верхушка айсберга; Вы можете использовать аналогичный подход для определения дополнительных шаблонов для блоков кода для конкретного языка, блоков кода с определенными аргументами заголовка и т. д.

itsjeyd
источник
2
Примечание: простой шаблон заменен несовместимым способом в режиме заголовка. Я рекомендую использовать ясниппет.
Лурдан
@ lurdan это все еще так? Я только что попробовал <s TABEmacs 25 на Mac OS X, и это, похоже, сработало.
Рудольф Олах
1
@RudolfOlah Да, по крайней мере для заголовка org-mode (git). Даже с emacs26, в связанном режиме org есть org-try-structure-completionфункция (для Easy-шаблонов). Но, в любом случае, в будущем он будет заменен структурами-шаблонами. ср code.orgmode.org/bzg/org-mode/commit/…
лурдан
14

Почему бы не написать это самостоятельно?

(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))
  )
саман
источник
6

На моем ящике 99% времени я создаю исходные блоки, а 1% времени я делаю все остальное. Для 1% удобные шаблоны идеальны, а для 99% у меня есть YaSnippet.

  • Он создает уникальное NAMEиспользование, org-idно это не имеет значения только для нас), а затем спрашивает меня, какой язык я хочу использовать, ограничивая его теми, которые я сказал Org-Mode Literate Programming (babel)
  • Представляет список языковых типов, которые вы указали Org-Mode, которые вы хотите использовать, и выбирать из них вместо ввода каждого типа (хотя я не использую все из них)
  • Если язык должен генерировать файл, он запрашивает имя выходного файла

Вот YaSnippet с моим кодом поддержки в конце.

# -*- mode: snippet -*-
# key: sc
# name: Source Block
# group: HELP
# contributor: gcr@wisdomandwonder.com
# 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

Требуется загрузка в режиме тире и орг.

(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))

Вот пример вашей функции id:

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

Результаты в

org_gcr_2017-08-06_mara_DD608C9A-33B0-4A8D-9123-298746BE973Anil
grettke
источник
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
источник