README.md

---

Markdown module definition

Introduction

Markdown documentation module.

Import

To import this module:

• Create a module named Markdown
• Set the settings as:

{
	"type": "git",
	"origin": {
		"uri": "https://github.com/simplicitesoftware/module-markdown.git"
	}
}

• Click on the Import module button

Quality

This module can be analysed by the SonarQube analysis tool using this command:

mvn verify sonar:sonar

MDDocument business object definition

Markdown document

Fields

Name	Type	Required	Updatable	Personal	Description
mdDocCode	regexp(50)	yes*	yes		Document code
mdDocURL	url(100)				Document URL
mdDocTitle	char(100)	yes	yes		Document title
mdDocFile	document		yes		Markdown file
mdDocPublished	boolean		yes		Is document published?
row_module_id link to Module	id	yes	yes		Module
Ref. row_module_id.mdl_name	regexp(100)				Module name

MDDocumentHistoric business object definition

Fields

Name	Type	Required	Updatable	Personal	Description
row_ref_id link to MDDocument	id	yes*			Record row ID
row_idx	int(11)	yes*	yes		History record index
created_by_hist	char(100)	yes*			Created by
created_dt_hist	datetime	yes*			Created date
mdDocCode	regexp(50)	yes*	yes		Document code
mdDocTitle	char(100)	yes	yes		Document title
mdDocFile	document		yes		Markdown file

Custom actions

• MDDocDiff:

MDImage business object definition

Markdown image

Fields

Name	Type	Required	Updatable	Personal	Description
mdImgCode	regexp(50)	yes*	yes		Markdown image code
mdImgFile	image	yes	yes		Image
row_module_id link to Module	id	yes	yes		Module
Ref. row_module_id.mdl_name	regexp(100)				Module name

MDDiff external object definition

Diff between markdown documents

MDViewer external object definition

Markdown documentation viewer