Commit Graph

9 Commits

Author SHA1 Message Date
Jonathan Bernard
4bac35ef0b Release 0.1 is ready
* Tweaked CSS.
* Finished basic implementation of JLPMain (lots of thihngs are hardwired).
2011-09-06 17:10:36 -05:00
Jonathan Bernard
bab1943120 Promoting the experimental code to replace the exising main code. 2011-09-06 16:26:36 -05:00
Jonathan Bernard
7a5870dc09 Worked on literate output using Markdown as the text markup language.
* Added CSS based on Docco (blatantly copied).
* Updated sample text to better fit the emerging usage patterns. Some of the
  things I did to make it render nicely for the Literate output may cause
  problems when we go to render API output. I will cross that bridge when I come
  to it.
* Added parsing infrastructure to the Generator behaviour to allow a
  pre-processing pass over the document. Current the LiterateMarkdownGenerator
  is using this to compile a map of `@org` references.
* Tweaked the HTML output slightly.
* Added a layer over the PegDownProcessor in LiterateMarkdownGenerator to
  capture and transform `jlp://` links into relative links.
2011-09-06 16:13:21 -05:00
Jonathan Bernard
c2c2f9da3d Working on a literate generator similar to Docco. 2011-09-02 16:47:46 -05:00
Jonathan Bernard
7717439274 Experimenting with a different AST structure and ideas.
Ideas:

* For literate output, format like Docco, tables like

    Doc        | Code
    -----------|------------
    | docblock | codeblock |
    | docblock | codeblock |
    | docblock | codeblock |

* For javadoc output, maybe create a running 'pure source' object containing
  just the code lines. Then run an sup-parser for the language the code is
  written in and build a seperate AST for the code. This code AST then gets
  tagged onto the overall AST and is used in the generation phase for code
  comprehension. Would still need a way to map doc blocks to code blocks. I
  could probably use line numbers. In that case I would need to map the original
  source line from the commented input to the 'pure source' while processing the
  'pure source' and store the original line number in the code AST. That would
  give me a reliable way to lookup the closest code structure to a doc block.
* The code AST would need to made of generic pieces if I want to have
  language-agnostic generator code. What may be better is to allow the language
  parser to create it's code AST however is wants and just have some pluggable
  bit of the generator for each language. Would increase generator code
  complexity though.
2011-08-31 12:09:25 -05:00
Jonathan Bernard
5081ebbd30 Basic transformative functionality implemented.
* Updated test data to include additional parsing edge cases.
* Updated `vbs_db_records.hrl` to use `@org` directives.
* Refactored Generator/Emitter dual-object phase concept into one object, the
  Generator. The emitter ended up needing basically full visibility into the
  generator anyways.
* Implemented `JLPBaseGenerator`, `MarkdownGenerator`, and
  `TransparentGenerator`
* Modified the way the parser handles remaining lines to allow it to safely
  handle empty lines.
2011-08-31 09:46:25 -05:00
Jonathan Bernard
557feaeb83 Worked on documentation, parser.
* Added planning documentation regrding the process.
* Updated grammer.
* Refactored the test code a bit.
* Added sample input file from vbs-suite
* Refactored the AST node structure created by the parser.
2011-08-29 09:44:05 -05:00
Jonathan Bernard
c275fd0ce1 Implmented actions to build AST.
* Rewrote grammar slightly.
* Added parboiled parse section to JLPMain.
* Added code to build the AST while parsing.
* Created ASTNode classes.
2011-08-26 15:40:56 -05:00
Jonathan Bernard
e8ebcd4998 Sorting out Parboiled issues. Initial parser draft complete.
* Created test script.
* Created working parser.
2011-08-25 17:08:55 -05:00