Package com.simplicite.util.tools

Class MarkdownTool

java.lang.Object

com.simplicite.util.tools.MarkdownTool

public class MarkdownTool
extends java.lang.Object

Markdown toolbox
This class only provides static variables and methods

Method Summary

Modifier and Type	Method	Description
static java.lang.String	code(java.lang.String code)	Code fragment
static java.lang.String	code(java.lang.String code, java.lang.String language)	Code block
static java.lang.String	docForExternalObject(Grant g, java.lang.String name, boolean header, boolean services, int titleLevel)	Documentation for specified external object
static java.lang.String	docForModule(Grant g, java.lang.String name, boolean header, boolean services, int titleLevel)	Documentation for specified module
static java.lang.String	docForObject(Grant g, java.lang.String name, boolean header, boolean services, int titleLevel)	Documentation for specified object
static java.lang.String	docForProcess(Grant g, java.lang.String name, boolean header, boolean services, int titleLevel)	Documentation for specified business process
static java.lang.String	docHeader(Grant g)	Documentation header
static java.lang.String	genMarkdownForModule(Grant g, java.lang.String name, boolean header, boolean services, int titleLevel, boolean rawMarkdown)	Documentation for specified module
static java.lang.String	getASCIILogo(java.lang.String complement)	Get ASCII logo as Markdown comments
static java.lang.String	image(java.lang.String url, java.lang.String alt)	Image
static java.lang.String	link(java.lang.String url, java.lang.String label)	Link
static java.lang.String	quote(java.lang.String text)	Quite block
static java.lang.String	title(java.lang.String title, int level)	Title
static java.lang.String	title1(java.lang.String title)	Level 1 titel
static java.lang.String	title2(java.lang.String title)	Level 2 titel
static java.lang.String	title3(java.lang.String title)	Level 3 titel
static java.lang.String	title4(java.lang.String title)	Level 4 titel
static java.lang.String	title5(java.lang.String title)	Level 5 titel
static java.lang.String	toHTML(java.io.File file)	Convert a markdown file to HTML (parsing done on server side)
static void	toHTML(java.io.InputStream in, java.io.OutputStream out)	Convert a markdown input stream to HTML and write it to output stream (parsing done on server side)
static java.lang.String	toHTML(java.lang.String md)	Convert a markdown string to HTML (parsing done on server side)
static java.lang.String	toHTML(java.lang.String title, java.io.File file)	Deprecated. User toHTMLPage
static java.lang.String	toHTML(java.lang.String title, java.io.File file, java.lang.String encoding)	Deprecated. User toHTMLPage
static java.lang.String	toHTML(java.lang.String title, java.lang.String md)	Deprecated. User toHTMLPage
static java.lang.String	toHTMLPage(java.lang.String title, java.io.File file)	Convert a markdown file (in default encoding) to HTML page (parsing done on client side)
static java.lang.String	toHTMLPage(java.lang.String title, java.io.File file, java.lang.String encoding)	Convert a markdown file (in specified encoding) to HTML page (parsing done on client side)
static java.lang.String	toHTMLPage(java.lang.String title, java.lang.String md)	Convert a markdown string to an HTML page (parsing done on client side)

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

toHTML

@Deprecated
public static java.lang.String toHTML(java.lang.String title,
                                      java.lang.String md)

Deprecated.

User toHTMLPage

toHTMLPage

public static java.lang.String toHTMLPage(java.lang.String title,
                                          java.lang.String md)

Convert a markdown string to an HTML page (parsing done on client side)

Parameters:

title - Title

md - Markdown string

toHTML

@Deprecated
public static java.lang.String toHTML(java.lang.String title,
                                      java.io.File file,
                                      java.lang.String encoding)
                               throws java.lang.Exception

Deprecated.

User toHTMLPage

Throws:

java.lang.Exception

toHTMLPage

public static java.lang.String toHTMLPage(java.lang.String title,
                                          java.io.File file,
                                          java.lang.String encoding)
                                   throws java.lang.Exception

Convert a markdown file (in specified encoding) to HTML page (parsing done on client side)

Parameters:

title - Title

file - Markdown file

encoding - Encoding

Throws:

java.lang.Exception

toHTML

@Deprecated
public static java.lang.String toHTML(java.lang.String title,
                                      java.io.File file)
                               throws java.lang.Exception

Deprecated.

User toHTMLPage

Throws:

java.lang.Exception

toHTMLPage

