se.natusoft.doc.markdown.generator.options.HTMLGeneratorOptions.groovy Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of markdown-doc-lib Show documentation

Parses markdown and generates HTML and PDF.

The newest version!

/* 
 * 
 * PROJECT
 *     Name
 *         MarkdownDoc Library
 *     
 *     Code Version
 *         1.2.9
 *     
 *     Description
 *         Parses markdown and generates HTML and PDF.
 *         
 * COPYRIGHTS
 *     Copyright (C) 2012 by Natusoft AB All rights reserved.
 *     
 * LICENSE
 *     Apache 2.0 (Open Source)
 *     
 *     Licensed under the Apache License, Version 2.0 (the "License");
 *     you may not use this file except in compliance with the License.
 *     You may obtain a copy of the License at
 *     
 *       http://www.apache.org/licenses/LICENSE-2.0
 *     
 *     Unless required by applicable law or agreed to in writing, software
 *     distributed under the License is distributed on an "AS IS" BASIS,
 *     WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *     See the License for the specific language governing permissions and
 *     limitations under the License.
 *     
 * AUTHORS
 *     Tommy Svensson ([email protected])
 *         Changes:
 *         2012-11-16: Created!
 *         
 */
package se.natusoft.doc.markdown.generator.options

import se.natusoft.doc.markdown.api.Options
import se.natusoft.tools.optionsmgr.annotations.*

/**
 * This provides options for the HTML generator.
 */
@OptionsModel
class HTMLGeneratorOptions implements Options {

    @Option
    @Name("inlineCSS")
    @Description("If true then the css will be included in the generated HTML.")
    @Optional
    boolean inlineCSS = false

    @Option
    @Name("css")
    @Description("The path to a CSS file.")
    @Optional
    String css = null

    @Option
    @Name("primitiveHTML")
    @Description("When true very primitive HMTL will be generated. This will work for rendering with JEditorPane.")
    @Optional
    boolean primitiveHTML = false

    @Option
    @Name("makeFileLinksRelativeTo")
    @Description("The path file links should be relative to.")
    String makeFileLinksRelativeTo = null;

    @Option
    @Name("resultFile")
    @Description("Where to write the result.")
    @Required
    String resultFile

    @Option
    @Name("help")
    @Description("Shows help.")
    @Optional
    @Flag
    boolean help;

}