Repository: syncope Updated Branches: refs/heads/master 5dc51917f -> 434d19589
[SYNCOPE-700] Improved HTML and PDF templates, better index for reference guide: time to write Project: http://git-wip-us.apache.org/repos/asf/syncope/repo Commit: http://git-wip-us.apache.org/repos/asf/syncope/commit/434d1958 Tree: http://git-wip-us.apache.org/repos/asf/syncope/tree/434d1958 Diff: http://git-wip-us.apache.org/repos/asf/syncope/diff/434d1958 Branch: refs/heads/master Commit: 434d19589f9ac8b959fa21235fc2278d8ec4bc70 Parents: 5dc5191 Author: Francesco Chicchiriccò <[email protected]> Authored: Tue Sep 29 15:16:46 2015 +0200 Committer: Francesco Chicchiriccò <[email protected]> Committed: Tue Sep 29 15:16:46 2015 +0200 ---------------------------------------------------------------------- pom.xml | 17 +- .../getting-started/docinfo-footer.html | 23 ++ .../getting-started/getting-started.adoc | 14 +- .../reference-guide/docinfo-footer.html | 23 ++ .../reference-guide/reference-guide.adoc | 60 +++- src/main/asciidoc/syncope-theme.yml | 276 +++++++++++++++++++ 6 files changed, 395 insertions(+), 18 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/syncope/blob/434d1958/pom.xml ---------------------------------------------------------------------- diff --git a/pom.xml b/pom.xml index e0b4b184e..987f865 100644 --- a/pom.xml +++ b/pom.xml @@ -1342,7 +1342,11 @@ under the License. <goal>execute</goal> </goals> <configuration> - <source> + <source> + import java.util.Date + import java.text.MessageFormat + def year = MessageFormat.format("{0,date,yyyy}", new Date()) + project.properties['year'] = year project.properties['licenseUrl'] = project.parent.licenses[0].url </source> </configuration> @@ -1534,12 +1538,13 @@ under the License. <sourceHighlighter>coderay</sourceHighlighter> <attributes> <docVersion>${project.version}</docVersion> + <year>${year}</year> <numbered>true</numbered> <icons>font</icons> <pagenums/> <idprefix/> <idseparator>-</idseparator> - <last-update-label>Copyright © 2010â2015 The Apache Software Foundation. All rights reserved. Last Updated:</last-update-label> + <allow-uri-read/> </attributes> </configuration> <executions> @@ -1565,6 +1570,10 @@ under the License. <sourceDirectory>${basedir}/src/main/asciidoc/getting-started</sourceDirectory> <sourceDocumentName>getting-started.adoc</sourceDocumentName> <backend>pdf</backend> + <attributes> + <pdf-stylesdir>${basedir}/src/main/asciidoc</pdf-stylesdir> + <pdf-style>syncope</pdf-style> + </attributes> </configuration> </execution> <execution> @@ -1589,6 +1598,10 @@ under the License. <sourceDirectory>${basedir}/src/main/asciidoc/reference-guide</sourceDirectory> <sourceDocumentName>reference-guide.adoc</sourceDocumentName> <backend>pdf</backend> + <attributes> + <pdf-stylesdir>${basedir}/src/main/asciidoc</pdf-stylesdir> + <pdf-style>syncope</pdf-style> + </attributes> </configuration> </execution> </executions> http://git-wip-us.apache.org/repos/asf/syncope/blob/434d1958/src/main/asciidoc/getting-started/docinfo-footer.html ---------------------------------------------------------------------- diff --git a/src/main/asciidoc/getting-started/docinfo-footer.html b/src/main/asciidoc/getting-started/docinfo-footer.html new file mode 100644 index 0000000..6fdbd5f --- /dev/null +++ b/src/main/asciidoc/getting-started/docinfo-footer.html @@ -0,0 +1,23 @@ +<!-- +Licensed to the Apache Software Foundation (ASF) under one +or more contributor license agreements. See the NOTICE file +distributed with this work for additional information +regarding copyright ownership. The ASF licenses this file +to you under the Apache License, Version 2.0 (the +"License"); you may not use this file except in compliance +with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, +software distributed under the License is distributed on an +"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +KIND, either express or implied. See the License for the +specific language governing permissions and limitations +under the License. +--> +<div id="footer-text"> + <small>Copyright © 2010â{year} <a href="http://www.apache.org/";>The Apache Software Foundation</a>. + All rights reserved. + </small> +</div> http://git-wip-us.apache.org/repos/asf/syncope/blob/434d1958/src/main/asciidoc/getting-started/getting-started.adoc ---------------------------------------------------------------------- diff --git a/src/main/asciidoc/getting-started/getting-started.adoc b/src/main/asciidoc/getting-started/getting-started.adoc index 9643501..12aeccf 100644 --- a/src/main/asciidoc/getting-started/getting-started.adoc +++ b/src/main/asciidoc/getting-started/getting-started.adoc @@ -19,19 +19,25 @@ // Quick reference: http://asciidoctor.org/docs/asciidoc-syntax-quick-reference/ // User manual: http://asciidoctor.org/docs/user-manual/ +// Tricks: https://leanpub.com/awesomeasciidoctornotebook/read -= Apache Syncope - Getting Started -:revnumber: {docVersion} -:toc: right -:toclevels: 4 :homepage: http://syncope.apache.org :description: Several ways to get started with Apache Syncope :keywords: Apache Syncope, IdM, provisioning, identity management, getting started, tutorial +:docinfo1: +:last-update-label!: :sectanchors: :sectnums: :sectlinks: += Apache Syncope - Getting Started +:revnumber: {docVersion} +:toc: right +:toclevels: 4 + +image::http://syncope.apache.org/images/apache-syncope-logo-small.jpg[Apache Syncope logo] + [NOTE] .This document is under active development and discussion! If you find errors or omissions in this document, please donât hesitate to http://git-wip-us.apache.org/repos/asf/syncope/blob/434d1958/src/main/asciidoc/reference-guide/docinfo-footer.html ---------------------------------------------------------------------- diff --git a/src/main/asciidoc/reference-guide/docinfo-footer.html b/src/main/asciidoc/reference-guide/docinfo-footer.html new file mode 100644 index 0000000..6fdbd5f --- /dev/null +++ b/src/main/asciidoc/reference-guide/docinfo-footer.html @@ -0,0 +1,23 @@ +<!-- +Licensed to the Apache Software Foundation (ASF) under one +or more contributor license agreements. See the NOTICE file +distributed with this work for additional information +regarding copyright ownership. The ASF licenses this file +to you under the Apache License, Version 2.0 (the +"License"); you may not use this file except in compliance +with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, +software distributed under the License is distributed on an +"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +KIND, either express or implied. See the License for the +specific language governing permissions and limitations +under the License. +--> +<div id="footer-text"> + <small>Copyright © 2010â{year} <a href="http://www.apache.org/";>The Apache Software Foundation</a>. + All rights reserved. + </small> +</div> http://git-wip-us.apache.org/repos/asf/syncope/blob/434d1958/src/main/asciidoc/reference-guide/reference-guide.adoc ---------------------------------------------------------------------- diff --git a/src/main/asciidoc/reference-guide/reference-guide.adoc b/src/main/asciidoc/reference-guide/reference-guide.adoc index 48c2a80..5902735 100644 --- a/src/main/asciidoc/reference-guide/reference-guide.adoc +++ b/src/main/asciidoc/reference-guide/reference-guide.adoc @@ -19,19 +19,25 @@ // Quick reference: http://asciidoctor.org/docs/asciidoc-syntax-quick-reference/ // User manual: http://asciidoctor.org/docs/user-manual/ +// Tricks: https://leanpub.com/awesomeasciidoctornotebook/read -= Apache Syncope - Reference Guide -:revnumber: {docVersion} -:toc: right -:toclevels: 4 :homepage: http://syncope.apache.org :description: Comprehensive guide about Apache Syncope :keywords: Apache Syncope, IdM, provisioning, identity management, reference, guide +:docinfo1: +:last-update-label!: :sectanchors: :sectnums: :sectlinks: += Apache Syncope - Reference Guide +:revnumber: {docVersion} +:toc: right +:toclevels: 4 + +image::http://syncope.apache.org/images/apache-syncope-logo-small.jpg[Apache Syncope logo] + [NOTE] .This document is under active development and discussion! If you find errors or omissions in this document, please donât hesitate to @@ -58,7 +64,15 @@ compliance. === Access Managers -== Building blocks +=== The Complete Picture + +== Architecture + +=== Design Principles + +=== Implementation Guidelines + +== Concepts === Data model @@ -66,34 +80,56 @@ compliance. ==== Attributes -==== Mapping +==== Users, Groups and Any objects + +=== Tasks + +=== Provisioning -=== The external world +==== Connectors -==== Connectors, Resources +==== Resources -==== Propagation & Synchronization +==== Propagation, Push & Synchronization === Policies -=== Workflow +==== Account + +==== Password + +==== Push + +==== Synchronization + +=== Workflow and Approval + +=== Notifications === Reports +=== Audit + == Working with Apache Syncope -=== Architecture +=== Using the Admin Console === RESTful services ==== Client library -=== Extending +=== Extending Apache Syncope ==== Core ==== Console +=== Deploying in production + +=== Options + +=== High-Availability + == Examples // Chapters will be placed in separate .adoc files in the same directory http://git-wip-us.apache.org/repos/asf/syncope/blob/434d1958/src/main/asciidoc/syncope-theme.yml ---------------------------------------------------------------------- diff --git a/src/main/asciidoc/syncope-theme.yml b/src/main/asciidoc/syncope-theme.yml new file mode 100644 index 0000000..4635b36 --- /dev/null +++ b/src/main/asciidoc/syncope-theme.yml @@ -0,0 +1,276 @@ +# Licensed to the Apache Software Foundation (ASF) under one or more +# contributor license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright ownership. +# The ASF licenses this file to You under the Apache License, Version 2.0 +# (the "License"); you may not use this file except in compliance with +# the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +# Fork from https://github.com/asciidoctor/asciidoctor-pdf/blob/master/data/themes/default-theme.yml +# PDF styling guide: https://github.com/asciidoctor/asciidoctor-pdf/blob/master/docs/theming-guide.adoc + +font: + catalog: + # Noto Serif supports Latin, Latin-1 Supplement, Latin Extended-A, Greek, Cyrillic, Vietnamese & an assortment of symbols + Noto Serif: + normal: notoserif-regular-subset.ttf + bold: notoserif-bold-subset.ttf + italic: notoserif-italic-subset.ttf + bold_italic: notoserif-bold_italic-subset.ttf + # M+ 1mn supports ASCII and the circled numbers used for conums + M+ 1mn: + normal: mplus1mn-regular-ascii-conums.ttf + bold: mplus1mn-bold-ascii.ttf + italic: mplus1mn-italic-ascii.ttf + bold_italic: mplus1mn-bold_italic-ascii.ttf + # M+ 1p supports Latin, Latin-1 Supplement, Latin Extended, Greek, Cyrillic, Vietnamese, Japanese & an assortment of symbols + # It also provides arrows for ->, <-, => and <= replacements in case these glyphs are missing from font + M+ 1p Fallback: + normal: mplus1p-regular-fallback.ttf + bold: mplus1p-regular-fallback.ttf + italic: mplus1p-regular-fallback.ttf + bold_italic: mplus1p-regular-fallback.ttf + fallbacks: + - M+ 1p Fallback +page: + background_color: ffffff + layout: portrait + margin: [0.5in, 0.67in, 0.67in, 0.67in] + size: A4 +base: + align: justify + # color as hex string (leading # is optional) + font_color: 333333 + # color as RGB array + #font_color: [51, 51, 51] + # color as CMYK array (approximated) + #font_color: [0, 0, 0, 0.92] + #font_color: [0, 0, 0, 92%] + font_family: Noto Serif + # choose one of these font_size/line_height_length combinations + #font_size: 14 + #line_height_length: 20 + #font_size: 11.25 + #line_height_length: 18 + #font_size: 11.2 + #line_height_length: 16 + font_size: 10.5 + #line_height_length: 15 + # correct line height for Noto Serif metrics + line_height_length: 12 + #font_size: 11.25 + #line_height_length: 18 + line_height: $base_line_height_length / $base_font_size + font_size_large: round($base_font_size * 1.25) + font_size_small: round($base_font_size * 0.85) + font_size_min: $base_font_size * 0.75 + font_style: normal + border_color: eeeeee + border_radius: 4 + border_width: 0.5 +# FIXME vertical_rhythm is weird; we should think in terms of ems +#vertical_rhythm: $base_line_height_length * 2 / 3 +# correct line height for Noto Serif metrics (comes with built-in line height) +vertical_rhythm: $base_line_height_length +horizontal_rhythm: $base_line_height_length +# QUESTION should vertical_spacing be block_spacing instead? +vertical_spacing: $vertical_rhythm +link: + font_color: 428bca +# literal is currently used for inline monospaced in prose and table cells +literal: + font_color: b12146 + font_family: M+ 1mn +heading: + #font_color: 181818 + font_color: $base_font_color + font_family: $base_font_family + font_style: bold + # h1 is used for part titles + h1_font_size: floor($base_font_size * 2.6) + # h2 is used for chapter titles + h2_font_size: floor($base_font_size * 2.15) + h3_font_size: round($base_font_size * 1.7) + h4_font_size: $base_font_size_large + h5_font_size: $base_font_size + h6_font_size: $base_font_size_small + #line_height: 1.4 + # correct line height for Noto Serif metrics (comes with built-in line height) + line_height: 1.2 + margin_top: $vertical_rhythm * 0.2 + margin_bottom: $vertical_rhythm * 0.8 +title_page: + align: right + logo: + top: 10% + image: http://syncope.apache.org/images/apache-syncope-logo-small.jpg + title: + top: 55% + font_size: $heading_h1_font_size + font_color: 999999 + line_height: 0.9 + subtitle: + font_size: $heading_h3_font_size + font_style: bold_italic + line_height: 1 + authors: + margin_top: $base_font_size * 1.25 + font_size: $base_font_size_large + font_color: 181818 + revision: + margin_top: $base_font_size * 1.25 +block: + margin_top: 0 + margin_bottom: $vertical_rhythm +caption: + align: left + font_style: italic + # FIXME perhaps set line_height instead of / in addition to margins? + margin_inside: $vertical_rhythm / 3 + #margin_inside: $vertical_rhythm / 4 + margin_outside: 0 +lead: + font_size: $base_font_size_large + line_height: 1.4 +abstract: + font_color: 5c6266 + font_size: $lead_font_size + line_height: $lead_line_height + font_style: italic +admonition: + border_color: $base_border_color + border_width: $base_border_width + padding: [0, $horizontal_rhythm, 0, $horizontal_rhythm] +blockquote: + font_color: $base_font_color + font_size: $base_font_size_large + border_color: $base_border_color + border_width: 5 + padding: [$vertical_rhythm / 2, $horizontal_rhythm, $vertical_rhythm / -2, $horizontal_rhythm + $blockquote_border_width / 2] + cite_font_size: $base_font_size_small + cite_font_color: 999999 +# code is used for source blocks (perhaps change to source or listing?) +code: + font_color: $base_font_color + font_family: $literal_font_family + font_size: ceil($base_font_size) + padding: $code_font_size + line_height: 1.25 + background_color: f5f5f5 + border_color: cccccc + border_radius: $base_border_radius + border_width: 0.75 +conum: + font_family: M+ 1mn + font_color: $literal_font_color + font_size: $base_font_size + line_height: 4 / 3 +example: + border_color: $base_border_color + border_radius: $base_border_radius + border_width: 0.75 + background_color: transparent + # FIXME reenable margin bottom once margin collapsing is implemented + padding: [$vertical_rhythm, $horizontal_rhythm, 0, $horizontal_rhythm] +image: + align: left +prose: + margin_top: 0 + margin_bottom: $vertical_rhythm +sidebar: + border_color: $page_background_color + border_radius: $base_border_radius + border_width: $base_border_width + background_color: eeeeee + # FIXME reenable margin bottom once margin collapsing is implemented + padding: [$vertical_rhythm, $vertical_rhythm * 1.25, 0, $vertical_rhythm * 1.25] + title: + align: center + font_color: $heading_font_color + font_family: $heading_font_family + font_size: $heading_h4_font_size + font_style: $heading_font_style +thematic_break: + border_color: $base_border_color + border_style: solid + border_width: $base_border_width + margin_top: $vertical_rhythm * 0.5 + margin_bottom: $vertical_rhythm * 1.5 +description_list: + term_font_style: italic + term_spacing: $vertical_rhythm / 4 + description_indent: $horizontal_rhythm * 1.25 +outline_list: + indent: $horizontal_rhythm * 1.5 + # NOTE item_spacing applies to list items that do not have complex content + item_spacing: $vertical_rhythm / 2 + #marker_font_color: 404040 +table: + background_color: $page_background_color + #head_background_color: <hex value> + #head_font_color: $base_font_color + head_font_style: bold + even_row_background_color: f9f9f9 + #odd_row_background_color: <hex value> + foot_background_color: f0f0f0 + border_color: dddddd + border_width: $base_border_width + # HACK accounting for line-height + cell_padding: [3, 3, 6, 3] +toc: + dot_leader_color: dddddd + #dot_leader_content: '. ' + indent: $horizontal_rhythm + line_height: 1.4 +header: + font_size: $base_font_size_small + font_color: $base_font_color + border_color: dddddd + border_width: 0.25 + height: $base_line_height_length * 2.5 + line_height: 1 + padding: [$base_line_height_length / 2, 1, 0, 1] + vertical_align: bottom + recto_content: + center: '{document-title} - {revnumber}' + verso_content: + center: '{document-title} - {revnumber}' +footer: + font_size: $base_font_size_small + font_color: $base_font_color + # NOTE if background_color is set, background and border will span width of page + border_color: dddddd + border_width: 0.25 + height: $base_line_height_length * 2.5 + line_height: 1 + padding: [$base_line_height_length / 2, 1, 0, 1] + vertical_align: top + #image_vertical_align: <alignment> or <number> + # additional attributes for content: + # * {page-count} + # * {page-number} + # * {document-title} + # * {document-subtitle} + # * {chapter-title} + # * {section-title} + # * {section-or-chapter-title} + recto_content: + right: '_Copyright © 2010â{year} The Apache Software Foundation. All rights reserved._ | + {section-or-chapter-title} | + {page-number}' + #right: '{document-title} | {page-number}' + #right: '{page-number}' + #center: '{page-number}' + verso_content: + left: '{page-number} | + {section-or-chapter-title} | + _Copyright © 2010â{year} The Apache Software Foundation. All rights reserved._' + #left: '{page-number}' + #center: '{page-number}' \ No newline at end of file
