Skip to content

Latest commit

 

History

History
95 lines (62 loc) · 2.61 KB

README.md

File metadata and controls

95 lines (62 loc) · 2.61 KB

Build License: MIT

Description

Semplate is a Java library to create and maintain markdown documents by:

  • adding semantic information
  • using user defined templates

It works with both Markdown and Asciidoc and may work with other markdown flavors.

More comprehensive documentation can be found in the GitHub Pages

Quick overview on how to use the Semplate library

❕ Exception handling in not shown in the following examples.

  1. Create a class for the data object making sure it is annotated for semplate, e.g.
     import semplate.annotations.*;

       @Templatable
       public class ADR {

       @TemplateField
       private Integer id;

       @TemplateField
       private String name;

       @TemplateField
       private final String status;

       /* Setters and getters */
   }
  1. Create a template file in markdown, e.g.:
  <!--{{template.comment}}-->

  # {{id}}. {{name}}

  ## Status

  {{status}}

  ## Context

  *Record the architectural decisions made on this project.*

  ## Decision

  **We will use Architecture Decision Records, as described by Michael Nygard in [this article: ](http://thinkrelevance.com/blog/2011/11/15/documenting-architecture-decisions)**
  1. Generate a markdown file using the data in an object. The markdown file will be semantically annotated.
    ADR adr = new ADR();
    adr.setId(12);
    adr.setName("Use a graph database");
    adr.setStatus("Proposed");

    SemanticWriter.with(adr)
                  .usingTemplate(path_to_template_file)
                  .write(path_to_markdown_file);
  1. Generate a data object by reading in the generated (semantically annotated) markdown file.
    ADR adr = (ADR) SemanticReader.with(ArchitectureDecisionRecord.class)
                                  .usingFile(path_to_markdown_file)
                                  .read();   

    assertEquals(12, adr.getId());
    assertEquals("Use a graph database", adr.getName());
  1. Update an existing (semantically annotated) markdown file
   ADR updatedADR = adr.clone();
   updatedADR.setStatus("Agreed");

   SemanticWriter.with(updatedADR)                 
                .usingFile(path_to_input_semantic_file)
                .write(path_to_updated_semantic_file);