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 2020/08/03 23:03:51 UTC
[freemarker-docgen] branch master updated (9ae388d -> b775e86)
This is an automated email from the ASF dual-hosted git repository.
ddekany pushed a change to branch master
in repository https://gitbox.apache.org/repos/asf/freemarker-docgen.git.
from 9ae388d Hamburger menu spacing adjustment for more accuracy
new 57ff3a2 Made "callouts" 100% wide
new ca23b89 Made "programlisting" labels part of the HTML content.
new 6e25aba Fixed spacing in left side ToC
new b775e86 Fixed issue where the left ToC may stayed hidden when going from mobile view to normal view.
The 4 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails. The revisions
listed as "add" were already present in the repository and have only
been added to this reference.
Summary of changes:
.../org/freemarker/docgen/core/js/page-menu.js | 10 +--
.../docgen/core/less/lib/components/callout.less | 1 -
.../core/less/lib/components/code-block.less | 81 +++++++---------------
.../less/lib/components/table-of-contents.less | 26 +++----
.../docgen/core/less/lib/layout/content.less | 6 +-
.../docgen/core/templates/node-handlers.ftlh | 28 +++++---
6 files changed, 60 insertions(+), 92 deletions(-)
[freemarker-docgen] 02/04: Made "programlisting" labels part of the
HTML content.
Posted by dd...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
ddekany pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/freemarker-docgen.git
commit ca23b89426ea24477f3a037faa61564f1811aca4
Author: ddekany <dd...@apache.org>
AuthorDate: Sun Aug 2 12:00:20 2020 +0200
Made "programlisting" labels part of the HTML content.
---
.../core/less/lib/components/code-block.less | 81 +++++++---------------
.../docgen/core/templates/node-handlers.ftlh | 28 +++++---
2 files changed, 42 insertions(+), 67 deletions(-)
diff --git a/freemarker-docgen-core/src/main/resources-gulp/org/freemarker/docgen/core/less/lib/components/code-block.less b/freemarker-docgen-core/src/main/resources-gulp/org/freemarker/docgen/core/less/lib/components/code-block.less
index ebf2fe2..5a908a1 100644
--- a/freemarker-docgen-core/src/main/resources-gulp/org/freemarker/docgen/core/less/lib/components/code-block.less
+++ b/freemarker-docgen-core/src/main/resources-gulp/org/freemarker/docgen/core/less/lib/components/code-block.less
@@ -16,77 +16,44 @@
* specific language governing permissions and limitations
* under the License.
*/
-.code-label() {
- position: absolute;
- top: 0;
- right: 0;
- left: 0;
+
+.code-block {
+ margin: 12px 0;
+
+ &.role-template {
+ .code-block-label { background-color: #e4e4e4; }
+ .code-block-body { background-color: #f4f4f4; }
+ }
+
+ &.role-data-model {
+ .code-block-label { background-color: #D2E2EF; }
+ .code-block-body { background-color: #ecf3f8; }
+ }
+
+ &.role-output {
+ .code-block-label { background-color: #D5EAD7; }
+ .code-block-body { background-color: #ECF8EE; }
+ }
+}
+
+.code-block-label {
padding: 3px 9px;
font-size: 10px;
font-weight: bold;
- font-family: @font-sans-serif;
text-transform: uppercase;
color: rgba(94, 94, 94, 0.8);
}
-.code-block-with-label() {
- padding-top: 23px;
-}
-
-.code-block {
+.code-block-body {
border: 0;
- position:relative;
+ position: relative;
padding: 3px 6px 4px;
- margin: 12px 0;
+ margin: 0;
background-color: #f4f4f4;
.callout & {
background-color: transparent !important;
padding: 0 !important;
margin: 0 !important;
-
- &::after {
- display: none !important;
- }
- }
-
- &.code-template {
- background-color: #f4f4f4;
- .code-block-with-label();
-
- &::after {
- .code-label();
- background-color: #e4e4e4;
- content: "Template";
- }
- }
-
- &.code-data-model {
- background-color: #ecf3f8;
- .code-block-with-label();
-
- &::after {
- .code-label();
- background-color: #D2E2EF;
- content: "Data Model";
- }
- }
-
- &.code-output {
- background-color: #ECF8EE;
- .code-block-with-label();
-
- &::after {
- .code-label();
- background-color: #D5EAD7;
- content: "Output";
- }
- }
-
- /*
- &.code-unspecified {
- // Same as default for now
}
- */
-
}
diff --git a/freemarker-docgen-core/src/main/resources/org/freemarker/docgen/core/templates/node-handlers.ftlh b/freemarker-docgen-core/src/main/resources/org/freemarker/docgen/core/templates/node-handlers.ftlh
index 8d7f4f7..c3e9827 100644
--- a/freemarker-docgen-core/src/main/resources/org/freemarker/docgen/core/templates/node-handlers.ftlh
+++ b/freemarker-docgen-core/src/main/resources/org/freemarker/docgen/core/templates/node-handlers.ftlh
@@ -359,16 +359,20 @@
<#switch role>
<#case "output">
- <#local codeType = "code-output">
+ <#local roleCssClass = "role-output">
+ <#local roleLabel = "Output">
<#break>
<#case "dataModel">
- <#local codeType = "code-data-model">
+ <#local roleCssClass = "role-data-model">
+ <#local roleLabel = "Data Model">
<#break>
<#case "template">
- <#local codeType = "code-template">
+ <#local roleCssClass = "role-template">
+ <#local roleLabel = "Template">
<#break>
<#case "unspecified">
- <#local codeType = "code-unspecified">
+ <#local roleCssClass = "role-unspecified">
+ <#local roleLabel = "">
<#break>
<#case "metaTemplate">
<pre class="metaTemplate"><#t>
@@ -376,15 +380,19 @@
</pre><#lt>
<#return>
<#default>
- <#local codeType = "code-default">
+ <#local roleCssClass = "role-default">
+ <#local roleLabel = "">
</#switch>
<@CantBeNestedIntoP>
- <pre class="code-block ${codeType}"><@Anchor/><#t>
- <#-- XXE and usual FO-stylesheet-compatible interpretation of inital line-breaks -->
- <#local content><#recurse></#local>
- ${content?markupString?chopLinebreak?noEsc}<#t>
- </pre><#t>
+ <div class="code-block ${roleCssClass}">
+ <#if roleLabel != ''><div class="code-block-label">${roleLabel}</div></#if><#t>
+ <pre class="code-block-body"><@Anchor/><#t>
+ <#-- XXE and usual FO-stylesheet-compatible interpretation of inital line-breaks -->
+ <#local content><#recurse></#local>
+ ${content?markupString?chopLinebreak?noEsc}<#t>
+ </pre><#t>
+ </div>
</...@CantBeNestedIntoP>
</#macro>
[freemarker-docgen] 01/04: Made "callouts" 100% wide
Posted by dd...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
ddekany pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/freemarker-docgen.git
commit 57ff3a2bd5c0e62949c5bb558b822481f3f23b08
Author: ddekany <dd...@apache.org>
AuthorDate: Sun Aug 2 11:59:50 2020 +0200
Made "callouts" 100% wide
---
.../org/freemarker/docgen/core/less/lib/components/callout.less | 1 -
1 file changed, 1 deletion(-)
diff --git a/freemarker-docgen-core/src/main/resources-gulp/org/freemarker/docgen/core/less/lib/components/callout.less b/freemarker-docgen-core/src/main/resources-gulp/org/freemarker/docgen/core/less/lib/components/callout.less
index b42e0b9..15a570e 100644
--- a/freemarker-docgen-core/src/main/resources-gulp/org/freemarker/docgen/core/less/lib/components/callout.less
+++ b/freemarker-docgen-core/src/main/resources-gulp/org/freemarker/docgen/core/less/lib/components/callout.less
@@ -22,7 +22,6 @@
border-left: 4px solid #eee;
background-color: #f9f9f9;
- max-width: 600px;
&.note {
border-left-color: #A181AE;
[freemarker-docgen] 03/04: Fixed spacing in left side ToC
Posted by dd...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
ddekany pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/freemarker-docgen.git
commit 6e25abaca825b461b668e94407fa33027ebf7bf1
Author: ddekany <dd...@apache.org>
AuthorDate: Sun Aug 2 16:08:01 2020 +0200
Fixed spacing in left side ToC
---
.../less/lib/components/table-of-contents.less | 26 +++++++++-------------
1 file changed, 11 insertions(+), 15 deletions(-)
diff --git a/freemarker-docgen-core/src/main/resources-gulp/org/freemarker/docgen/core/less/lib/components/table-of-contents.less b/freemarker-docgen-core/src/main/resources-gulp/org/freemarker/docgen/core/less/lib/components/table-of-contents.less
index 45874a2..605dbd7 100644
--- a/freemarker-docgen-core/src/main/resources-gulp/org/freemarker/docgen/core/less/lib/components/table-of-contents.less
+++ b/freemarker-docgen-core/src/main/resources-gulp/org/freemarker/docgen/core/less/lib/components/table-of-contents.less
@@ -18,6 +18,7 @@
*/
@toc-hamburger-menu-font-size: 16px;
+@toc-hamburger-menu-li-margin: 0.6em;
@toc-xs-menu-font-size: 12px;
@toc-sm-menu-font-size: 13px;
@@ -56,8 +57,8 @@
}
li {
- margin-top: @toc-sm-menu-font-size * 0.75;
- margin-bottom: @toc-sm-menu-font-size * 0.75;
+ margin-top: @toc-hamburger-menu-li-margin;
+ margin-bottom: @toc-hamburger-menu-li-margin;
@media (min-width: @screen-xs-min) {
margin-top: 0;
margin-bottom: 0;
@@ -65,17 +66,15 @@
}
}
-@section-spacing: 12px;
-
-.section {
+li.section {
border-bottom: 1px solid @border-gray;
- margin-bottom: @section-spacing;
- padding-bottom: @section-spacing;
+ padding-bottom: 0;
+ margin-bottom: @toc-hamburger-menu-li-margin;
- @media (min-width: @screen-sm-min) {
- margin-bottom: @section-spacing * 2;
- padding-bottom: @section-spacing * 2;
+ @media (min-width: @screen-xs-min) {
+ padding-bottom: 1em;
+ margin-bottom: 1em;
}
&.last {
@@ -95,11 +94,8 @@
display: block;
line-height: 1;
- margin-bottom: @section-spacing;
-
- @media (min-width: @screen-sm-min) {
- margin-bottom: @section-spacing * 2;
- }
+ margin-top: 1em;
+ margin-bottom: 1em;
a&:hover {
color: @link-hover;
[freemarker-docgen] 04/04: Fixed issue where the left ToC may
stayed hidden when going from mobile view to normal view.
Posted by dd...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
ddekany pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/freemarker-docgen.git
commit b775e8640188baf068d6a9ad49face4569f952cb
Author: ddekany <dd...@apache.org>
AuthorDate: Sun Aug 2 16:32:38 2020 +0200
Fixed issue where the left ToC may stayed hidden when going from mobile view to normal view.
---
.../resources-gulp/org/freemarker/docgen/core/js/page-menu.js | 10 +++-------
.../org/freemarker/docgen/core/less/lib/layout/content.less | 6 ++++--
2 files changed, 7 insertions(+), 9 deletions(-)
diff --git a/freemarker-docgen-core/src/main/resources-gulp/org/freemarker/docgen/core/js/page-menu.js b/freemarker-docgen-core/src/main/resources-gulp/org/freemarker/docgen/core/js/page-menu.js
index 8f8e2b7..b731d7d 100644
--- a/freemarker-docgen-core/src/main/resources-gulp/org/freemarker/docgen/core/js/page-menu.js
+++ b/freemarker-docgen-core/src/main/resources-gulp/org/freemarker/docgen/core/js/page-menu.js
@@ -56,13 +56,9 @@
if (node.classList.contains('page-menu-link')) {
highlightNode(node.getAttribute('data-menu-target'));
} else if (node.id == 'hamburger-menu') {
- if (toc.style.display === "block") {
- toc.style.display = "none";
- } else {
- toc.style.display = "block";
- }
- } else if (toc.style.display === "block" && !toc.contains(event.target)) {
- toc.style.display = "none";
+ toc.classList.toggle("visible-hamburger-menu");
+ } else if (toc.classList.contains("visible-hamburger-menu") && !toc.contains(event.target)) {
+ toc.classList.remove("visible-hamburger-menu");
}
}
diff --git a/freemarker-docgen-core/src/main/resources-gulp/org/freemarker/docgen/core/less/lib/layout/content.less b/freemarker-docgen-core/src/main/resources-gulp/org/freemarker/docgen/core/less/lib/layout/content.less
index 38de2ae..3c2e087 100644
--- a/freemarker-docgen-core/src/main/resources-gulp/org/freemarker/docgen/core/less/lib/layout/content.less
+++ b/freemarker-docgen-core/src/main/resources-gulp/org/freemarker/docgen/core/less/lib/layout/content.less
@@ -39,8 +39,11 @@
}
#table-of-contents-wrapper {
- // Hide for typical mobile screens:
+ // Hide for typical mobile screens initially:
display: none;
+ &.visible-hamburger-menu {
+ display: block;
+ }
@media (min-width: @screen-xs-min) {
display: block;
@@ -88,7 +91,6 @@
.col-right {
flex: 1;
position: relative; // so we can position bottom pager
-
}
}