A B C D E G I L M P R S T U W
All Classes All Packages

A

apply(String) - Method in class edu.odu.cs.cowem.documents.CommonEntitySubstitutions

Apply substitutions.

apply(String) - Method in class edu.odu.cs.cowem.documents.CWMcleaner

Apply substitutions.

apply(String) - Method in class edu.odu.cs.cowem.documents.ListingInjector

Apply substitutions.

apply(String) - Method in class edu.odu.cs.cowem.documents.PropertySubstitutions

Apply substitutions.

apply(String) - Method in class edu.odu.cs.cowem.documents.SourceCodeSubstitutions

Apply substitutions.

apply(String) - Method in interface edu.odu.cs.cowem.documents.TextSubstitutions

Apply substitutions.

apply(String) - Method in class edu.odu.cs.cowem.macroproc.Macro

Apply the macro to a string .

applyTo(Element, String) - Method in class edu.odu.cs.cowem.documents.urls.BlackboardURLs

Checks to see if a linking element (a or img) uses a special protocol label and, if so, attempts to rewrite the element.

applyTo(Element, String) - Method in class edu.odu.cs.cowem.documents.urls.DateURLs

Checks to see if a linking element (a or img) uses a special protocol label and, if so, attempts to rewrite the element.

applyTo(Element, String) - Method in class edu.odu.cs.cowem.documents.urls.DocURLs

Checks to see if a linking element (a or img) uses a special protocol label and, if so, attempts to rewrite the element.

applyTo(Element, String) - Method in class edu.odu.cs.cowem.documents.urls.DueDateURLs

Checks to see if a linking element (a or img) uses a special protocol label and, if so, attempts to rewrite the element.

applyTo(Element, String) - Method in class edu.odu.cs.cowem.documents.urls.GraphicsURLs

Checks to see if a linking element (a or img) uses a special protocol label and, if so, attempts to rewrite the element.

applyTo(Element, String) - Method in interface edu.odu.cs.cowem.documents.urls.SpecialURL

Checks to see if a linking element (a or img) uses a special protocol label and, if so, attempts to rewrite the element.

applyTo(Element, String) - Method in class edu.odu.cs.cowem.documents.urls.StylesURLs

Checks to see if a linking element (a or img) uses a special protocol label and, if so, attempts to rewrite the element.

B

BASE_URL_PROPERTY - Static variable in class edu.odu.cs.cowem.documents.PropertyNames

Name of the property holding the relative URL from a document to the website base directory.

BB_URL_PROPERTY - Static variable in class edu.odu.cs.cowem.documents.PropertyNames

Name of the property holding the URL of a Blackboard course site.

BlackboardURLs - Class in edu.odu.cs.cowem.documents.urls

Implements URL rewriting in course documents.

BlackboardURLs(String) - Constructor for class edu.odu.cs.cowem.documents.urls.BlackboardURLs

Create a URL rewriter.

C

CommonEntitySubstitutions - Class in edu.odu.cs.cowem.documents

A collection of text substitutions to repalce sommon HTML entities by their Unicode numeric equivalents.

CommonEntitySubstitutions() - Constructor for class edu.odu.cs.cowem.documents.CommonEntitySubstitutions

Create a substitution set.

copyBaseDocument() - Method in class edu.odu.cs.cowem.documents.SingleScrollDocument

copyComponentDocument(String) - Method in class edu.odu.cs.cowem.documents.SingleScrollDocument

CWMcleaner - Class in edu.odu.cs.cowem.documents

The pegDown processor gets confused by passthrough HTML display elements (though inline elements are OK)., often adding bogus <p> elements around the opening and/or closing tag, resulting in bad XML.

CWMcleaner() - Constructor for class edu.odu.cs.cowem.documents.CWMcleaner

Create a cleaner.

D

DateURLs - Class in edu.odu.cs.cowem.documents.urls

Implements URL rewriting in course documents.

DateURLs() - Constructor for class edu.odu.cs.cowem.documents.urls.DateURLs

Create a URL rewriter.

defineMacro(Macro) - Method in class edu.odu.cs.cowem.macroproc.MacroProcessor

Add a new macro to the processor state.

DIRECTORY_DEPTH_PROPERTY - Static variable in class edu.odu.cs.cowem.documents.PropertyNames

Name of the property holding the number of directory levels below the website base at which this document will reside.

Document - Interface in edu.odu.cs.cowem.documents

A document that can be transformed into a variety of HTML formats.

DOCUMENT_SET_PATH_PROPERTY - Static variable in class edu.odu.cs.cowem.documents.PropertyNames

Absolute path to directory containing the primary document.

documentSetGroup(String) - Method in class edu.odu.cs.cowem.documents.WebsiteProject

The name of the group to which a document set belongs.

documentSetLocation(String) - Method in class edu.odu.cs.cowem.documents.WebsiteProject

The location of a document set.

documentSource(String) - Method in class edu.odu.cs.cowem.documents.WebsiteProject

Source file from which we obtain a named document.

