Class Orgmode::Parser
In: lib/org-ruby/parser.rb
Parent: Object

Simple routines for loading / saving an ORG file.

Methods

check_include_file   custom_keyword_regexp   export_exclude_tags   export_footnotes?   export_heading_number?   export_select_tags   export_tables?   export_todo?   get_include_data   load   new   parse_lines   set_mode_for_results_block_contents   set_name_for_code_block   skip_header_lines?   to_html   to_markdown   to_textile   use_sub_superscripts?  

Attributes

custom_keywords  [R]  Array of custom keywords.
header_lines  [R]  These are any lines before the first headline
headlines  [R]  All of the headlines in the org file
in_buffer_settings  [R]  This contains any in-buffer settings from the org-mode file. See orgmode.org/manual/In_002dbuffer-settings.html#In_002dbuffer-settings
lines  [R]  All of the lines of the orgmode file
options  [R]  This contains in-buffer options; a special case of in-buffer settings.

Public Class methods

load(fname, opts = {})

Creates a new parser from the data in a given file

new(lines, parser_options={ })

I can construct a parser object either with an array of lines or with a single string that I will split along \n boundaries.

Public Instance methods

check_include_file(file_path)

Check include file availability and permissions

custom_keyword_regexp()

Regexp that recognizes words in custom_keywords.

export_exclude_tags()

A set of tags that, if present on any headlines in the org-file, means that subtree will not get exported.

export_footnotes?()

Returns true if we are to export footnotes

export_heading_number?()

Returns true if we are to export heading numbers.

export_select_tags()

A set of tags that, if present on any headlines in the org-file, means only those headings will get exported.

export_tables?()

Should we export tables? Defaults to true, must be overridden with an explicit "nil"

export_todo?()

Returns true if we are to export todo keywords on headings.

get_include_data(line)

Get include data, when #+INCLUDE tag is used @link orgmode.org/manual/Include-files.html

skip_header_lines?()

Should we skip exporting text before the first heading?

to_html()

Converts the loaded org-mode file to HTML.

to_markdown()

Exports the Org mode content into Markdown format

to_textile()

Saves the loaded orgmode file as a textile file.

use_sub_superscripts?()

Should we export sub/superscripts? (_{foo}/^{foo}) only {} mode is currently supported.

[Validate]