Module: Paru

Defined in:: lib/paru.rb,
lib/paru/info.rb,
lib/paru/error.rb,
lib/paru/filter.rb,
lib/paru/pandoc.rb,
lib/paru/selector.rb,
lib/paru/filter/div.rb,
lib/paru/filter/row.rb,
lib/paru/filter/str.rb,
lib/paru/filter/attr.rb,
lib/paru/filter/cell.rb,
lib/paru/filter/cite.rb,
lib/paru/filter/code.rb,
lib/paru/filter/emph.rb,
lib/paru/filter/link.rb,
lib/paru/filter/list.rb,
lib/paru/filter/math.rb,
lib/paru/filter/meta.rb,
lib/paru/filter/node.rb,
lib/paru/filter/note.rb,
lib/paru/filter/null.rb,
lib/paru/filter/para.rb,
lib/paru/filter/span.rb,
lib/paru/pandoc2yaml.rb,
lib/paru/filter/block.rb,
lib/paru/filter/image.rb,
lib/paru/filter/plain.rb,
lib/paru/filter/space.rb,
lib/paru/filter/table.rb,
lib/paru/filter/value.rb,
lib/paru/filter_error.rb,
lib/paru/filter/figure.rb,
lib/paru/filter/header.rb,
lib/paru/filter/inline.rb,
lib/paru/filter/quoted.rb,
lib/paru/filter/strong.rb,
lib/paru/filter/target.rb,
lib/paru/filter/caption.rb,
lib/paru/filter/version.rb,
lib/paru/filter/citation.rb,
lib/paru/filter/col_spec.rb,
lib/paru/filter/document.rb,
lib/paru/filter/meta_map.rb,
lib/paru/filter/metadata.rb,
lib/paru/filter/int_value.rb,
lib/paru/filter/meta_bool.rb,
lib/paru/filter/meta_list.rb,
lib/paru/filter/raw_block.rb,
lib/paru/filter/strikeout.rb,
lib/paru/filter/subscript.rb,
lib/paru/filter/table_end.rb,
lib/paru/filter/underline.rb,
lib/paru/filter/code_block.rb,
lib/paru/filter/line_block.rb,
lib/paru/filter/line_break.rb,
lib/paru/filter/meta_value.rb,
lib/paru/filter/raw_inline.rb,
lib/paru/filter/small_caps.rb,
lib/paru/filter/soft_break.rb,
lib/paru/filter/table_body.rb,
lib/paru/filter/table_foot.rb,
lib/paru/filter/table_head.rb,
lib/paru/filter/block_quote.rb,
lib/paru/filter/bullet_list.rb,
lib/paru/filter/empty_block.rb,
lib/paru/filter/meta_blocks.rb,
lib/paru/filter/meta_string.rb,
lib/paru/filter/superscript.rb,
lib/paru/filter/empty_inline.rb,
lib/paru/filter/meta_inlines.rb,
lib/paru/filter/ordered_list.rb,
lib/paru/filter/short_caption.rb,
lib/paru/filter/inner_markdown.rb,
lib/paru/filter/definition_list.rb,
lib/paru/filter/horizontal_rule.rb,
lib/paru/filter/list_attributes.rb,
lib/paru/filter/ast_manipulation.rb,
lib/paru/filter/definition_list_item.rb

Overview

This file is part of Paru

Paru is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

Paru is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with Paru. If not, see <www.gnu.org/licenses/>. ++

Defined Under Namespace

Modules: PandocFilter Classes: Error, Filter, FilterError, Info, Pandoc, Pandoc2Yaml, Selector, SelectorParseError

Constant Summary collapse

VERSION = Paru’s current version

[1, 5, 1].freeze

PANDOC_BLOCK = Paru filter is a wrapper around pandoc’s JSON api, which is based on pandoc-types. Pandoc treats block elements and inline elements differently. Pandoc’s block elements are:

%w[
  Plain
  Para
  LineBlock
  CodeBlock
  RawBlock
  BlockQuote
  OrderedList
  BulletList
  DefinitionList
  Header
  HorizontalRule
  Table
  TableHead
  TableFoot
  TableBody
  Row
  Cell
  Figure
  Caption
  Div
  Null
].freeze

PANDOC_INLINE = Pandoc’s inline elements are

%w[
  Str
  Emph
  Underline
  Strong
  Strikeout
  Superscript
  Subscript
  SmallCaps
  Quoted
  Cite
  Code
  Space
  SoftBreak
  LineBreak
  Math
  RawInline
  Link
  Image
  Note
  Span
].freeze

PANDOC_TYPES = All of pandoc’s type together:

PANDOC_BLOCK + PANDOC_INLINE