DocURLs - Class in edu.odu.cs.cowem.documents.urls

Implements URL rewriting in course documents.

DocURLs(File, WebsiteProject) - Constructor for class edu.odu.cs.cowem.documents.urls.DocURLs

Create a URL rewriter.

DueDateURLs - Class in edu.odu.cs.cowem.documents.urls

Implements URL rewriting in course documents.

DueDateURLs() - Constructor for class edu.odu.cs.cowem.documents.urls.DueDateURLs

Create a URL rewriter.

E

edu.odu.cs.cowem.documents - package edu.odu.cs.cowem.documents

Utilities for manipulating various kinds of source documents.

edu.odu.cs.cowem.documents.urls - package edu.odu.cs.cowem.documents.urls

Classes relating to URL rewriting.

edu.odu.cs.cowem.macroproc - package edu.odu.cs.cowem.macroproc

Provides a macro-processor used to permit conditional text and user-defined macros in Markdown documents.

extractContext(String, int, int) - Static method in class edu.odu.cs.cowem.documents.Utils

Given a message consisting of several lines, displays a selected line in context, highlighting an indicated column position.

G

generate() - Method in class edu.odu.cs.cowem.documents.SingleScrollDocument

Generate the single scroll package suitable for import

getBody() - Method in class edu.odu.cs.cowem.macroproc.Macro

getCourseName() - Method in class edu.odu.cs.cowem.documents.WebsiteProject

A short name for this course.

getDocumentTitle(String) - Method in class edu.odu.cs.cowem.documents.WebsiteProject

Title within a named document.

getExternalSite(String) - Method in class edu.odu.cs.cowem.documents.WebsiteProject

getFormalParams() - Method in class edu.odu.cs.cowem.macroproc.Macro

getMetadata(String) - Method in class edu.odu.cs.cowem.documents.MarkdownDocument

Extracts a desired metadata field from the document.

getModificationDate(File) - Method in class edu.odu.cs.cowem.documents.MarkdownDocument

Estimate the date on which this document was last modified.

getName() - Method in class edu.odu.cs.cowem.macroproc.Macro

getRootDir() - Method in class edu.odu.cs.cowem.documents.WebsiteProject

Get the root directory.

GraphicsURLs - Class in edu.odu.cs.cowem.documents.urls

Implements URL rewriting in course documents.

GraphicsURLs(String) - Constructor for class edu.odu.cs.cowem.documents.urls.GraphicsURLs

Create a URL rewriter.

I

iterator() - Method in class edu.odu.cs.cowem.documents.WebsiteProject

Iterate through all document sets.

L

ListingDocument - Class in edu.odu.cs.cowem.documents

A Document consisting of source code or uninterpreted data.

ListingDocument(File, WebsiteProject, Properties) - Constructor for class edu.odu.cs.cowem.documents.ListingDocument

Create a document from the given file.

ListingInjector - Class in edu.odu.cs.cowem.documents

Scans for longlisting elements and injects the code from a file as a CDATA field.

ListingInjector(File) - Constructor for class edu.odu.cs.cowem.documents.ListingInjector

Create a cleaner.

M

Macro - Class in edu.odu.cs.cowem.macroproc

A text substitution macro Macros can be called as name or name(arg1, arg2, ...) The ( ) in a macro call can be replaced by [ ] or { } or < > Macro calls are replaced by the macro body, with substitution for the macro parameters.

Macro(String, String) - Constructor for class edu.odu.cs.cowem.macroproc.Macro

Create a new macro with zero parameters.

Macro(String, List<String>, String) - Constructor for class edu.odu.cs.cowem.macroproc.Macro

Create a new macro.

MacroProcessor - Class in edu.odu.cs.cowem.macroproc

Transforms a text file via application of macros.

MacroProcessor() - Constructor for class edu.odu.cs.cowem.macroproc.MacroProcessor

Defines a new macro processor with no currently defined macros, using # as the command prefix.

MacroProcessor(String) - Constructor for class edu.odu.cs.cowem.macroproc.MacroProcessor

Defines a new macro processor with no currently defined macros.

MacroProcessor.ParseResult - Class in edu.odu.cs.cowem.macroproc

A description of an attempted command parse.

main(String[]) - Static method in class edu.odu.cs.cowem.macroproc.MacroProcessor

Driver for macro processor.

MarkdownDocument - Class in edu.odu.cs.cowem.documents

A Document written in Markdown that can be transformed to HTML in 3 steps: 1) pre-processing, 2) markdown to html conversion, and 3) post-processing.

MarkdownDocument(File, WebsiteProject, Properties) - Constructor for class edu.odu.cs.cowem.documents.MarkdownDocument

Create a document from the given file.

MarkdownDocument(File, WebsiteProject, Properties, String) - Constructor for class edu.odu.cs.cowem.documents.MarkdownDocument

Create a document from the given string.

P

ParseResult(String, int) - Constructor for class edu.odu.cs.cowem.macroproc.MacroProcessor.ParseResult

