Как я могу неявно организовать грамотный код в режиме org?

Question

Как я могу неявно организовать грамотный код в режиме org?

Я разрабатываю режим Stack Exchange для Emacs и пытаюсь использовать грамотное программирование (с org-mode) организовать проект.

Я обнаружил, что повторяю много информации. Я придерживаюсь (возможно, чрезмерно) структурированного подхода к документу. Скажи, у меня есть заголовок Questions; под этим заголовком существуют подзаголовки Read а также Write и у меня на высшем уровне

;; some-package.el starts here
<<read methods>>
<<write methods>>
;; some-package.el ends here

Как я могу изменить свойства Read а также Write заголовки такие, что все блоки исходного кода внутри, если не указано иное, будут помещены в их соответствующие запутывания noweb?

Вот что я делаю сейчас:

* TODO Stack Mode (Entry Point): =stack-mode=
Stack mode is /the/ major mode.  What do I mean by this?  Stack mode
is the entry point of the whole package.  There is no other way to
obtain the full, original functionality of the package without first
running =M-x stack-mode=.  Stack Mode is the only mode available
interactively.  It is a dispatcher that decides, based on user
preferences, how the whole system shall behave.  It provides the basic
framework upon which the rest of the package is built, and makes sure
all tools are available.

#+name: build-stack-mode
#+begin_src emacs-lisp :tangle elisp/stack.el
  ;; stack.el starts here

  (add-to-list 'load-path "~/github/vermiculus/stack-mode")

  <<stack-require-dependencies>>
  <<stack-setup-customization>>
  <<stack-setup-keymap>>
  <<stack-setup-api>>
  <<stack-load-children>>

  (provide 'stack)

  ; stack.el ends here
#+end_src

Thus, there are a few packages that it itself requires.

JSON (JavaScript Object Notation) is the standard by which we
communicate with Stack Exchange itself.  The details of this
communication has [[id:DC2032C5-BC11-47E2-8DDB-34467C2BC479][already been discussed]] so I will not repeat myself
here.  The JSON package provides many utilities for manipulating JSON
snippets within Emacs Lisp, and is required for the operation of this
package.  =json.el= is included with Emacs 24+ (and can easily be
obtained from the ELPA if missing).
#+name: stack-require-dependencies
#+begin_src emacs-lisp
  (require 'json)
#+end_src

This package also requires =request.el=, a package designed to
simplify making HTTP requests.  =request.el= was written by [[http://stackru.com/users/727827][SX@tkf]] and
is maintained and documented on [[http://tkf.github.com/emacs-request/manual.html][GitHub]]. The package is also available
for automatic install via MELPA.
#+name: stack-require-dependencies
#+begin_src emacs-lisp
  (require 'request)
#+end_src

#+name: stack-require-dependencies
#+begin_src emacs-lisp
  (require 'stack-api)
#+end_src

Simply put, =defgroup= defines a customization group for the graphical
interface within Emacs.  Since it pulls all of the customizable
settings together and how to customize them, it is also useful as a
'word bank' of sorts for customizing the package manually.  Every
customizable variable in the entire package is listed here.
#+name: stack-setup-customization
#+begin_src emacs-lisp
    (defgroup stack-exchange
      nil
      "Stack Exchange mode."
      :group 'environment)
#+end_src

Every mode needs a hook, so we here define one.  This hook is run
/after/ stack-mode is finished loading (when called interactively or
from Emacs Lisp).
#+name: stack-setup-customization
#+begin_src emacs-lisp
  (defvar stack-mode-hook nil)
#+end_src

In addition to a hook, most if not all major modes define their own
key-map.  Stack mode as a whole is no exception, but remembering the
nature of =stack-mode= as a dispatcher, a key-map seems out of place
here.  As such, the official key-map for =stack-mode= defines all keys
to be =nil= except those that are necessary for the smooth use of
Emacs as an operating system.  Such necessary keystrokes include
=C-g=, =M-x=, and others.
#+name: stack-setup-keymap
#+begin_src emacs-lisp
  (defvar stack-mode-map
    (let ((map (make-sparse-keymap)))
      map)
    "Keymap for Stack Exchange major mode.  This keymap is not
    used.")
#+end_src
...

Вот что я хотел бы сделать:

(Ctrl + F для ** и посмотрите на ящик для вещей.)

* TODO Stack Mode (Entry Point): =stack-mode=
Stack mode is /the/ major mode.  What do I mean by this?  Stack mode
is the entry point of the whole package.  There is no other way to
obtain the full, original functionality of the package without first
running =M-x stack-mode=.  Stack Mode is the only mode available
interactively.  It is a dispatcher that decides, based on user
preferences, how the whole system shall behave.  It provides the basic
framework upon which the rest of the package is built, and makes sure
all tools are available.

#+name: build-stack-mode
#+begin_src emacs-lisp :tangle elisp/stack.el
  ;; stack.el starts here

  (add-to-list 'load-path "~/github/vermiculus/stack-mode")

  <<stack-require-dependencies>>
  <<stack-setup-customization>>
  <<stack-setup-keymap>>
  <<stack-setup-api>>
  <<stack-load-children>>

  (provide 'stack)

  ; stack.el ends here
#+end_src
** Require Dependencies
:PROPERTIES:
:noweb-key: stack-require-dependencies
:END:
Thus, there are a few packages that it itself requires.

JSON (JavaScript Object Notation) is the standard by which we
communicate with Stack Exchange itself.  The details of this
communication has [[id:DC2032C5-BC11-47E2-8DDB-34467C2BC479][already been discussed]] so I will not repeat myself
here.  The JSON package provides many utilities for manipulating JSON
snippets within Emacs Lisp, and is required for the operation of this
package.  =json.el= is included with Emacs 24+ (and can easily be
obtained from the ELPA if missing).
#+begin_src emacs-lisp
  (require 'json)
#+end_src

This package also requires =request.el=, a package designed to
simplify making HTTP requests.  =request.el= was written by [[http://stackru.com/users/727827][SX@tkf]] and
is maintained and documented on [[http://tkf.github.com/emacs-request/manual.html][GitHub]]. The package is also available
for automatic install via MELPA.
#+begin_src emacs-lisp
  (require 'request)
#+end_src

#+begin_src emacs-lisp
  (require 'stack-api)
#+end_src
** Customization
:PROPERTIES:
:noweb-key: stack-setup-customization
:END:
Simply put, =defgroup= defines a customization group for the graphical
interface within Emacs.  Since it pulls all of the customizable
settings together and how to customize them, it is also useful as a
'word bank' of sorts for customizing the package manually.  Every
customizable variable in the entire package is listed here.
#+begin_src emacs-lisp
    (defgroup stack-exchange
      nil
      "Stack Exchange mode."
      :group 'environment)
#+end_src

Every mode needs a hook, so we here define one.  This hook is run
/after/ stack-mode is finished loading (when called interactively or
from Emacs Lisp).
#+begin_src emacs-lisp
  (defvar stack-mode-hook nil)
#+end_src
** Keymap
:PROPERTIES:
:noweb-key: stack-setup-keymap
:END:
In addition to a hook, most if not all major modes define their own
key-map.  Stack mode as a whole is no exception, but remembering the
nature of =stack-mode= as a dispatcher, a key-map seems out of place
here.  As such, the official key-map for =stack-mode= defines all keys
to be =nil= except those that are necessary for the smooth use of
Emacs as an operating system.  Such necessary keystrokes include
=C-g=, =M-x=, and others.
#+begin_src emacs-lisp
  (defvar stack-mode-map
    (let ((map (make-sparse-keymap)))
      map)
    "Keymap for Stack Exchange major mode.  This keymap is not
    used.")
#+end_src
** Load Children...

7

emacs org-mode literate-programming org-babel

Источник

user1443496 01 дек '13 в 19:39

2 ответа

Решение

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

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

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

* Stack Mode

** customisation

** get from stack exchange

** edit post

** send back to stack exchange

Я не уверен, имеют ли они отношение или нет, но вот идея. Некоторые из этих функций потребуют определенных зависимостей. Так, например, у вас может быть что-то вроде этого:

* Stack Mode (Entry Point): =stack-mode=

Stack mode is /the/ major mode.  What do I mean by this?  Stack mode
is the entry point of the whole package.  There is no other way to
obtain the full, original functionality of the package without first
running =M-x stack-mode=.  Stack Mode is the only mode available
interactively.  It is a dispatcher that decides, based on user
preferences, how the whole system shall behave.  It provides the basic
framework upon which the rest of the package is built, and makes sure
all tools are available.

#+NAME: build-stack-mode
#+HEADER: :noweb    tangle
#+HEADER: :comments both
#+HEADER: :tangle   elisp/stack.el
#+BEGIN_SRC emacs-lisp 
  (add-to-list 'load-path "~/github/vermiculus/stack-mode")

  <<stack-require-dependencies>>
  <<stack-definitions>>
  <<stack-initialisation>>
  <<stack-customisaton>>
  <<stack-functions>>

  (provide 'stack)
#+END_SRC

** customisation

*** definitions
:PROPERTIES:
:noweb-ref: stack-definitions
:END:
Simply put, =defgroup= defines a customization group for the graphical
interface within Emacs.  Since it pulls all of the customizable
settings together and how to customize them, it is also useful as a
'word bank' of sorts for customizing the package manually.  Every
customizable variable in the entire package is listed here.

#+BEGIN_SRC emacs-lisp
  (defgroup stack-exchange
    nil
    "Stack Exchange mode."
    :group 'environment)
#+END_SRC

Every mode needs a hook, so we here define one.  This hook is run
/after/ stack-mode is finished loading (when called interactively or
from Emacs Lisp).

#+BEGIN_SRC emacs-lisp
  (defvar stack-mode-hook nil)
#+END_SRC

*** functions

Whatever is required here

#+NAME: stack-functions
#+BEGIN_SRC emacs-lisp

#+END_SRC

** setup
*** Keymap

In addition to a hook, most if not all major modes define their own
key-map.  Stack mode as a whole is no exception, but remembering the
nature of =stack-mode= as a dispatcher, a key-map seems out of place
here.  As such, the official key-map for =stack-mode= defines all keys
to be =nil= except those that are necessary for the smooth use of
Emacs as an operating system.  Such necessary keystrokes include
=C-g=, =M-x=, and others.
#+NAME: stack-definitions
#+BEGIN_SRC emacs-lisp
  (defvar stack-mode-map
    (let ((map (make-sparse-keymap)))
      map)
    "Keymap for Stack Exchange major mode.  This keymap is not
    used.")
#+END_SRC

** get from stack exchange
*** get post
**** dependencies
:PROPERTIES:
:noweb-ref: stack-require-dependencies
:END:

JSON (JavaScript Object Notation) is the standard by which we
communicate with Stack Exchange itself.  The details of this
communication has [[id:DC2032C5-BC11-47E2-8DDB-34467C2BC479][already been discussed]] so I will not repeat myself
here.  The JSON package provides many utilities for manipulating JSON
snippets within Emacs Lisp, and is required for the operation of this
package.  =json.el= is included with Emacs 24+ (and can easily be
obtained from the ELPA if missing).

#+BEGIN_SRC emacs-lisp
  (require 'json)
#+END_SRC

This package also requires =request.el=, a package designed to
simplify making HTTP requests.  =request.el= was written by [[http://stackru.com/users/727827][SX@tkf]] and
is maintained and documented on [[http://tkf.github.com/emacs-request/manual.html][GitHub]]. The package is also available
for automatic install via MELPA.

#+BEGIN_SRC emacs-lisp
  (require 'request)
#+END_SRC
**** functions

get the actual post

#+NAME: stack-functions
#+BEGIN_SRC emacs-lisp

#+END_SRC

*** parse post
**** dependencies
JSON (JavaScript Object Notation) is the standard by which we
communicate with Stack Exchange itself.  The details of this
communication has [[id:DC2032C5-BC11-47E2-8DDB-34467C2BC479][already been discussed]] so I will not repeat myself
here.  The JSON package provides many utilities for manipulating JSON
snippets within Emacs Lisp, and is required for the operation of this
package.  =json.el= is included with Emacs 24+ (and can easily be
obtained from the ELPA if missing).
#+NAME: stack-require-dependencies
#+BEGIN_SRC emacs-lisp
  (require 'json)
#+END_SRC
**** functions
*** display post
** edit post
** send back to stack exchange
*** dependencies
#+NAME: stack-require-dependencies
#+BEGIN_SRC emacs-lisp
  (require 'stack-api)
#+END_SRC
*** functions

#+NAME: stack-functions
#+BEGIN_SRC emacs-lisp
  (send-back-function)
#+END_SRC

Конечно, это всего лишь пример, и я не знаю, как программировать на lisp, но я просто хотел продемонстрировать вам и всем, кто мог бы прочитать это, что вам не нужно группировать свои идеи таким образом, это имеет смысл для компьютера. Фактически, весь смысл грамотного программирования состоит в том, чтобы организовать вещи таким образом, чтобы это имело смысл для людей. Поэтому иногда имеет смысл быть явным, а не искажать мыслительный процесс в соответствии с компьютерным.

Удачи!

3

Источник

user5737344 02 янв '16 в 05:09

Другие вопросы по тегам emacs org-mode literate-programming org-babel

user973603 02 дек '13 в 15:55 2013-12-02 15:55 · Accepted Answer · 2013-12-02 15:55

:noweb-ref header ( http://orgmode.org/manual/noweb_002dref.html) помогает распространять имена ссылок noweb на поддеревья, используя наследование свойств.

4

Источник

user973603 02 дек '13 в 15:55