Compare commits

...

5 Commits
1.1.0 ... 1.1.1

Author SHA1 Message Date
Robert Winkler
c404740bf1 Updated version from 1.1.0 to 1.1.1-SNAPSHOT 2017-01-02 11:18:24 +01:00
Cas Eliëns
23c72721ad Add page breaks to unit tests 2016-12-23 13:17:26 +01:00
Cas Eliëns
67b5698a16 Add support for page breaks 2016-12-23 13:17:26 +01:00
Robert Winkler
6662eb6e9d Updated docs 2016-12-23 08:16:54 +01:00
Robert Winkler
d712b615d1 Updated bintray badge 2016-12-01 09:17:24 +01:00
12 changed files with 44 additions and 7 deletions

View File

@@ -3,11 +3,11 @@
:version: 1.0.0
:hardbreaks:
image:https://travis-ci.org/Swagger2Markup/markup-document-builder.svg?branch=master["Build Status", link="https://travis-ci.org/Swagger2Markup/markup-document-builder"] image:https://coveralls.io/repos/Swagger2Markup/markup-document-builder/badge.svg["Coverage Status", link="https://coveralls.io/r/Swagger2Markup/markup-document-builder"] image:https://api.codacy.com/project/badge/grade/c56a372454164f21b1b2eec8eb48b370["Codacy code quality", link="https://www.codacy.com/app/robwin/markup-document-builder"] image:https://api.bintray.com/packages/swagger2markup/Maven/markup-document-builder/images/download.svg[link="https://bintray.com/swagger2markup/Maven/markup-document-builder/_latestVersion"] image:http://img.shields.io/badge/license-ASF2-blue.svg["Apache License 2", link="http://www.apache.org/licenses/LICENSE-2.0.txt"] image:https://img.shields.io/badge/Twitter-rbrtwnklr-blue.svg["Twitter", link="https://twitter.com/rbrtwnklr"]
image:https://travis-ci.org/Swagger2Markup/markup-document-builder.svg?branch=master["Build Status", link="https://travis-ci.org/Swagger2Markup/markup-document-builder"] image:https://coveralls.io/repos/Swagger2Markup/markup-document-builder/badge.svg["Coverage Status", link="https://coveralls.io/r/Swagger2Markup/markup-document-builder"] image:https://api.codacy.com/project/badge/grade/c56a372454164f21b1b2eec8eb48b370["Codacy code quality", link="https://www.codacy.com/app/robwin/markup-document-builder"] image:https://api.bintray.com/packages/swagger2markup/Maven/io.github.swagger2markup%3Amarkup-document-builder/images/download.svg[link="https://bintray.com/swagger2markup/Maven/io.github.swagger2markup%3Amarkup-document-builder/_latestVersion"] image:http://img.shields.io/badge/license-ASF2-blue.svg["Apache License 2", link="http://www.apache.org/licenses/LICENSE-2.0.txt"] image:https://img.shields.io/badge/Twitter-rbrtwnklr-blue.svg["Twitter", link="https://twitter.com/rbrtwnklr"]
== Overview
This project is a Markup document builder (AsciiDoc and Markdown). The primary goal of this project is to simplify the creation of Markup documents. The builder is used by https://github.com/RobWin/swagger2markup[swagger2markup].
This project is a Markup document builder (AsciiDoc, Markdown and ConfluenceWiki). The primary goal of this project is to simplify the creation of Markup documents. The builder is used by https://github.com/RobWin/swagger2markup[swagger2markup].
The project requires at least JDK 7.

View File

@@ -19,4 +19,7 @@
* Added SECTION_TITLE_LEVEL4
== Version 1.1.0
* Changed bold to ** and italic to __ so that special chars in the text are possible
* Changed bold to ** and italic to __ so that special chars in the text are possible
== Version 1.1.1
* Added a method to add page breaks.

View File

@@ -12,7 +12,7 @@ buildscript {
}
}
description = 'A Markup (Markdown, AsciiDoc) document builder'
version = '1.1.0'
version = '1.1.1-SNAPSHOT'
group = 'io.github.swagger2markup'
apply plugin: 'java'

View File

