Как сделать встроенные комментарии в режиме Org? - PullRequest
13 голосов
/ 09 февраля 2012

В режиме Org есть несколько способов комментировать .Но я не знаю ни одного способа сделать встроенные комментарии.Согласно инструкции

регионы, окруженные '# + BEGIN_COMMENT' ... '# + END_COMMENT', не будут экспортированы.

Но это верно только в том случае, еслиВ указанном регионе начинается строка.

В следующем

#+TITLE: Test

text #+BEGIN_COMMENT comment 1 #+END_COMMENT text

text
#+BEGIN_COMMENT comment 2 #+END_COMMENT text

только комментарий 2 рассматривается как комментарий.Он экспортирует (например, Ce A ) как

text # + комментарий BEGIN_COMMENT 1 # + END_COMMENT text

text

, org-toggle-comment не работает для создания встроенных комментариев, используя его для регионов, а comment-region даже не создает комментарий.

Итак, как я могу сделать встроенные комментарии в режиме Org?

Ответы [ 2 ]

8 голосов
/ 16 февраля 2012

Комментарий Джонатана Лича-Пепина к ваш вопрос по \printbibliography дал мне идею.Вы можете использовать макрос для встроенных комментариев.Обратите внимание, что вам нужно завершающий пробел после определения комментария.

#+macro: comment  

...

{{{comment(here is a comment)}}}

РЕДАКТИРОВАТЬ: Поскольку предполагается, что это нечетный ввод макроса, может все испортить.Я немного удивлен, что

{{{comment(here is a)}} comment)}}}

работает для меня, хотя

{{{comment(here is a comment) more}}}

не работает.Я предположил бы, что что-либо кроме довольно простого текста будет довольно хрупким, если они решат изменить способ синтаксического анализа макросов в будущем.

2 голосов
/ 24 ноября 2014

Другим способом будет использование фрагментов экспорта (определенных в Синтаксис Org (черновик) , поиск «Экспортировать фрагменты»), например так:

This is the @@comment:This is an inline comment@@ original text.

Я использовалслово comment, где бэкэнд экспорта должен быть только для ясности, вы можете использовать любое другое слово (кроме бэкэнда, в который вы экспортируете).

...