public static java.lang.String toHTMLPage(java.lang.String title,
                                          java.io.File file)
                                   throws java.lang.Exception

Convert a markdown file (in default encoding) to HTML page (parsing done on client side)

Parameters:

title - Title

file - Markdown file

Throws:

java.lang.Exception

getASCIILogo

public static java.lang.String getASCIILogo(java.lang.String complement)

Get ASCII logo as Markdown comments

Parameters:

complement - Additonal string to append to ASCII logo

title

public static java.lang.String title(java.lang.String title,
                                     int level)

Title

Parameters:

title - Title

level - Level

title1

public static java.lang.String title1(java.lang.String title)

Level 1 titel

Parameters:

title - Title

title2

public static java.lang.String title2(java.lang.String title)

Level 2 titel

Parameters:

title - Title

title3

public static java.lang.String title3(java.lang.String title)

Level 3 titel

Parameters:

title - Title

title4

public static java.lang.String title4(java.lang.String title)

Level 4 titel

Parameters:

title - Title

title5

public static java.lang.String title5(java.lang.String title)

Level 5 titel

Parameters:

title - Title

code

public static java.lang.String code(java.lang.String code)

Code fragment

Parameters:

code - Code

code

public static java.lang.String code(java.lang.String code,
                                    java.lang.String language)

Code block

Parameters:

code - Code

language - Code language

quote

public static java.lang.String quote(java.lang.String text)

Quite block

Parameters:

text - Text to quote

link

public static java.lang.String link(java.lang.String url,
                                    java.lang.String label)

Link

Parameters:

url - URL

label - Label

image

public static java.lang.String image(java.lang.String url,
                                     java.lang.String alt)

Image

Parameters:

url - Image URL (can be a data URL)

alt - Alternative text for image

toHTML

public static java.lang.String toHTML(java.lang.String md)

Convert a markdown string to HTML (parsing done on server side)

Parameters:

md - Markdown string

Returns:

HTML

toHTML

public static java.lang.String toHTML(java.io.File file)
                               throws java.lang.Exception

Convert a markdown file to HTML (parsing done on server side)

Parameters:

file - Markdown file

Returns:

HTML

Throws:

java.lang.Exception

toHTML

public static void toHTML(java.io.InputStream in,
                          java.io.OutputStream out)
                   throws java.lang.Exception

Convert a markdown input stream to HTML and write it to output stream (parsing done on server side)

Parameters:

in - Markdown input stream

out - Markdown output stream

Throws:

java.lang.Exception

docHeader

public static java.lang.String docHeader(Grant g)

Documentation header

Parameters:

g - Grant

Returns:

Markdown fragment

docForModule

public static java.lang.String docForModule(Grant g,
                                            java.lang.String name,
                                            boolean header,
                                            boolean services,
                                            int titleLevel)

Documentation for specified module

Parameters:

g - Grant

name - Module name

header - Include header ?

services - Service output ?

titleLevel - Title level

Returns:

Markdown fragment

genMarkdownForModule

public static java.lang.String genMarkdownForModule(Grant g,
                                                    java.lang.String name,
                                                    boolean header,
                                                    boolean services,
                                                    int titleLevel,
                                                    boolean rawMarkdown)

Documentation for specified module

Parameters:

g - Grant

name - Module name

header - Include header ?

services - Service output ?

titleLevel - Title level

rawMarkdown - false to generate Simplicite-flavored markdown

Returns:

Markdown fragment

docForObject

public static java.lang.String docForObject(Grant g,
                                            java.lang.String name,
                                            boolean header,
                                            boolean services,
                                            int titleLevel)

Documentation for specified object

Parameters:

g - Grant

name - Object name

header - Include header ?

services - Service output ?

titleLevel - Title level

Returns:

Markdown fragment

docForProcess

public static java.lang.String docForProcess(Grant g,
                                             java.lang.String name,
                                             boolean header,
                                             boolean services,
                                             int titleLevel)

Documentation for specified business process

Parameters:

g - Grant

name - Process name

header - Include header ?

services - Service output ?

titleLevel - Title level

Returns:

Markdown fragment

docForExternalObject

public static java.lang.String docForExternalObject(Grant g,
                                                    java.lang.String name,
                                                    boolean header,
                                                    boolean services,
                                                    int titleLevel)

Documentation for specified external object

Parameters:

g - Grant

name - External object name

header - Include header ?

services - Service output ?

titleLevel - Title level

Returns:

Markdown fragment