libre.sh/keycloak-scim
3
0
Fork 0
Code Issues 15 Pull requests Releases 1 Packages Activity Actions

KEYCLOAK-11918 Moved guides docs to dropdown, and set version fixed at the top

Browse source
This commit is contained in:
stianst 2019-11-07 12:49:33 +01:00 committed by Stian Thorgersen
parent 384640c284
commit a3255004bb
14 changed files with 160 additions and 102 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

196
aggregation/navbar-head.html
View file

@ -1,4 +1,111 @@
<style>
/* Top menu */
@media only screen and (min-width: 768px) {
div.top-menu-guides {
position: fixed;
display: inline-block;
top: 0;
left: 0;
z-index: 9999;
}
div.top-menu-guides p {
margin: 0;
padding: 0;
}
div.top-menu-guides .content {
margin: 0;
padding: 7px 20px 0 20px;
background-color: #ededed;
height: 48px;
width: 20em;
}
@media only screen and (max-width: 1280px) {
div.top-menu-guides .content {
width: 15em;
}
}
div.top-menu-guides .ulist {
display: none;
position: absolute;
background-color: #f9f9f9;
min-width: 160px;
box-shadow: 0px 8px 16px 0px rgba(0,0,0,0.2);
padding: 0px;
margin-top: 12px;
}
div.top-menu-guides .ulist ul {
list-style: none;
padding: 5px;
margin: 0;
}
div.top-menu-guides .ulist li {
padding: 5px 10px;
}
div.top-menu-guides:hover .ulist {
display: block;
}
div.top-menu-version {
position: fixed;
top: 0;
z-index: 9999;
}
div.top-menu-version .content {
padding: 0;
margin: 0;
background-color: #eee;
height: 48px;
padding: 7px;
}
.versionarchive {
display: inline-block;
}
.versionarchive p {
margin: 0;
padding: 2px 5px 2px 10px;
}
.versionarchive a {
background-color: #ffdd57;
padding: 0 5px;
font-style: normal;
border-radius: 5px;
margin-left: 10px;
}
.versionlatest {
display: inline-block;
}
.versionlatest p {
background-color: #eee;
border-radius: 5px;
margin: 0;
padding: 2px 5px 2px 10px;
}
.versionlatest em {
background-color: #23d160;
padding: 0 5px;
font-style: normal;
border-radius: 5px;
margin-left: 10px;
}
}
/* TOC */
#tocbot a.toc-link.node-name--H1{ font-style: italic }
@media screen{
#tocbot > ul.toc-list{ margin-bottom: 0.5em; margin-left: 0.125em }
@ -13,44 +120,6 @@
#tocbot a.toc-link.node-name--H4{ display:none }
}
.versionarchive {
display: inline-block;
}
.versionarchive p {
background-color: #eee;
border-radius: 5px;
margin: 0;
padding: 2px 5px 2px 10px;
}
.versionarchive a {
background-color: #ffdd57;
padding: 0 5px;
font-style: normal;
border-radius: 5px;
margin-left: 10px;
}
.versionlatest {
display: inline-block;
}
.versionlatest p {
background-color: #eee;
border-radius: 5px;
margin: 0;
padding: 2px 5px 2px 10px;
}
.versionlatest em {
background-color: #23d160;
padding: 0 5px;
font-style: normal;
border-radius: 5px;
margin-left: 10px;
}
/* Fix scroll to anchor hides title */
h1::before, h2::before, h3::before, h4::before, h5::before, h6::before {
display: block;
@ -63,47 +132,6 @@ h1 {
border-bottom: none !important
}
/* Global Navbar */
ul#globalnav {
background-color: #ededed;
list-style: none;
width: 100%;
margin: 0;
padding: 0;
overflow: hidden;
position: fixed;
left: 0px;
top: 0px;
font-size: 0.6em;
height: 30px;
}
ul#globalnav::after {
content: "";
display: block;
clear: both;
}
ul#globalnav li {
float: left;
}
ul#globalnav li a {
display: inline-block;
color: #004670;
text-align: center;
padding: 0.75em;
text-decoration: none;
}
ul#globalnav li a:hover {
color: #428bca;
}
#toc.toc2 {
top: 30px;
bottom: 0px;
@ -115,11 +143,6 @@ body.toc2 {
}
@media only screen and (min-width:768px) {
ul#globalnav {
font-size: 0.75em;
height: 40px;
}
#toc.toc2 {
top: 40px;
}
@ -130,11 +153,6 @@ body.toc2 {
}
@media only screen and (min-width:1280px) {
ul#globalnav {
font-size: 1em;
height: 48px;
}
#toc.toc2 {
top: 48px;
}