@@ -98,7 +98,7 @@ bintray {
publications = ['mavenJava']
pkg {
repo = 'Maven'
name = 'markup-document-builder'
name = 'io.github.swagger2markup:markup-document-builder'
userOrg = 'swagger2markup'
websiteUrl = projectUrl
issueTrackerUrl = issuesUrl

View File

@@ -245,7 +245,14 @@ public interface MarkupDocBuilder {
* @return this builder
*/
MarkupDocBuilder paragraph(String text);
/**
* Insert a page break
*
* @return this builder
*/
MarkupDocBuilder pageBreak();
/**
* Builds a block of {@code text} with specified {@code style}.
*

View File

@@ -96,6 +96,12 @@ public class AsciiDocBuilder extends AbstractMarkupDocBuilder {
return this;
}
@Override
public MarkupDocBuilder pageBreak() {
documentBuilder.append(newLine).append("<<<").append(newLine);
return this;
}
@Override
public MarkupDocBuilder block(String text, final MarkupBlockStyle style, String title, MarkupAdmonition admonition) {
if (admonition != null)

View File

@@ -135,6 +135,12 @@ public final class ConfluenceMarkupBuilder extends AbstractMarkupDocBuilder {
return this;
}
@Override
public MarkupDocBuilder pageBreak() {
documentBuilder.append(newLine).append("<div style='page-break-before:always;'></div>").append(newLine);
return this;
}
@Override
public MarkupDocBuilder block(String text, final MarkupBlockStyle style, String title, MarkupAdmonition admonition) {

View File

@@ -103,7 +103,13 @@ public class MarkdownBuilder extends AbstractMarkupDocBuilder {
return this;
}
@Override
public MarkupDocBuilder pageBreak() {
documentBuilder.append(newLine).append("***").append(newLine);
return this;
}
@Override
public MarkupDocBuilder block(String text, final MarkupBlockStyle style, String title, MarkupAdmonition admonition) {
if (admonition != null)

View File

@@ -91,6 +91,7 @@ public class MarkupDocBuilderTest {
.block("Literal", MarkupBlockStyle.LITERAL, null, MarkupAdmonition.NOTE)
.block("Sidebar", MarkupBlockStyle.SIDEBAR, null, MarkupAdmonition.TIP)
.block("Passthrough", MarkupBlockStyle.PASSTHROUGH, null, MarkupAdmonition.WARNING)
.pageBreak()
.table(tableCells)
.tableWithColumnSpecs(tableColumns, tableCells)
.sectionTitleLevel1("Section Level 1b")
@@ -160,6 +161,7 @@ public class MarkupDocBuilderTest {
.block("Literal", MarkupBlockStyle.LITERAL, null, MarkupAdmonition.NOTE)
.block("Sidebar", MarkupBlockStyle.SIDEBAR, null, MarkupAdmonition.TIP)
.block("Passthrough", MarkupBlockStyle.PASSTHROUGH, null, MarkupAdmonition.WARNING)
.pageBreak()
//.table(tableCells)
.tableWithColumnSpecs(tableColumns, tableCells)
.sectionTitleLevel1("Section Level 1b")
@@ -230,6 +232,7 @@ public class MarkupDocBuilderTest {
.block("Literal", MarkupBlockStyle.LITERAL, null, MarkupAdmonition.NOTE)
.block("Sidebar", MarkupBlockStyle.SIDEBAR, null, MarkupAdmonition.TIP)
.block("Passthrough", MarkupBlockStyle.PASSTHROUGH, null, MarkupAdmonition.WARNING)
.pageBreak()
.table(tableCells)
.tableWithColumnSpecs(tableColumns, tableCells)
.sectionTitleLevel1("Section Level 1b")

View File

@@ -93,6 +93,8 @@ Passthrough
++++
<<<
[options="", cols=""]
|===
|Row 1 \| Column 1|Row 1 \| Column 2|Row 1 \| Column 3

View File

@@ -77,6 +77,8 @@ Passthrough
{html}
<div style='page-break-before:always;'></div>
|Row 1 \| Column 1|Row 1 \| Column 2|Row 1 \| Column 3|
|Row 2 \| Column 1|Row 2 \| Column 2|Row 2 \| Column 3|

View File

@@ -82,6 +82,8 @@ Warning :
Passthrough
***
|Header1||Header3|
|---|---|---|
|Row 1 \| Column 1|Row 1 \| Column 2|Row 1 \| Column 3|