Create a parse result.

postprocess(Document, String) - Method in class edu.odu.cs.cowem.documents.MarkdownDocument

Transform HTML to desired output format and apply late substitutions of properties and other special strings.

preprocess(String) - Method in class edu.odu.cs.cowem.documents.MarkdownDocument

Prepare for processing: Apply macros and extract metadata.

PRIMARY_DOCUMENT_PROPERTY - Static variable in class edu.odu.cs.cowem.documents.PropertyNames

Name of the property holding the base name of a primary document.

process(BufferedReader) - Method in class edu.odu.cs.cowem.macroproc.MacroProcessor

Process a block of text obtained from a reader.

process(File) - Method in class edu.odu.cs.cowem.macroproc.MacroProcessor

Process a block of text obtained from a file.

process(String) - Method in class edu.odu.cs.cowem.documents.MarkdownDocument

Convert Markdown text to an HTML structure.

process(String) - Method in class edu.odu.cs.cowem.macroproc.MacroProcessor

Process a block of text.

PropertyNames - Class in edu.odu.cs.cowem.documents

Names of important course and document properties.

PropertySubstitutions - Class in edu.odu.cs.cowem.documents

Provides substitution of @name@ tokens by named values from a property set.

PropertySubstitutions(Properties) - Constructor for class edu.odu.cs.cowem.documents.PropertySubstitutions

Create a substitution set.

R

relativePathToDocumentSet(File, String) - Method in class edu.odu.cs.cowem.documents.WebsiteProject

Compute a relative path from a file to the directory containing some document set.

relativePathToRoot(File) - Method in class edu.odu.cs.cowem.documents.WebsiteProject

Determine the relative path from some file to the project root.

rewrite(Document) - Method in class edu.odu.cs.cowem.documents.urls.URLRewriting

Rewrite href attributes of "a" elements and src attributes of "img" and script elements that match the patterns listed above.

S

setBody(String) - Method in class edu.odu.cs.cowem.macroproc.Macro

setCourseName(String) - Method in class edu.odu.cs.cowem.documents.WebsiteProject

Save a short name for the course, after replacing any non-URL-safe characters.

setDebugMode(boolean) - Method in class edu.odu.cs.cowem.documents.MarkdownDocument

Turn indentation in generated XML on and off.

setFormalParams(List<String>) - Method in class edu.odu.cs.cowem.macroproc.Macro

setImports(Map<String, String>) - Method in class edu.odu.cs.cowem.documents.WebsiteProject

setName(String) - Method in class edu.odu.cs.cowem.macroproc.Macro

SingleScrollDocument - Class in edu.odu.cs.cowem.documents

Collects a base document (in scroll format) and all documents referenced within it via doc: links into a single scroll.

SourceCodeSubstitutions - Class in edu.odu.cs.cowem.documents

A collection of text substitutions, used primarily for mark up of source code with highlighting and callouts.

SourceCodeSubstitutions() - Constructor for class edu.odu.cs.cowem.documents.SourceCodeSubstitutions

Create a substitution set.

SpecialURL - Interface in edu.odu.cs.cowem.documents.urls

A variety of special URL protocols are supported in a and img elements, but rewritten during document processing.

StylesURLs - Class in edu.odu.cs.cowem.documents.urls

Implements URL rewriting in course documents.

StylesURLs(String) - Constructor for class edu.odu.cs.cowem.documents.urls.StylesURLs

Create a URL rewriter.

T

TextSubstitutions - Interface in edu.odu.cs.cowem.documents

Applies a set of text substitutions to a string.

toString() - Method in class edu.odu.cs.cowem.documents.SingleScrollDocument

toString() - Method in class edu.odu.cs.cowem.documents.WebsiteProject

Printable summary of project.

toString() - Method in class edu.odu.cs.cowem.macroproc.Macro

Render the macro as a string.

toXML() - Method in class edu.odu.cs.cowem.documents.SingleScrollDocument

transform(String) - Method in interface edu.odu.cs.cowem.documents.Document

Transform this document into a string suitable for writing into an HTML file.

transform(String) - Method in class edu.odu.cs.cowem.documents.ListingDocument

Transform this document into a string suitable for writing into an HTML file.

transform(String) - Method in class edu.odu.cs.cowem.documents.MarkdownDocument

Transform this document into a string suitable for writing into an HTML file.

U

URLRewriting - Class in edu.odu.cs.cowem.documents.urls

Implements URL rewriting in course documents.

URLRewriting(File, WebsiteProject, String) - Constructor for class edu.odu.cs.cowem.documents.urls.URLRewriting

Create a URL rewriter.

Utils - Class in edu.odu.cs.cowem.documents

Miscellaneous utility routines.

W

WebsiteProject - Class in edu.odu.cs.cowem.documents

Directory layout of a website project.

WebsiteProject(File) - Constructor for class edu.odu.cs.cowem.documents.WebsiteProject

Create a project summary object.

A B C D E G I L M P R S T U W
All Classes All Packages