ROSE
0.11.96.11
|
Renders markup as plain text.
This isn't fancy–it's got just enough smarts so a user can read the documentation when a more capable formatter like perldoc is not available.
Definition at line 21 of file DocumentTextMarkup.h.
#include <DocumentTextMarkup.h>
Public Member Functions | |
virtual bool | emit (const std::string &doc) |
Emit documentation to output. | |
bool | doingPageHeader () const |
Property: Whether to create a page header. | |
TextMarkup & | doingPageHeader (bool b) |
Property: Whether to create a page header. | |
bool | doingPageFooter () const |
Property: Whether to create a page footer. | |
TextMarkup & | doingPageFooter (bool b) |
Property: Whether to create a page footer. | |
Public Member Functions inherited from Sawyer::Document::BaseMarkup | |
BaseMarkup & | title (const std::string &pageName, const std::string &chapterNumber, const std::string &chapterTitle) |
Set title properties. More... | |
BaseMarkup & | version (const std::string &versionString, const std::string &versionDate) |
Set version properties. More... | |
virtual std::string | operator() (const std::string &) |
Parse input to generate POD. | |
const std::string & | pageName () const |
Property: Page name. More... | |
BaseMarkup & | pageName (const std::string &s) |
Property: Page name. More... | |
const std::string & | chapterNumber () const |
Property: Chapter number. More... | |
BaseMarkup & | chapterNumber (const std::string &s) |
Property: Chapter number. More... | |
const std::string & | chapterNumberOrDefault () const |
Property: Chapter number. More... | |
const std::string & | chapterTitle () const |
Property: Chapter title. More... | |
BaseMarkup & | chapterTitle (const std::string &s) |
Property: Chapter title. More... | |
const std::string & | chapterTitleOrDefault () const |
Property: Chapter title. More... | |
const std::string & | versionString () const |
Property: Version string. More... | |
BaseMarkup & | versionString (const std::string &s) |
Property: Version string. More... | |
const std::string & | versionStringOrDefault () const |
Property: Version string. More... | |
const std::string & | versionDate () const |
Property: Version date. More... | |
BaseMarkup & | versionDate (const std::string &s) |
Property: Version date. More... | |
const std::string & | versionDateOrDefault () const |
Property: Version date. More... | |
Public Member Functions inherited from Sawyer::Document::Markup::Grammar | |
Grammar & | with (const Function::Ptr &) |
Insert function. More... | |
virtual std::string | operator() (const std::string &s) const |
Evaluate an entire string. | |
Additional Inherited Members | |
Static Public Member Functions inherited from Sawyer::Document::BaseMarkup | |
static bool | hasNonSpace (const std::string &) |
True if this string contains any non-blank characters. | |
static std::string | makeOneLine (const std::string &) |
Remove linefeeds. | |
static std::string | leftJustify (const std::string &, size_t width) |
Left justify a string in a field of width N (or more). More... | |
static std::string | escapeSingleQuoted (const std::string &) |
Escape single quoted string content. | |
Static Public Member Functions inherited from Sawyer::Document::Markup::Grammar | |
static std::string | unescape (const std::string &s) |
Expand escape sequences "@@", "@{" and "@}". | |
static std::string | escape (const std::string &s) |
Escape all special "@", "{", and "}". | |