Skip to content

masfj/ox-review

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

12 Commits
 
 
 
 
 
 
 
 

Repository files navigation

ox-review

https://melpa.org/packages/ox-review-badge.svg https://stable.melpa.org/packages/ox-review-badge.svg

What is this?

Generate .re files (Re:VIEW format files) directly from org-mode.

Install

You can install from MELPA repository.

M-x package-install [RET] ox-review [RET]

If ox-review not found, try the follwing action and install again.

M-x package-refresh-contents [RET]

To use the package, write the following code in your init file:

(require 'ox-review)

or if you are using use-package:

(use-package ox-review
  :ensure t)

Usage

This package adds a dedicated menu to the Org Export Dispatcher (org-export-dispatch), and pressing r on the menu activates the menu dedicated to the package. Continues, pressing R (Shift-r) export the conversion results to a temporary file, pressing r export the results to a file.

Column

If you want to use columns, add the headline_type property to the headline as follows:

** Column's
:PROPERTIES:
:headline_type: column
:END:

This paragraph is in column.

The headline_type property contains the following elements:

  • column
  • nonum
  • nodisp
  • notoc

Special blocks

The following blocks are represented as special blocks.

  • note
  • memo
  • tip
  • info
  • warning
  • imoprtant
  • caution
  • notice
  • lead

You must specify “review-” as a prefix for the special block. And only lead block has not caption.

#+begin_review-note
This is note block.
#+end_review-note

Limit

  • Some blocks – example, fixed width, property drawer, verbatim, and verse – is represented by quote block.
  • Radio target is represented itaric font. The link does not work.
  • Ruby text is not supported.
  • InDesign XML extensions is not supported.
  • Vertical writing is not supported.
  • Graph is not supported.