Орг-режим - Org-mode

Орг-режим
Логотип в режиме организации
Оригинальный автор (ы)Карстен Доминик
Разработчики)Карстен Доминик, Бастьен Герри и другие.
Стабильный выпуск
9.4[1] / 14 сентября 2020 г.; 2 месяца назад (2020-09-14)
Репозиторий
Отредактируйте это в Викиданных
Написано вEmacs lisp
ТипУправление личной информацией, Делать заметки, Обрисовка, Грамотное программирование, Воспроизводимость
ЛицензияGPL
Интернет сайтorgmode.org

Орг-режим (также: Режим организации;[2] /ˈɔːrɡмoʊd/) - это режим редактирования, форматирования и организации документов, предназначенный для Примечания, планирование, и авторинг в пределах бесплатно программное обеспечение Текстовый редактор Emacs. Это имя используется для включения простых текстовых файлов ("файлов организации"), которые включают простые метки для обозначения уровней иерархии (например, план эссе, список тем с подтемами, вложенный компьютерный код и т. Д.), А также редактор с функциями, которые могут читать разметка и управлять элементами иерархии (раскрывать / скрывать элементы, перемещать блоки элементов, отмечать элементы списка дел и т. д.).

Org-mode был создан Карстеном Домиником в 2003 году, изначально для организации своей жизни и работы,[3] и с момента первого выпуска многие другие пользователи и разработчики внесли свой вклад в это бесплатно программное обеспечение упаковка.[4] Emacs включает Org-mode[5] как главный Режим по умолчанию. Бастьен Герри - текущий сопровождающий, в сотрудничестве с активным сообщество разработчиков.[6] После успеха в Emacs некоторые другие системы также начали предоставлять функции для работы с файлами org.

Практически ортогонально Org-mode имеет функции, направленные на выполнение кода на различных внешних языках; эти функции образуют org-babel.[7][8]

Система

На домашней странице Org-mode поясняется, что «по своей сути Org-mode - это простой инструмент для создания заметок и управления списками».[9] Автор организационной системы Карстен Доминик объясняет, что «Org-mode делает очерчивание, делать заметки, гиперссылки, электронные таблицы, Списки TODO, планирование проекта, GTD, HTML и Латекс авторинг, все с простой текст файлы в Emacs."[10]

Организационная система основана на простой текст файлы с простой разметкой, что делает файлы очень портативными. Информационный проект Linux объясняет, что «Обычный текст поддерживается почти каждой прикладной программой во всех операционных системах».[11]

В систему входит облегченный язык разметки для текстовых файлов (по функциям аналогичен Markdown, reStructuredText, Текстиль и т. д., с другой реализацией), позволяя иерархически разделять, маркировать, связывать строки или разделы обычного текста и т. д.

Функциональность

В этом разделе приведены некоторые примеры использования для иерархического отображения и редактирования простого текста.

  • Списки дел часто имеют подзадачи и поэтому поддаются иерархической системе. Org-mode облегчает это, позволяя элементам быть подразделяется в простые шаги (вложенные задачи и / или контрольные списки ), а также заданные теги и свойства, такие как приоритеты и сроки. An повестка дня элементы, которые должны быть выполнены на этой неделе или в день, затем могут быть автоматически сгенерированы из тегов даты.[12]
  • Простой текст очертания.[13]
Текстовый файл, показывающий дерево в emacs org-mode
Тот же файл org, показанный в обзоре в emacs org-mode
  • Файлы организации как связанные страницы личная вики, используя разметку для ссылок.
  • Отслеживание ошибок в проекте путем сохранения файлов .org в распределенный контроль версий система, такая как Git.
  • Обширные возможности создания ссылок на веб-страницы в одном файле, на другие файлы и на электронные письма, а также позволяют определять собственные ссылки.

