Commit Graph

4 Commits

Author SHA1 Message Date
Jonathan Bernard
a86b55726f Added file and inline link anchors.
* Auto-link for documents. If there is an `org` directive in the first doc
  block of the file then it is used as the file link definition. If there is no
  such `org` directive then on is created automatically. This resolves issue
  #0008. There is a new LinkAnchor type for these links: `LinkType.FileLink`
* Multiple `org` directives per DocBlock are now allowed. There is a new
  LinkAnchor link type for these link: `LinkType.InlineLink`.
* Refactored `LinkType.OrgLink` to be `LinkType.BlockLink`.
* Tweaked CSS
* Refactored `LiterateMarkdownGenerator.emit(DocBlock)` for simplicity.
2012-01-06 14:41:01 -06:00
Jonathan Bernard
051cd54dcd Fixed link behavior.
* Removed the automatic document table heading based on the document id.
* Fixed the way 'absolute' links were resolved in `Processor`. A leading `/` for
  a link passed into `Processor.resolveLink` really means "resolve as if I am
  starting from the documentation root."
* Moved the default logging configuration out of the final jar path. This is to
  help with environments that have multiple projects in the same classpath and
  therefore may have multiple `logback.groovy` configurations loading.
* Tweaked CSS.
2012-01-04 18:11:43 -06:00
Jonathan Bernard
f0ce2c7174 Documentation expanded. Started v1.4
* Expanded README.md
* Fixed typos in documentation
* Started on an inline CSS for inline output.
2012-01-03 17:04:01 -06:00
Jonathan Bernard
5028d38e35 Syntax highlighting, refactor of link resolution.
* Added syntax highlighting using SyntaxHighlighter v3.0.83
  (see https://github.com/alexgorbatchev/SyntaxHighlighter)
* Modified Directive to have a link to the DocBlock that contains it. Modified
  JLPPegParser to account for this change.
* Modified LinkAnchor to include the ASTNode defining it. Also added
  LinkAnchorType enum to facilitate different types of links.
* LiterateMarkdownGenerator is now escaping HTML characters in the code sections
  and other places it is appropriate.
* Refactored the link resolution process. Added a new method
  `Processor.resolveLink(String, TargetDoc)` that now resolves a URL or URL
  fragment relative to the current output context. This function also takes over
  the job of resolving JLP links to link anchors and generating the correct URL.
  LiterateMarkdownGenerator now calls this instead of doing all the work itself.
* To support the syntax highlighter, the JarUtil class from com.jdbernard.util
  is included and the syntax highlighter resources are extracted into the output
  directory from a resource jar stored in the JLP main jar.
* The CSS and other assets for the output are no longer copied into every
  output directory, but now stored at the output root and linked correctly into
  the output files.
* Added references to the source file and file type for TargetDocs instead of
  computing them on the fly during processing.
2012-01-02 20:29:36 -06:00