You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@freemarker.apache.org by dd...@apache.org on 2017/01/23 13:31:17 UTC
incubator-freemarker-docgen git commit: Added copyrightHolderSite
setting.
Repository: incubator-freemarker-docgen
Updated Branches:
refs/heads/master 1a6495999 -> 85afadb10
Added copyrightHolderSite setting.
Project: http://git-wip-us.apache.org/repos/asf/incubator-freemarker-docgen/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-freemarker-docgen/commit/85afadb1
Tree: http://git-wip-us.apache.org/repos/asf/incubator-freemarker-docgen/tree/85afadb1
Diff: http://git-wip-us.apache.org/repos/asf/incubator-freemarker-docgen/diff/85afadb1
Branch: refs/heads/master
Commit: 85afadb10813c996068500f530d7a836522352b5
Parents: 1a64959
Author: ddekany <dd...@apache.org>
Authored: Mon Jan 23 14:31:11 2017 +0100
Committer: ddekany <dd...@apache.org>
Committed: Mon Jan 23 14:31:11 2017 +0100
----------------------------------------------------------------------
src/main/org/freemarker/docgen/Transform.java | 12 ++++++++++++
src/main/org/freemarker/docgen/templates/footer.ftlh | 2 +-
2 files changed, 13 insertions(+), 1 deletion(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-freemarker-docgen/blob/85afadb1/src/main/org/freemarker/docgen/Transform.java
----------------------------------------------------------------------
diff --git a/src/main/org/freemarker/docgen/Transform.java b/src/main/org/freemarker/docgen/Transform.java
index 3a21f03..c7b3782 100644
--- a/src/main/org/freemarker/docgen/Transform.java
+++ b/src/main/org/freemarker/docgen/Transform.java
@@ -377,6 +377,7 @@ import freemarker.template.utility.StringUtil;
* Defaults to <tt>false</tt>.
*
* <li><p><tt>copyrightHolder</tt> (String): Required. Used in the page footer copyright notice.
+ * <li><p><tt>copyrightHolderSite</tt> (String): Required. The homepage of the copyright holder.
* <li><p><tt>copyrightStartYear</tt> (String): Required. Used in the page footer copyright notice.
* <li><p><tt>copyrightSuffix</tt> (String): Optional. Appended after the generated copyright text.
* <li><p><tt>copyrightCommentFile</tt> (String): The path of a HTML file to the text used inside
@@ -487,6 +488,7 @@ public final class Transform {
static final String SETTING_INTERNAL_BOOKMARKS = "internalBookmarks";
static final String SETTING_EXTERNAL_BOOKMARKS = "externalBookmarks";
static final String SETTING_COPYRIGHT_HOLDER = "copyrightHolder";
+ static final String SETTING_COPYRIGHT_HOLDER_SITE = "copyrightHolderSite";
static final String SETTING_COPYRIGHT_START_YEAR = "copyrightStartYear";
static final String SETTING_COPYRIGHT_SUFFIX = "copyrightSuffix";
static final String SETTING_COPYRIGHT_COMMENT_FILE = "copyrightCommentFile";
@@ -575,6 +577,7 @@ public final class Transform {
= SETTING_EXTERNAL_BOOKMARKS;
private static final String VAR_LOGO = SETTING_LOGO;
private static final String VAR_COPYRIGHT_HOLDER = SETTING_COPYRIGHT_HOLDER;
+ private static final String VAR_COPYRIGHT_HOLDER_SITE = SETTING_COPYRIGHT_HOLDER_SITE;
private static final String VAR_COPYRIGHT_START_YEAR = SETTING_COPYRIGHT_START_YEAR;
private static final String VAR_COPYRIGHT_SUFFIX = SETTING_COPYRIGHT_SUFFIX;
private static final String VAR_SEO_META_TITLE_OVERRIDE = "seoMetaTitleOverride";
@@ -782,6 +785,7 @@ public final class Transform {
private HashMap<String, String> logo;
private String copyrightHolder;
+ private String copyrightHolderSite;
private String copyrightSuffix;
private Integer copyrightStartYear;
private String copyrightComment;
@@ -946,6 +950,8 @@ public final class Transform {
}
} else if (settingName.equals(SETTING_COPYRIGHT_HOLDER)) {
copyrightHolder = castSettingToString(cfgFile, settingName, settingValue);
+ } else if (settingName.equals(SETTING_COPYRIGHT_HOLDER_SITE)) {
+ copyrightHolderSite = castSettingToString(cfgFile, settingName, settingValue);
} else if (settingName.equals(SETTING_COPYRIGHT_START_YEAR)) {
copyrightStartYear = castSettingToInt(cfgFile, settingName, settingValue);
} else if (settingName.equals(SETTING_COPYRIGHT_SUFFIX)) {
@@ -1198,6 +1204,10 @@ public final class Transform {
throw new DocgenException(
"The \"" + SETTING_COPYRIGHT_HOLDER + "\" setting wasn't specified.");
}
+ if (copyrightHolderSite == null) {
+ throw new DocgenException(
+ "The \"" + SETTING_COPYRIGHT_HOLDER_SITE + "\" setting wasn't specified.");
+ }
if (copyrightStartYear == null) {
throw new DocgenException(
"The \"" + SETTING_COPYRIGHT_START_YEAR + "\" setting wasn't specified.");
@@ -1368,6 +1378,8 @@ public final class Transform {
fmConfig.setSharedVariable(
VAR_COPYRIGHT_HOLDER, copyrightHolder);
fmConfig.setSharedVariable(
+ VAR_COPYRIGHT_HOLDER_SITE, copyrightHolderSite);
+ fmConfig.setSharedVariable(
VAR_COPYRIGHT_SUFFIX, copyrightSuffix);
fmConfig.setSharedVariable(
VAR_COPYRIGHT_START_YEAR, copyrightStartYear);
http://git-wip-us.apache.org/repos/asf/incubator-freemarker-docgen/blob/85afadb1/src/main/org/freemarker/docgen/templates/footer.ftlh
----------------------------------------------------------------------
diff --git a/src/main/org/freemarker/docgen/templates/footer.ftlh b/src/main/org/freemarker/docgen/templates/footer.ftlh
index 29d9a27..ca6d9cd 100644
--- a/src/main/org/freemarker/docgen/templates/footer.ftlh
+++ b/src/main/org/freemarker/docgen/templates/footer.ftlh
@@ -72,7 +72,7 @@
<p class="copyright">
� <span itemprop="copyrightYear">${copyrightStartYear?string('0')}</span><#rt>
<#lt><#if transformStartTime?string('yyyy')?number != copyrightStartYear>\u2013${transformStartTime?string('yyyy')}</#if>
- <a itemtype="http://schema.org/Organization" itemprop="copyrightHolder" href="http://freemarker.org">${copyrightHolder}</a><#t>
+ <a itemtype="http://schema.org/Organization" itemprop="copyrightHolder" href="${copyrightHolderSite}">${copyrightHolder}</a><#t>
<#if copyrightSuffix??>. ${copyrightSuffix}</#if><#t>
</p>
</#macro>