fix literal block format
This commit is contained in:
IGARASHI Masanao
416
README.org
416
README.org
@@ -18,8 +18,8 @@
|
||||
|
||||
Add the following in your init.el
|
||||
|
||||
#+BEGIN_SRC emacs-lisp
|
||||
(require 'ox-rst)
|
||||
#+BEGIN_SRC lisp
|
||||
(require 'ox-rst)
|
||||
#+END_SRC
|
||||
|
||||
* reStructuredText export
|
||||
@@ -44,18 +44,18 @@
|
||||
** Title, Author, E-Mail and Date
|
||||
|
||||
Org:
|
||||
#+BEGIN_SRC org-mode
|
||||
#+TITLE: This is the title of the document
|
||||
#+AUTHOR: Author
|
||||
#+EMAIL: mailaddress@example.com
|
||||
#+DATE: 2013/12/31 00:00
|
||||
#+OPTIONS: author:t date:t email:t
|
||||
#+END_SRC
|
||||
#+BEGIN_EXAMPLE
|
||||
,#+TITLE: This is the title of the document
|
||||
,#+AUTHOR: Author
|
||||
,#+EMAIL: mailaddress@example.com
|
||||
,#+DATE: 2013/12/31 00:00
|
||||
,#+OPTIONS: author:t date:t email:t
|
||||
#+END_EXAMPLE
|
||||
|
||||
reStructuredText:
|
||||
#+BEGIN_SRC rst-mode
|
||||
This is the title of the document
|
||||
==================================================================
|
||||
#+BEGIN_SRC rst
|
||||
This is the title of the document
|
||||
==================================================================
|
||||
|
||||
:Author: Author
|
||||
:Contact: mailaddress@example.com
|
||||
@@ -65,154 +65,153 @@ This is the title of the document
|
||||
** Headings
|
||||
|
||||
Org:
|
||||
#+BEGIN_SRC org-mode
|
||||
* Heading 1
|
||||
#+BEGIN_EXAMPLE
|
||||
,* Heading 1
|
||||
|
||||
contents 1
|
||||
contents 1
|
||||
|
||||
** Heading 1-1
|
||||
,** Heading 1-1
|
||||
|
||||
contents 1-1
|
||||
contents 1-1
|
||||
|
||||
*** Heading 1-1-3
|
||||
,*** Heading 1-1-3
|
||||
|
||||
contents 1-1-3
|
||||
#+END_SRC
|
||||
contents 1-1-3
|
||||
#+END_EXAMPLE
|
||||
|
||||
reStructuredText:
|
||||
#+BEGIN_SRC rst-mode
|
||||
Heading 1
|
||||
------------------
|
||||
#+BEGIN_SRC rst
|
||||
Heading 1
|
||||
------------------
|
||||
|
||||
contents 1
|
||||
contents 1
|
||||
|
||||
Heading 1-1
|
||||
~~~~~~~~~~~~~~~~~~~~~~
|
||||
Heading 1-1
|
||||
~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
contents 1-1
|
||||
contents 1-1
|
||||
|
||||
Heading 1-1-3
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
Heading 1-1-3
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
contents 1-1-3
|
||||
contents 1-1-3
|
||||
#+END_SRC
|
||||
|
||||
** Table of contents
|
||||
|
||||
Org:
|
||||
#+BEGIN_SRC org-mode
|
||||
#+OPTIONS: toc:t
|
||||
#+END_SRC
|
||||
#+BEGIN_EXAMPLE
|
||||
,#+OPTIONS: toc:t
|
||||
#+END_EXAMPLE
|
||||
|
||||
reStructuredText:
|
||||
#+BEGIN_SRC rst-mode
|
||||
.. contents::
|
||||
#+BEGIN_SRC rst
|
||||
.. contents::
|
||||
|
||||
#+END_SRC
|
||||
|
||||
** Lists
|
||||
|
||||
Org:
|
||||
#+BEGIN_SRC org-mode
|
||||
** Lord of the Rings
|
||||
1. The attack of the Rohirrim
|
||||
2. Eowyn's fight with the witch king
|
||||
#+BEGIN_EXAMPLE
|
||||
,** Lord of the Rings
|
||||
1. The attack of the Rohirrim
|
||||
2. Eowyn's fight with the witch king
|
||||
+ this was already my favorite scene in the book
|
||||
+ I really like Miranda Otto.
|
||||
3. Peter Jackson being shot by Legolas
|
||||
3. Peter Jackson being shot by Legolas
|
||||
- on DVD only
|
||||
He makes a really funny face when it happens.
|
||||
But in the end, no individual scenes matter but the film as a whole.
|
||||
Important actors in this film are:
|
||||
- Elijah Wood :: He plays Frodo
|
||||
- Sean Austin :: He plays Sam, Frodo's friend. I still remember
|
||||
But in the end, no individual scenes matter but the film as a whole.
|
||||
Important actors in this film are:
|
||||
- Elijah Wood :: He plays Frodo
|
||||
- Sean Austin :: He plays Sam, Frodo's friend. I still remember
|
||||
him very well from his role as Mikey Walsh in The Goonies.
|
||||
#+END_SRC
|
||||
#+END_EXAMPLE
|
||||
|
||||
reStructuredText:
|
||||
#+BEGIN_SRC rst-mode
|
||||
Lord of the Rings
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
#+BEGIN_SRC rst
|
||||
Lord of the Rings
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
1. The attack of the Rohirrim
|
||||
1. The attack of the Rohirrim
|
||||
|
||||
2. Eowyn's fight with the witch king
|
||||
2. Eowyn's fight with the witch king
|
||||
|
||||
- this was already my favorite scene in the book
|
||||
|
||||
- I really like Miranda Otto.
|
||||
|
||||
3. Peter Jackson being shot by Legolas
|
||||
3. Peter Jackson being shot by Legolas
|
||||
|
||||
- on DVD only
|
||||
|
||||
He makes a really funny face when it happens.
|
||||
|
||||
But in the end, no individual scenes matter but the film as a whole.
|
||||
Important actors in this film are:
|
||||
But in the end, no individual scenes matter but the film as a whole.
|
||||
Important actors in this film are:
|
||||
|
||||
Elijah Wood
|
||||
Elijah Wood
|
||||
He plays Frodo
|
||||
|
||||
Sean Austin
|
||||
Sean Austin
|
||||
He plays Sam, Frodo's friend. I still remember
|
||||
him very well from his role as Mikey Walsh in The Goonies.
|
||||
#+END_SRC
|
||||
|
||||
|
||||
** Special Characters
|
||||
|
||||
Org:
|
||||
#+BEGIN_SRC org-mode
|
||||
special characters * asterisk \ backspace
|
||||
.. reStructuredText comment line
|
||||
#+END_SRC
|
||||
#+BEGIN_EXAMPLE
|
||||
special characters * asterisk \ backspace
|
||||
.. reStructuredText comment line
|
||||
#+END_EXAMPLE
|
||||
|
||||
reStructuredText:
|
||||
#+BEGIN_SRC rst-mode
|
||||
special characters \* asterisk \\ backspace
|
||||
\.. reStructuredText comment line
|
||||
#+BEGIN_SRC rst
|
||||
special characters \* asterisk \\ backspace
|
||||
\.. reStructuredText comment line
|
||||
#+END_SRC
|
||||
|
||||
** Paragraphs
|
||||
|
||||
*note* Org line breaks =\\= will be ignored.
|
||||
*note* Org line breaks =\\= will be ignored.
|
||||
|
||||
*** Verse block
|
||||
|
||||
Org:
|
||||
#+BEGIN_SRC org-mode
|
||||
#+BEGIN_VERSE
|
||||
#+BEGIN_EXAMPLE
|
||||
,#+BEGIN_VERSE
|
||||
Great clouds overhead
|
||||
Tiny black birds rise and fall
|
||||
Snow covers Emacs
|
||||
|
||||
-- AlexSchroeder
|
||||
#+END_VERSE
|
||||
#+END_SRC
|
||||
,#+END_VERSE
|
||||
#+END_EXAMPLE
|
||||
|
||||
reStructuredText Line Blocks:
|
||||
#+BEGIN_SRC rst-mode
|
||||
| Great clouds overhead
|
||||
| Tiny black birds rise and fall
|
||||
| Snow covers Emacs
|
||||
|
|
||||
| -- AlexSchroeder
|
||||
|
|
||||
#+BEGIN_SRC rst
|
||||
| Great clouds overhead
|
||||
| Tiny black birds rise and fall
|
||||
| Snow covers Emacs
|
||||
|
|
||||
| -- AlexSchroeder
|
||||
|
|
||||
#+END_SRC
|
||||
|
||||
*** Quote block
|
||||
|
||||
Org:
|
||||
#+BEGIN_SRC org-mode
|
||||
#+BEGIN_QUOTE
|
||||
Everything should be made as simple as possible,
|
||||
#+BEGIN_EXAMPLE
|
||||
,#+BEGIN_QUOTE
|
||||
Everything should be made as simple as possible,
|
||||
but not any simpler -- Albert Einstein
|
||||
#+END_QUOTE
|
||||
#+END_SRC
|
||||
,#+END_QUOTE
|
||||
#+END_EXAMPLE
|
||||
|
||||
reStructuredText Literal Blocks:
|
||||
#+BEGIN_SRC rst-mode
|
||||
#+BEGIN_SRC rst
|
||||
::
|
||||
|
||||
Everything should be made as simple as possible,
|
||||
@@ -220,22 +219,22 @@ Everything should be made as simple as possible,
|
||||
#+END_SRC
|
||||
|
||||
Org:
|
||||
#+BEGIN_SRC org-mode
|
||||
#+ATTR_RST: :margin 4
|
||||
#+BEGIN_QUOTE
|
||||
Everything should be made as simple as possible,
|
||||
but not any simpler -- Albert Einstein
|
||||
#+END_QUOTE
|
||||
#+BEGIN_EXAMPLE
|
||||
,#+ATTR_RST: :margin 4
|
||||
,#+BEGIN_QUOTE
|
||||
Everything should be made as simple as possible,
|
||||
but not any simpler -- Albert Einstein
|
||||
,#+END_QUOTE
|
||||
|
||||
#+ATTR_RST: :margin 8
|
||||
#+BEGIN_QUOTE
|
||||
Everything should be made as simple as possible,
|
||||
but not any simpler -- Albert Einstein
|
||||
#+END_QUOTE
|
||||
#+END_SRC
|
||||
,#+ATTR_RST: :margin 8
|
||||
,#+BEGIN_QUOTE
|
||||
Everything should be made as simple as possible,
|
||||
but not any simpler -- Albert Einstein
|
||||
,#+END_QUOTE
|
||||
#+END_EXAMPLE
|
||||
|
||||
reStructuredText Block Quotes:
|
||||
#+BEGIN_SRC rst-mode
|
||||
#+BEGIN_SRC rst
|
||||
Everything should be made as simple as possible,
|
||||
but not any simpler -- Albert Einstein
|
||||
|
||||
@@ -244,34 +243,34 @@ but not any simpler -- Albert Einstein
|
||||
#+END_SRC
|
||||
|
||||
Org:
|
||||
#+BEGIN_SRC org-mode
|
||||
#+ATTR_RST: :directive note
|
||||
#+BEGIN_QUOTE
|
||||
Everything should be made as simple as possible,
|
||||
but not any simpler -- Albert Einstein
|
||||
#+END_QUOTE
|
||||
#+END_SRC
|
||||
#+BEGIN_EXAMPLE
|
||||
,#+ATTR_RST: :directive note
|
||||
,#+BEGIN_QUOTE
|
||||
Everything should be made as simple as possible,
|
||||
but not any simpler -- Albert Einstein
|
||||
,#+END_QUOTE
|
||||
#+END_EXAMPLE
|
||||
|
||||
reStructuredText Directives:
|
||||
#+BEGIN_SRC rst-mode
|
||||
.. note::
|
||||
#+BEGIN_SRC rst
|
||||
.. note::
|
||||
|
||||
Everything should be made as simple as possible,
|
||||
but not any simpler -- Albert Einstein
|
||||
#+END_SRC
|
||||
|
||||
Org:
|
||||
#+BEGIN_SRC org-mode
|
||||
#+ATTR_RST: :directive sidebar :title sidebar title
|
||||
#+BEGIN_QUOTE
|
||||
Everything should be made as simple as possible,
|
||||
but not any simpler -- Albert Einstein
|
||||
#+END_QUOTE
|
||||
#+END_SRC
|
||||
#+BEGIN_EXAMPLE
|
||||
,#+ATTR_RST: :directive sidebar :title sidebar title
|
||||
,#+BEGIN_QUOTE
|
||||
Everything should be made as simple as possible,
|
||||
but not any simpler -- Albert Einstein
|
||||
,#+END_QUOTE
|
||||
#+END_EXAMPLE
|
||||
|
||||
reStructuredText Directives with title:
|
||||
#+BEGIN_SRC rst-mode
|
||||
.. sidebar:: sidebar title
|
||||
#+BEGIN_SRC rst
|
||||
.. sidebar:: sidebar title
|
||||
|
||||
Everything should be made as simple as possible,
|
||||
but not any simpler -- Albert Einstein
|
||||
@@ -282,15 +281,15 @@ but not any simpler -- Albert Einstein
|
||||
Center block will not affect.
|
||||
|
||||
Org:
|
||||
#+BEGIN_SRC org-mode
|
||||
#+BEGIN_CENTER
|
||||
center block
|
||||
#+END_CENTER
|
||||
#+END_SRC
|
||||
#+BEGIN_EXAMPLE
|
||||
,#+BEGIN_CENTER
|
||||
center block
|
||||
,#+END_CENTER
|
||||
#+END_EXAMPLE
|
||||
|
||||
reStructuredText:
|
||||
#+BEGIN_SRC rst-mode
|
||||
center block
|
||||
#+BEGIN_SRC rst
|
||||
center block
|
||||
#+END_SRC
|
||||
|
||||
** Literal examples
|
||||
@@ -298,18 +297,16 @@ center block
|
||||
*** example block
|
||||
|
||||
Org:
|
||||
#+BEGIN_SRC org-mode
|
||||
#+NAME: label
|
||||
#+BEGIN_EXAMPLE
|
||||
example
|
||||
#+END EXAMPLE
|
||||
#+END_SRC
|
||||
|
||||
# maybe github org parser's bug
|
||||
,#+NAME: label
|
||||
,#+BEGIN_EXAMPLE
|
||||
example
|
||||
,#+END EXAMPLE
|
||||
#+END_EXAMPLE
|
||||
|
||||
reStructuredText:
|
||||
#+BEGIN_SRC rst-mode
|
||||
::
|
||||
#+BEGIN_SRC rst
|
||||
::
|
||||
:name: label
|
||||
|
||||
example
|
||||
@@ -318,17 +315,15 @@ example
|
||||
*** src block
|
||||
|
||||
Org:
|
||||
#+BEGIN_SRC org-mode
|
||||
#+BEGIN_SRC org-mode
|
||||
(require 'ox-rst)
|
||||
#+END SRC
|
||||
#+END_SRC
|
||||
|
||||
# maybe github org parser's bug
|
||||
#+BEGIN_EXAMPLE
|
||||
,#+BEGIN_SRC lisp
|
||||
(require 'ox-rst)
|
||||
,#+END SRC
|
||||
#+END_EXAMPLE
|
||||
|
||||
reStructuredText:
|
||||
#+BEGIN_SRC rst-mode
|
||||
.. code-block:: org-mode
|
||||
#+BEGIN_SRC rst
|
||||
.. code-block:: lisp
|
||||
|
||||
(require 'ox-rst)
|
||||
#+END_SRC
|
||||
@@ -336,40 +331,40 @@ example
|
||||
** Emphasis and monospace
|
||||
|
||||
Org:
|
||||
#+BEGIN_SRC org-mode
|
||||
*bold* /italic/ _underlined_ =code= ~verbatim~ +strike-through+
|
||||
#+END_SRC
|
||||
#+BEGIN_EXAMPLE
|
||||
,*bold* /italic/ _underlined_ =code= ~verbatim~ +strike-through+
|
||||
#+END_EXAMPLE
|
||||
|
||||
reStructuredText:
|
||||
#+BEGIN_SRC rst-mode
|
||||
**bold** *italic* underlined ``code`` ``verbatim`` strike-through
|
||||
#+BEGIN_SRC rst
|
||||
,**bold** *italic* underlined ``code`` ``verbatim`` strike-through
|
||||
#+END_SRC
|
||||
|
||||
** Horizontal rules
|
||||
|
||||
Org:
|
||||
#+BEGIN_SRC org-mode
|
||||
-----
|
||||
#+END_SRC
|
||||
#+BEGIN_EXAMPLE
|
||||
-----
|
||||
#+END_EXAMPLE
|
||||
|
||||
reStructuredText:
|
||||
#+BEGIN_SRC rst-mode
|
||||
------------
|
||||
#+BEGIN_SRC rst
|
||||
------------
|
||||
#+END_SRC
|
||||
|
||||
|
||||
** Comment block
|
||||
|
||||
Org:
|
||||
#+BEGIN_SRC org-mode
|
||||
#+BEGIN_COMMENT
|
||||
comment
|
||||
#+END_COMMENT
|
||||
#+END_SRC
|
||||
#+BEGIN_EXAMPLE
|
||||
,#+BEGIN_COMMENT
|
||||
comment
|
||||
,#+END_COMMENT
|
||||
#+END_EXAMPLE
|
||||
|
||||
reStructuredText:
|
||||
#+BEGIN_SRC rst-mode
|
||||
..
|
||||
#+BEGIN_SRC rst
|
||||
..
|
||||
comment
|
||||
#+END_SRC
|
||||
|
||||
@@ -378,29 +373,29 @@ comment
|
||||
*** Images
|
||||
|
||||
Org:
|
||||
#+BEGIN_SRC org-mode
|
||||
#+ATTR_RST: :alt alternate text :align right
|
||||
[[./image.jpg]]
|
||||
#+END_SRC
|
||||
#+BEGIN_EXAMPLE
|
||||
,#+ATTR_RST: :alt alternate text :align right
|
||||
[[./image.jpg]]
|
||||
#+END_EXAMPLE
|
||||
|
||||
reStructuredText:
|
||||
#+BEGIN_SRC rst-mode
|
||||
.. image:: ./image.jpg
|
||||
#+BEGIN_SRC rst
|
||||
.. image:: ./image.jpg
|
||||
:alt: alternate text
|
||||
:align: right
|
||||
#+END_SRC
|
||||
|
||||
Org:
|
||||
#+BEGIN_SRC org-mode
|
||||
#+CAPTION: image caption
|
||||
#+NAME: label
|
||||
#+ATTR_RST: :alt alternate text :align center :scale 50%
|
||||
[[./image.jpg]]
|
||||
#+END_SRC
|
||||
#+BEGIN_EXAMPLE
|
||||
,#+CAPTION: image caption
|
||||
,#+NAME: label
|
||||
,#+ATTR_RST: :alt alternate text :align center :scale 50%
|
||||
[[./image.jpg]]
|
||||
#+END_EXAMPLE
|
||||
|
||||
reStructuredText:
|
||||
#+BEGIN_SRC rst-mode
|
||||
.. figure:: ./image.jpg
|
||||
#+BEGIN_SRC rst
|
||||
.. figure:: ./image.jpg
|
||||
:alt: alternate text
|
||||
:align: center
|
||||
:scale: 50%
|
||||
@@ -408,25 +403,24 @@ comment
|
||||
image caption
|
||||
#+END_SRC
|
||||
|
||||
|
||||
*** Tables
|
||||
|
||||
Org:
|
||||
#+BEGIN_SRC org-mode
|
||||
|------+------+------|
|
||||
| TOP1 | TOP2 | TOP3 |
|
||||
|------+------+------|
|
||||
| 1 | 2 | 3 |
|
||||
|------+------+------|
|
||||
| AAAA | BBBB | CCCC |
|
||||
|------+------+------|
|
||||
| END1 | END2 | END3 |
|
||||
|------+------+------|
|
||||
#+END_SRC
|
||||
#+BEGIN_EXAMPLE
|
||||
|------+------+------|
|
||||
| TOP1 | TOP2 | TOP3 |
|
||||
|------+------+------|
|
||||
| 1 | 2 | 3 |
|
||||
|------+------+------|
|
||||
| AAAA | BBBB | CCCC |
|
||||
|------+------+------|
|
||||
| END1 | END2 | END3 |
|
||||
|------+------+------|
|
||||
#+END_EXAMPLE
|
||||
|
||||
reStructuredText:
|
||||
#+BEGIN_SRC rst-mode
|
||||
.. table::
|
||||
#+BEGIN_SRC rst
|
||||
.. table::
|
||||
|
||||
+------+------+------+
|
||||
| TOP1 | TOP2 | TOP3 |
|
||||
@@ -440,23 +434,23 @@ comment
|
||||
#+END_SRC
|
||||
|
||||
Org:
|
||||
#+BEGIN_SRC org-mode
|
||||
#+CAPTION: caption
|
||||
#+NAME: label
|
||||
|------+------+------|
|
||||
| TOP1 | TOP2 | TOP3 |
|
||||
|------+------+------|
|
||||
| 1 | 2 | 3 |
|
||||
|------+------+------|
|
||||
| AAAA | BBBB | CCCC |
|
||||
|------+------+------|
|
||||
| END1 | END2 | END3 |
|
||||
|------+------+------|
|
||||
#+END_SRC
|
||||
#+BEGIN_EXAMPLE
|
||||
,#+CAPTION: caption
|
||||
,#+NAME: label
|
||||
|------+------+------|
|
||||
| TOP1 | TOP2 | TOP3 |
|
||||
|------+------+------|
|
||||
| 1 | 2 | 3 |
|
||||
|------+------+------|
|
||||
| AAAA | BBBB | CCCC |
|
||||
|------+------+------|
|
||||
| END1 | END2 | END3 |
|
||||
|------+------+------|
|
||||
#+END_EXAMPLE
|
||||
|
||||
reStructuredText:
|
||||
#+BEGIN_SRC rst-mode
|
||||
.. table:: caption
|
||||
#+BEGIN_SRC rst
|
||||
.. table:: caption
|
||||
:name: label
|
||||
|
||||
+------+------+------+
|
||||
@@ -473,31 +467,31 @@ comment
|
||||
** Hyperlinks
|
||||
|
||||
Org:
|
||||
#+BEGIN_SRC org-mode
|
||||
[[http://orgmode.org][Org Mode]]
|
||||
#+BEGIN_EXAMPLE
|
||||
[[http://orgmode.org][Org Mode]]
|
||||
|
||||
[[http://orgmode.org]]
|
||||
[[http://orgmode.org]]
|
||||
|
||||
[[label]]
|
||||
#+END_SRC
|
||||
[[label]]
|
||||
#+END_EXAMPLE
|
||||
|
||||
reStructuredText:
|
||||
#+BEGIN_SRC rst-mode
|
||||
`Org Mode <http://orgmode.org/>`_
|
||||
#+BEGIN_SRC rst
|
||||
`Org Mode <http://orgmode.org/>`_
|
||||
|
||||
`http://orgmode.org`_
|
||||
`http://orgmode.org`_
|
||||
|
||||
`label`_
|
||||
`label`_
|
||||
#+END_SRC
|
||||
|
||||
** Export reStructuredText fragments
|
||||
|
||||
Org:
|
||||
#+BEGIN_SRC org-mode
|
||||
#+RST: .. class:: alert
|
||||
#+END_SRC
|
||||
#+BEGIN_EXAMPLE
|
||||
,#+RST: .. class:: alert
|
||||
#+END_EXAMPLE
|
||||
|
||||
reStructuredText:
|
||||
#+BEGIN_SRC rst-mode
|
||||
.. class:: alert
|
||||
#+BEGIN_SRC rst
|
||||
.. class:: alert
|
||||
#+END_SRC
|
||||
|
||||
Reference in New Issue
Block a user