| Method declaration |
Description |
Entry#parent() |
|
Entry::new(aData = {}) |
| aData: | the content of this Entry
|
|
Entry#hide?() |
Returns true if this entry is hidden (the ‘hide’ parameter is
enabled).
|
Entry#summary() |
Returns the summarized HTML content of this blog entry. If there is no
summary or summarization is not possible, then returns nil.
|
Entry#absolute_url() |
Returns the absolute URL to this entry.
|
Entry#<=>(aOther) |
Sort chronologically.
|
Entry#html() |
Transforms the content of this entry into HTML and returns it.
|
Entry#comment_url() |
Returns a URL for submiting comments about this entry.
|
Chapter::new(aName) |
|
Chapter#[](aName, *args) |
Allows you to access a section using its name or through the usual Ruby
array access idioms.
|
Language::new(aData = {}) |
|
Language#[](aPhrase, *aArgs) |
Translates the given string and then formats (see String#format) the
translation with the given placeholder arguments. If the translation is not
available, then the given string will be used instead.
|
Template::new(aName, *args) |
| aName: | String that replaces the ambiguous ’(erb)’ identifier in stack
traces, so that the user can better determine the source of an error.
|
| args: | Arguments for ERB::new
|
|
Template#render_with(aInstVars = {}) |
Renders this template within a fresh object that is populated with the
given instance variables.
|
Section#url() |
Path (relative to the output/ directory) to the HTML output file of this
object.
|
Section::new(aName, aChapter) |
|
Section#<=>(aOther) |
Sort alphabetically.
|
String#to_file_name() |
Transforms this string into a vaild file name that can be safely used in a
URL. See en.wikipedia.org/wiki/URI_scheme#Generic_syntax
|
String#to_html_entities() |
Transforms this UTF-8 string into HTML entities.
|
String#to_uri_fragment() |
Transforms this string into a valid URI fragment. See www.nmt.edu/tcc/help/pubs/xhtml/id-type.html
|
String#thru_erb(aBinding = Kernel.binding) |
Passes this string through ERB and returns the result.
|
String#shell_escape() |
Transforms this string into an escaped POSIX shell argument whilst
preserving Unicode characters.
|
String#table_of_contents() |
Builds a table of contents from XHTML headings (<h1>, <h2>,
etc.) found in this string and returns an array containing [toc, html]
where:
| toc: | the generated table of contents
|
| html: | a modified version of this string which contains anchors for the hyperlinks
in the table of contents (so that the TOC can link to the content in this
string)
|
|
String#to_inline_html() |
Transforms this string into an inline HTML string (one that does not
contain any block-level HTML elements at the root).
|
String#to_html(aInline = false) |
Transforms this string into HTML while ensuring that the result contains
one or more block-level elements at the root.
If aInline is true, then the resulting HTML will be an inline
string.
|
String#thru_redcloth(aInline = false) |
Returns the result of running this string through RedCloth.
If aInline is true, then the resulting HTML will be an inline
string.
|
String#thru_coderay() |
Adds syntax coloring to <code> elements in the given text. If the
<code> tag has an attribute lang="…", then that is
considered the programming language for which appropriate syntax coloring
should be applied. Otherwise, the programming language is assumed to be
ruby.
|
String#digest() |
Returns a digest of this string‘s content.
|
String#protect(aInput, aTags, aVerbatim) {|aInput| ... } |
Protects the given tags in the given input, passes that protected input to
the given block, restores the given tags in the result of the block and
returns it.
If aVerbatim is true, the content of the elments having the given tags will
not be temporarily altered so that process nested elements can be
processed.
|
File::write(aPath, aContent) |
Writes the given content to the given file.
|
TemplateMixin#template_name() |
Basename of the template file, which resides in the config/ directory, used
to render objects of this class.
|
TemplateMixin#template() |
Returns the template used to render objects of this class.
|
TemplateMixin#template_ivar() |
Returns the name of the instance variable for objects of this class. This
variable is used in the template of this class.
|
TemplateMixin#url() |
Path (relative to the output/ directory) to the HTML output file of this
object.
|
TemplateMixin#uri_fragment() |
Returns a URI fragment for this object.
|
TemplateMixin#parent_url() |
Returns a URL to the parent page which takes you directly to this item
inside the parent page.
|
TemplateMixin#to_html(aOpts = {}) |
Transforms this object into HTML.
|
TemplateMixin#render(aOpts = {}) |
Renders a complete HTML page for this object.
|
TemplateMixin#to_link(aOpts = {}) |
Returns a relative link to this object, customized by the following
options:
| frag: | a URI fragment that is appended to the URL, if given.
|
| body: | sets the body of the link (the <a> tag), if given.
|
| nbsp: | makes spaces in the link body non-breaking, if true.
|
|
