Sha256: 5c23d4eb5e851742713ea3c0650922a26d462df80ac47c8e1473f0d026c3ad0b

Contents?: true

Size: 1.73 KB

Versions: 4

Compression:

Stored size: 1.73 KB

Contents

def:[filtered_section|
	ref_macro[
		@n[{{markup}}_section]
		@desc[Creates a section (see %>[section]) whose content can be formatted with {{markup}} markup.]
		@aliases[{{aliases}}]
		@block_example[=
{{markup}}_section[
	@title[Test Section]
	@id[test]
Some *{{markup}}* text.
]
		=]
		@params[-p[0|The text of the section]]
		@attrs[
			-a[title|The title of the section &[opt]]
			-a[id|The ID of the section &[opt]]
			-a[notoc|If not blank, the header will not appear in the Table of Contents. &[opt]]
		]
	]
]
	ref_macro[
		@n[markdown]
		@desc[
Uses a Markdown converter (BlueCloth, RDiscount, Maruku or Kramdown) to transform the value into HTML if the =>[#cfg_output|code[output.*.filter_target]] setting is set to @html@.

&[called_on_files] with a @.markdown@ or a @.md@ extension. 
		]
		@aliases[md]
		@example[=markdown[This is *emphasized* text.]=]
		@params[-p[0|The Markdown text to filter.]]
	]

	filtered_section[
		@markup[markdown]
		@aliases[§md, md_section]
	]

	ref_macro[
		@n[textile]
		@desc[
Uses the RedCloth gem to transform the value into HTML or LaTeX, depending on the value of the =>[#cfg_output|code[output.*.filter_target]].

&[called_on_files] with a @.textile@ or a @.txt@ extension. 
		]
		@aliases[txt]
		@example[=textile[This is a *strong emphasis*.]=]
		@params[-p[0|The Textile text to filter.]]
	]

	filtered_section[
		@markup[textile]
		@aliases[§txt, txt_section]
	]

	ref_macro[
		@n[highlight]
		@desc[Highlights a piece of source code according to the specified language. fmi[code highligting|#source_code].]
		@block_example[=
highlight[ruby\|
  def hello
    puts "Hello World"
  end
]
		=]
		@params[
			-p[0|A programming language supported by the underlying highlighter.]
			-p[1|The code to highlight.]
		]
	]

Version data entries

4 entries across 4 versions & 1 rubygems

Version Path
glyph-0.5.3.1 book/text/macros/macros_filters.glyph
glyph-0.5.2 book/text/macros/macros_filters.glyph
glyph-0.5.1 book/text/macros/macros_filters.glyph
glyph-0.5.0 book/text/macros/macros_filters.glyph