11
aggregation/navbar.html
View file

@ -1,14 +1,3 @@
<ul id="globalnav">
<li><a href="../getting_started/{masterFile}.html">Getting Started</a></li>
<li><a href="../server_installation/{masterFile}.html">Server Installation</a></li>
<li><a href="../securing_apps/{masterFile}.html">Securing Apps</a></li>
<li><a href="../server_admin/{masterFile}.html">Server Admin</a></li>
<li><a href="../server_development/{masterFile}.html">Server Development</a></li>
<li><a href="../authorization_services/{masterFile}.html">Authorization Services</a></li>
<li><a href="../upgrading/{masterFile}.html">Upgrading</a></li>
<li><a href="../release_notes/{masterFile}.html">Release Notes</a></li>
</ul>
<script src="https://cdnjs.cloudflare.com/ajax/libs/tocbot/4.4.2/tocbot.js"></script>
<script>

1
authorization_services/index.adoc
View file

@ -9,6 +9,7 @@ include::topics/templates/document-attributes-community.adoc[]
= {authorizationguide_name}
:release_header_guide: {authorizationguide_name_short}
:release_header_latest_link: {authorizationguide_link_latest}
include::topics/templates/release-header.adoc[]

1
getting_started/index.adoc
View file

@ -9,6 +9,7 @@ include::topics/templates/document-attributes-community.adoc[]
= {gettingstarted_name}
:release_header_guide: {gettingstarted_name_short}
:release_header_latest_link: {gettingstarted_link_latest}
include::topics/templates/release-header.adoc[]

1
release_notes/index.adoc
View file

@ -9,6 +9,7 @@ include::topics/templates/document-attributes-community.adoc[]
= {releasenotes_name}
:release_header_guide: {releasenotes_name_short}
:release_header_latest_link: {releasenotes_link_latest}
include::topics/templates/release-header.adoc[]

1
securing_apps/index.adoc
View file

@ -9,6 +9,7 @@ include::topics/templates/document-attributes-community.adoc[]
= {adapterguide_name}
:release_header_guide: {adapterguide_name_short}
:release_header_latest_link: {adapterguide_link_latest}
include::topics/templates/release-header.adoc[]

1
server_admin/index.adoc
View file

@ -9,6 +9,7 @@ include::topics/templates/document-attributes-community.adoc[]
= {adminguide_name}
:release_header_guide: {adminguide_name_short}
:release_header_latest_link: {adminguide_link_latest}
include::topics/templates/release-header.adoc[]

1
server_development/index.adoc
View file

@ -9,6 +9,7 @@ include::topics/templates/document-attributes-community.adoc[]
= {developerguide_name}
:release_header_guide: {developerguide_name_short}
:release_header_latest_link: {developerguide_link_latest}
include::topics/templates/release-header.adoc[]

1
server_installation/index.adoc
View file

@ -9,6 +9,7 @@ include::topics/templates/document-attributes-community.adoc[]
= {installguide_name}
:release_header_guide: {installguide_name_short}
:release_header_latest_link: {installguide_link_latest}
include::topics/templates/release-header.adoc[]

3
tests/src/test/resources/guide-url-fragments-community
View file

@ -5,4 +5,5 @@ securing_apps=securing_apps
server_admin=server_admin
server_development=server_development
server_installation=server_installation
upgrading=upgrading
upgrading=upgrading
release_notes=release_notes

3
tests/src/test/resources/guide-url-fragments-product
View file

@ -5,4 +5,5 @@ securing_apps=securing_applications_and_services_guide
server_admin=server_administration_guide
server_development=server_developer_guide
server_installation=server_installation_and_configuration_guide
upgrading=upgrading_guide
upgrading=upgrading_guide
release_notes=release_notes

8
topics/templates/document-attributes-community.adoc
View file