Документ в организационном режиме также можно экспортировать в различные форматы (включая HTML, Латекс, OpenDocument или обычный текст), эти форматы используются для отображения структурного контура надлежащим образом (включая перекрестные ссылки, если необходимо). Он также может использовать разметку форматирования (включая LaTeX для математики) со средствами, аналогичными тем, которые присутствуют в Markdown или LaTeX, тем самым предлагая альтернативу этим инструментам.

Org-Babel

Org-mode предлагает возможность вставки исходного кода в редактируемый документ, который автоматически экспортируется и / или выполняется при экспорте документа; результаты, полученные с помощью этого кода, могут быть автоматически извлечены обратно в результирующий вывод.

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

Вместе со средствами разметки org-mode эти две функции позволяют

  • Грамотное программирование, отделив описание функций программы от ее структуры кода, и
  • Воспроизводимое исследование путем создания согласованного документа, объединяющего изложение, исходные данные, анализы, обсуждения и выводы таким образом, чтобы любой читатель мог воспроизвести их, используя те же программные инструменты.

По состоянию на ноябрь 2018 года org-babel напрямую поддерживает более 50 языков программирования или программируемых средств, более 20 других инструментов можно использовать через предоставленные пакеты или драйверы.[14].

Интеграция

Org-mode имеет некоторые функции для экспорта в другие форматы, а другие системы имеют некоторые функции для обработки форматов org-mode. Кроме того, полнофункциональный текстовый редактор может иметь функции для обработки вики-страниц, личных контактов, электронной почты, календарей и т. Д.; поскольку org-mode - это простой текст, эти функции также могут быть интегрированы в документы org-mode.

Из орг-режима дополнительные пакеты экспортируются в другие формат разметки Такие как MediaWiki (org-export-generic, org-export), чтобы флэш карта системы обучения, внедряющие SuperMemo алгоритмы (org-Drill, org-learn).[15]

Вне редакторов, работающих в режиме организации, разметка организации поддерживается GitLab и GitHub репозитории кода,[16] то JIRA трекер проблем,[17] Пандок, и другие.

Смотрите также

Рекомендации

  1. ^ "Режим организации для Emacs - Ваша жизнь в виде простого текста". orgmode.org. Команда OrgMode. Получено 2020-09-15.
  2. ^ Gmane: Org, Org-mode, Orgmode, Org Mode В архиве 2017-09-10 в Wayback Machine - Карстен Доминик: Орг, система; Org-mode, основной режим
  3. ^ Доминик, Карстен (2011-12-15), Emacs Org-mode: организация жизни и работы ученого (аннотация и видео), Институт неврологических исследований Макса Планка
  4. ^ Руководство по режиму организации: история и благодарности, Фонд свободного программного обеспечения
  5. ^ Корбет, Джонатан (2006), "Предварительное тестирование Emacs 22", LWN.net
  6. ^ Режим организации для Emacs - Сообщество
  7. ^ «Babel: активный код в Org-режиме». orgmode.org. Получено 2020-01-09.
  8. ^ Шульте, Эрик; Дэвисон, Дэн; Краска, Томас; Доминик, Карстен (25 января 2012 г.). «Многоязычная вычислительная среда для грамотного программирования и воспроизводимых исследований». Журнал статистического программного обеспечения. 46 (1): 1–24. Дои:10.18637 / jss.v046.i03. ISSN  1548-7660.
  9. ^ О'Тул, Дэвид, Руководство по организации
  10. ^ Доминик, Карстен, Техническое описание в 24 словах
  11. ^ Информационный проект Linux: Что такое обычный текст?
  12. ^ Чаван, Абхиджит (2007), "Организуйтесь с помощью Emacs Org-mode", Linux журнал
  13. ^ Чуа, Саша, Составление заметок с помощью Org
  14. ^ "Вавилон: языки". Получено 25 ноября 2018.
  15. ^ Внесенные пакеты в режиме организации и многие другие иерархические или ориентированные на списки форматы.
  16. ^ Разметка GitHub, 2020-01-11
  17. ^ Бао, Хаоцзюнь (2019-12-02), org-jira

дальнейшее чтение

Книги

журнальные статьи

внешняя ссылка