@ -25,14 +25,17 @@ endif::[]
:quickstartRepo_dir: keycloak-quickstarts
:authorizationguide_name: Authorization Services Guide
:authorizationguide_name_short: Authorization Services
:authorizationguide_link: {project_doc_base_url}/authorization_services/
:authorizationguide_link_latest: {project_doc_base_url_latest}/authorization_services/
:adapterguide_name: Securing Applications and Services Guide
:adapterguide_name_short: Securing Apps
:adapterguide_link: {project_doc_base_url}/securing_apps/
:adapterguide_link_js_adapter: {adapterguide_link}#_javascript_adapter
:adapterguide_link_latest: {project_doc_base_url_latest}/securing_apps/
:adapterguide_logout_link: {adapterguide_link}#_java_adapter_logout
:adminguide_name: Server Administration Guide
:adminguide_name_short: Server Administration
:adminguide_link: {project_doc_base_url}/server_admin/
:adminguide_link_latest: {project_doc_base_url_latest}/server_admin/
:adminguide_bruteforce_name: Password guess: brute force attacks
@ -44,6 +47,7 @@ endif::[]
:apidocs_name: API Documentation
:apidocs_link: https://www.keycloak.org/docs/{project_versionDoc}/api_documentation/
:developerguide_name: Server Developer Guide
:developerguide_name_short: Server Developer
:developerguide_link: {project_doc_base_url}/server_development/
:developerguide_link_latest: {project_doc_base_url_latest}/server_development/
:developerguide_actiontoken_name: Action Token SPI
@ -51,16 +55,20 @@ endif::[]
:developerguide_jsproviders_name: JavaScript Providers
:developerguide_jsproviders_link: {developerguide_link}#_script_providers
:gettingstarted_name: Getting Started Guide
:gettingstarted_name_short: Getting Started
:gettingstarted_link: {project_doc_base_url}/getting_started/
:gettingstarted_link_latest: {project_doc_base_url_latest}/getting_started/
:upgradingguide_name: Upgrading Guide
:upgradingguide_name_short: Upgrading
:upgradingguide_link: {project_doc_base_url}/upgrading/
:upgradingguide_link_latest: {project_doc_base_url_latest}/upgrading/
:releasenotes_name: Release Notes
:releasenotes_name_short: {releasenotes_name}
:releasenotes_link: {project_doc_base_url}/release_notes/
:releasenotes_link_latest: {project_doc_base_url_latest}/release_notes/
:installguide_name: Server Installation and Configuration Guide
:installguide_name_short: Server Installation
:installguide_link: {project_doc_base_url}/server_installation/
:installguide_link_latest: {project_doc_base_url_latest}/server_installation/
:installguide_clustering_name: Clustering

33
topics/templates/release-header.adoc
View file

@ -1,3 +1,35 @@
[.top-menu-guides]
====
*{release_header_guide}* icon:angle-down[]
ifeval::["{release_header_guide}" != "{gettingstarted_name_short}"]
* {gettingstarted_link}[{gettingstarted_name_short}]
endif::[]
ifeval::["{release_header_guide}" != "{installguide_name_short}"]
* {installguide_link}[{installguide_name_short}]
endif::[]
ifeval::["{release_header_guide}" != "{adapterguide_name_short}"]
* {adapterguide_link}[{adapterguide_name_short}]
endif::[]
ifeval::["{release_header_guide}" != "{adminguide_name_short}"]
* {adminguide_link}[{adminguide_name_short}]
endif::[]
ifeval::["{release_header_guide}" != "{developerguide_name_short}"]
* {developerguide_link}[{developerguide_name_short}]
endif::[]
ifeval::["{release_header_guide}" != "{authorizationguide_name_short}"]
* {authorizationguide_link}[{authorizationguide_name_short}]
endif::[]
ifeval::["{release_header_guide}" != "{upgradingguide_name_short}"]
* {upgradingguide_link}[{upgradingguide_name_short}]
endif::[]
ifeval::["{release_header_guide}" != "{releasenotes_name_short}"]
* {releasenotes_link}[{releasenotes_name_short}]
endif::[]
====
[.top-menu-version]
====
ifeval::["{project_buildType}" == "latest"]
[.versionlatest]
Version *{project_version}* _Latest_
@ -6,3 +38,4 @@ ifeval::["{project_buildType}" == "archive"]
[.versionarchive]
Version *{project_version}* _{release_header_latest_link}[Click here for latest]_
endif::[]
====

1
upgrading/index.adoc
View file

@ -9,6 +9,7 @@ include::topics/templates/document-attributes-community.adoc[]
= {upgradingguide_name}
:release_header_guide: {upgradingguide_name_short}
:release_header_latest_link: {upgradingguide_link_latest}
include::topics/templates/release-header.adoc[]