Repository: sling-site Updated Branches: refs/heads/master 79bfc6ee5 -> 1d7eb3f39
Replace refs. by their literal values, or remove corresponding links, most of them were invalid/obsolete anyway Project: http://git-wip-us.apache.org/repos/asf/sling-site/repo Commit: http://git-wip-us.apache.org/repos/asf/sling-site/commit/1d7eb3f3 Tree: http://git-wip-us.apache.org/repos/asf/sling-site/tree/1d7eb3f3 Diff: http://git-wip-us.apache.org/repos/asf/sling-site/diff/1d7eb3f3 Branch: refs/heads/master Commit: 1d7eb3f3968fb1157aa25a41342ebf37e6de12d6 Parents: 79bfc6e Author: Bertrand Delacretaz <[email protected]> Authored: Mon Jun 26 14:09:05 2017 +0200 Committer: Bertrand Delacretaz <[email protected]> Committed: Mon Jun 26 14:09:05 2017 +0200 ---------------------------------------------------------------------- README.md | 12 +- content/documentation.md | 154 +------------------ .../bundles/jcr-installer-provider.md | 7 +- ...ontent-the-slingpostservlet-servlets-post.md | 2 +- .../sling-settings-org-apache-sling-settings.md | 2 +- .../development/client-request-logging.md | 4 +- .../development/embedding-sling.md | 4 +- content/documentation/development/logging.md | 4 +- content/documentation/getting-started.md | 4 +- content/documentation/legacy/logging.md | 4 +- content/documentation/the-sling-engine.md | 4 +- .../the-sling-engine/architecture.md | 5 +- .../the-sling-engine/authentication.md | 8 +- .../documentation/the-sling-engine/filters.md | 4 +- .../mappings-for-resource-resolution.md | 2 +- .../the-sling-engine/request-parameters.md | 4 +- .../documentation/the-sling-engine/resources.md | 2 +- .../the-sling-engine/service-authentication.md | 2 +- .../how-to-manage-events-in-sling.md | 4 +- content/guides.md | 22 +-- 20 files changed, 47 insertions(+), 207 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/sling-site/blob/1d7eb3f3/README.md ---------------------------------------------------------------------- diff --git a/README.md b/README.md index 004480c..f4b33fb 100644 --- a/README.md +++ b/README.md @@ -50,8 +50,18 @@ The following pages still have problems with that: * Tables work now, needed the pegdown TABLES extension * Move images and other files to /assets and convert their links -## JBake notes +## JBake and other techn notes * Currently using 2.5.1, see under `/bin`, docs at http://jbake.org/docs/2.5.1 * Uses https://github.com/sirthias/pegdown for Markdown, syntax info at https://github.com/sirthias/pegdown/blob/master/src/test/resources/MarkdownTest103/Markdown%20Documentation%20-%20Syntax.md , extensions at http://www.decodified.com/pegdown/api/org/pegdown/Extensions.html * Groovy MarkupTemplateEngine examples at https://github.com/jbake-org/jbake-example-project-groovy-mt , docs for that engine at http://groovy-lang.org/templating.html#_simpletemplateengine * Other Apache projects using JBake include at least Tamaya and OpenNLP and the Incubator is apparently also switching to it. + +##Â Useful scripts and commands +To find broken links use + + wget --spider -r -nd -nv -l 5 http://localhost:8820/ 2>&1 | grep -B1 'broken link' + +To find leftover `refs.` in pages use + + wget -r -nv -l 5 http://localhost:8820/ + find localhost\:8820/ -type f | xargs grep -l 'refs\.' http://git-wip-us.apache.org/repos/asf/sling-site/blob/1d7eb3f3/content/documentation.md ---------------------------------------------------------------------- diff --git a/content/documentation.md b/content/documentation.md index 2857d82..f5d8a1b 100644 --- a/content/documentation.md +++ b/content/documentation.md @@ -26,25 +26,6 @@ We're on the way to improve the documentation, but it's a long way. If you would # How the documentation is generated -*The Sling web site and documentation are managed with the [Apache CMS](https://www.apache.org/dev/cms.html). -For Apache Sling specific extensions see the [The Sling Site](#the-sling-site) -section below.* - -<div class="info"> -<p> -The Sling site was converted from a Confluence exported site to an -Apache CMS managed site. All non-fully converted pages will show a tip box pointing to -the original Confluence exported page for reference. -</p> - -<p> -Once migration of a page has completed the <code>translation_pending</code> -header should be removed from the page source. After that the tip box will not be -shown any more. -</p> - -</div> - The basic documentation of Sling is made up of four parts: 1. The Sling Site at http://sling.apache.org/ (you are here) @@ -55,139 +36,8 @@ The basic documentation of Sling is made up of four parts: This page is about how this documentation is maintained and who is allowed to do what. -## The Sling Site - -The site is managed with the [Apache CMS](https://www.apache.org/dev/cms.html) -where the source is kept in SVN at <https://svn.apache.org/repos/asf/sling/site/trunk/content>. - -This section lists some Apache Sling features to help with the maintenance -of the site, such as automatic link generation. - -Start the file with a `Title:` line to define the page title and the first H1 tag: - - Title: Page Title - - Here comes the content separated with a blank like from the - header ... - -The last modification information from SVN (revision, committer, and -date/time) is automatically added when the page is rendered - -Excerpts can be added to a page using the `Excerpt:` header: - - Title: Page Title - Excerpt: Summary of the page for inclusion in other pages; - continuation of the excerpt must be indented - - Here comes the content separated with a blank like from the - header ... - -Metadata from child pages can be referred to in the content with the -Django variable reference notation using the child page name (without -extension) as its container; e.g. for the child page named `childpage`: - - :::django - {{ y|default:"{{" }} children.childpage.headers.excerpt }} - {{ y|default:"{{" }} children.childpage.headers.title }} - -Content Pages can contain Django templates of the form `{{ y|default:"{{" }}...}}` and `{{ y|default:"{%" }}...%}`. -If so, the page content is evaluated as a Django template before running -it through the page template. - -Any page in the site can be referenced with refs.pagename returning properties: - -`.path` -: the absolute path of the page on the site - -`.headers` -: page headers (e.g. `.title`, `.excerpt`) - -`.content` -: the raw page content - -All pages in the children namespace are also available in the refs namespace - -Some usefull hints: - -Printing title of another page "handler": - - :::django - {{ y|default:"{{" }} refs.handler.headers.title }} - -Printing excerpt of another page "handler": - - :::django - {{ y|default:"{{" }} refs.handler.headers.excerpt }} - -Linking to another page "handler": - - :::django - ({{ y|default:"{{" }} refs.handler.path }}) - -Printing title as a link to another page "handler": - - :::django - [{{ y|default:"{{" }} refs.handler.headers.title }}]({{ y|default:"{{" }} refs.handler.path }}) - -Printing excerpt as a link to another page "handler": - - :::django - [{{ y|default:"{{" }} refs.handler.headers.excerpt }}]({{ y|default:"{{" }} refs.handler.path }}) - -Print a bullet pointed child page list: - - :::django - {{ y|default:"{%" }} for label, page in children %}* [{{ y|default:"{{" }} page.headers.title }}]({{ y|default:"{{" }} page.path }}) - {{ y|default:"{%" }} endfor %} - -<div class="note"> -It is important to have the first part as a single line, otherwise -the Django/Markdown combo will create a list for each entry. -</div> - -### Code Highlighting - -Code Highlighting works by indenting code by four blanks. To indicate the -type of highlighting preced the code style text with either `:::<lexer>` to -get high lighted code using the given `<lexer>` or `#!<lexer>` to get high -lighted code with line numbers using the given `<lexer>`. See -<http://www.apache.org/dev/cmsref.html#code-hilighter> for main info and -<http://pygments.org/docs/lexers/> for supported lexers - - -### Manual Generation - -When commiting changes to pages into SVN the pages are automatically -generated in [the staging site](http://sling.staging.apache.org). - -To manually generate the site or single pages the [site](http://svn.apache.org/repos/asf/felix/site) -can be checked out from SVN. In addition Perl and Python must be installed -for the build tools to work. - -To prepare for site build, the Markdown daemon has to be started: - - :::sh - $ export MARKDOWN_SOCKET="$PWD/tools/build/../markdown.socket" - $ export PYTHONPATH="$PWD/tools/build" - $ python "$PWD/tools/build/markdownd.py" - -The `MARKDOWN_SOCKET` environment variables is also required by the `build_site.pl` -and `build_file.pl` scripts to connect to the Markdown daemon. - -To build the complete site use the `build_site.pl` script: - - :::sh - $ tools/build/build_site.pl --source-base $PWD/trunk \ - --target-base $PWD/trunk/target - -To build a single page use the `build_file.pl` script: - - :::sh - $ tools/build/build_site.pl --source-base $PWD/trunk \ - --target-base $PWD/trunk/target \ - --source content/documentation.mdtext - -The argument to the `--source` parameter is relative to the `--source-base` folder. +## The Sling Website +TODO this page needs to be adapted to the JBake site generation mechanisms. ## The Public Wiki http://git-wip-us.apache.org/repos/asf/sling-site/blob/1d7eb3f3/content/documentation/bundles/jcr-installer-provider.md ---------------------------------------------------------------------- diff --git a/content/documentation/bundles/jcr-installer-provider.md b/content/documentation/bundles/jcr-installer-provider.md index bbb6210..84a9c55 100644 --- a/content/documentation/bundles/jcr-installer-provider.md +++ b/content/documentation/bundles/jcr-installer-provider.md @@ -38,9 +38,10 @@ Here's a quick walkthrough of the JCR installer functionality. ## Installation Start the Sling [launchpad/app](http://svn.apache.org/repos/asf/sling/trunk/launchpad/app) and make sure that the following bundles are present and started: -* [RunMode service]({{ refs.run-modes-org-apache-sling-runmode.path }}) -* OSGi installer service ([org.apache.sling.installer.core](http://svn.apache.org/repos/asf/sling/trunk/installer/core)) -* JCR installer provider ([org.apache.sling.installer.provider.jcr](http://svn.apache.org/repos/asf/sling/trunk/installer/providers/jcr)) + + * [Sling Settings](sling-settings-org-apache-sling-settings.html) + * OSGi installer service ([org.apache.sling.installer.core](http://svn.apache.org/repos/asf/sling/trunk/installer/core)) + * JCR installer provider ([org.apache.sling.installer.provider.jcr](http://svn.apache.org/repos/asf/sling/trunk/installer/providers/jcr)) To watch the logs produced by these modules, you can filter `sling/logs/error.log` using `egrep 'jcrinstall|osgi.installer'`. http://git-wip-us.apache.org/repos/asf/sling-site/blob/1d7eb3f3/content/documentation/bundles/manipulating-content-the-slingpostservlet-servlets-post.md ---------------------------------------------------------------------- diff --git a/content/documentation/bundles/manipulating-content-the-slingpostservlet-servlets-post.md b/content/documentation/bundles/manipulating-content-the-slingpostservlet-servlets-post.md index 6c4a0c9..63e9297 100644 --- a/content/documentation/bundles/manipulating-content-the-slingpostservlet-servlets-post.md +++ b/content/documentation/bundles/manipulating-content-the-slingpostservlet-servlets-post.md @@ -476,7 +476,7 @@ If request is posted with an URL ending in slash `/` or slash-star `/*`, the Sli 1. If a `:name` parameter is supplied, the (first) value of this parameter is used unmodified as the name for the new node. If the name is illegally formed with respect to JCR name requirements, an exception will be thrown when trying to create the node. The assumption with the `:name` parameter is, that the caller knows what he (or she) is supplying and should get the exact result if possible. 1. Otherwise if a `:nameHint` parameter is supplied, the (first) value of this parameter is used to generate the node name. A name filtering is applied to this hint to ensure a valid JCR node name. -1. Otherwise a series of request parameters supplied to set content is inspected for a possible name. The list of the names of these parameter is configurable with the SlingPostServlet and defaults to `[ title, jcr:title, name, description, jcr:description, abstract ](` refs.-title-jcr-title-name-description-jcr-description-abstract.path `)`. The first request parameter with a non-empty value is used and filtered to get the valid JCR name. +1. Otherwise a series of request parameters supplied to set content is inspected for a possible name. The list of the names of these parameter is configurable with the SlingPostServlet and defaults to `title, jcr:title, name, description, jcr:description, abstract`. The first request parameter with a non-empty value is used and filtered to get the valid JCR name. 1. Otherwise an ever increasing auto generated number is used. Filtering is also applied to this numeric name. http://git-wip-us.apache.org/repos/asf/sling-site/blob/1d7eb3f3/content/documentation/bundles/sling-settings-org-apache-sling-settings.md ---------------------------------------------------------------------- diff --git a/content/documentation/bundles/sling-settings-org-apache-sling-settings.md b/content/documentation/bundles/sling-settings-org-apache-sling-settings.md index 55bfc6c..1d24d5b 100644 --- a/content/documentation/bundles/sling-settings-org-apache-sling-settings.md +++ b/content/documentation/bundles/sling-settings-org-apache-sling-settings.md @@ -14,7 +14,7 @@ The Sling Settings Bundle exposes the `SlingSettingsService` which allows access | `URL getSlingHome()` | `sling.home.url` | The Sling Home path as an `java.net.URL` instance | | `Set<String> getRunModes()` | `sling.run.modes` | The active Run Modes of the running Sling instance | -The new Sling Settings Bundle replaces the former [Run Modes (org.apache.sling.runmode)]({{ refs.run-modes-org-apache-sling-runmode.path }}) Bundle and the `SlingSettingsService` previously provided by the Sling Engine bundle, as it also implements the run modes logic. +The new Sling Settings Bundle replaces the former `org.apache.sling.runmode` bundle and the `SlingSettingsService` previously provided by the Sling Engine bundle, as it also implements the run modes logic. ## Selecting the active run modes The run modes are selected based on the `sling.run.modes` property (the "selection property"), specified in the Sling settings file or as a command-line parameter (which takes precedence), out of the valid run modes defined by the properties described below. The value is a String which contains a list of comma-separated run modes. If a run mode is given here which is not contained in any group of valid run modes (given in `sling.run.mode.install.options` or `sling.run.mode.options`) it is always active, on the other hand run modes which are contained in any of the predefined groups may be modified/removed (see below for the details). http://git-wip-us.apache.org/repos/asf/sling-site/blob/1d7eb3f3/content/documentation/development/client-request-logging.md ---------------------------------------------------------------------- diff --git a/content/documentation/development/client-request-logging.md b/content/documentation/development/client-request-logging.md index 724d206..c24e010 100644 --- a/content/documentation/development/client-request-logging.md +++ b/content/documentation/development/client-request-logging.md @@ -111,9 +111,9 @@ For security reasons non-printable and other special characters in %C, %i and %o If you want to write the request (and access) logging information into a rotated file, you should configure as follows: 1. Configure the Log Type to be a *Logger Name* and some usefull Logger name. For example `clientlog.request`. -1. Create an *Apache Sling Logging Logger Configuration* for this Logger name according to [Logging Configuration]({{ refs.logging-logger-configuration.path }}) with the following setup: +1. Create an *Apache Sling Logging Logger Configuration* for this Logger name, with the following setup: * Allow message at INFO (Information) level to be logged which is the level used by the request loggers * Define the appropriate log file name, for example `logs/client.request.log` * Use only `\{5`} as the message format because request logger messages are generally already fully formated with required timestamp etc. * Add any Logger names used for the client request log configuration, `clientlog.request` in the example above, to the Logger field. By clicking on the `+` (plus) button you may add more than a single logger name whose messages are written to this file. -1. Optionally, you may create an *Apache Sling Logging Writer Configuration* for the log file defined in the previous step to better control rotation setup. See [Log Writer Configuration]({{ refs.logging-log-writer-configuration.path }}) for full details. +1. Optionally, you may create an *Apache Sling Logging Writer Configuration* for the log file defined in the previous step to better control rotation setup. See the corresponding docs for full details. http://git-wip-us.apache.org/repos/asf/sling-site/blob/1d7eb3f3/content/documentation/development/embedding-sling.md ---------------------------------------------------------------------- diff --git a/content/documentation/development/embedding-sling.md b/content/documentation/development/embedding-sling.md index 9d665a1..8cd6d12 100644 --- a/content/documentation/development/embedding-sling.md +++ b/content/documentation/development/embedding-sling.md @@ -70,7 +70,7 @@ The standalone Java Application makes use of three classes: | MainDelegate | This class is loaded by the `Loader` from the `LauncherClassLoader` to actually complete the initial setup before creating the `Sling` class to start the framework. | | ControlListener | This class is used by the `Main` class to open a server socket to be able to start and stop Sling as a server. This class allows for starting (opening the server socket), status check (connecting to the socket asking for status), and shutdown (connecting to the socket asking for shutdown). | -At the moment these classes are not directly suitable to be embedded in an existing application (or custom application launcher framework) unless that embedding prepares command line arguments in a `String[]({{ refs..path }})` and calls the `Main.main` method. To allow for custom embeddings or extensions, the work distributions between the three classes should be refactored. +At the moment these classes are not directly suitable to be embedded in an existing application (or custom application launcher framework) unless that embedding prepares command line arguments in a `String[]` and calls the `Main.main` method. To allow for custom embeddings or extensions, the work distributions between the three classes should be refactored. ### Embedding the Standalone Java Application @@ -105,7 +105,7 @@ The `sling.control.action` takes either of three values: #### Conversion of Commandline Arguments to Properties -When calling the Main class through the JVM startup the `Main.main(String[]({{ refs..path }}) args)` methods is called which reads the command line arguments and converts them into a `Map<String, String>` suitable for the constructore as follows: +When calling the Main class through the JVM startup the `Main.main(String[] args)` methods is called which reads the command line arguments and converts them into a `Map<String, String>` suitable for the constructore as follows: | Command Line Argument | Properties Entry | |--|--| http://git-wip-us.apache.org/repos/asf/sling-site/blob/1d7eb3f3/content/documentation/development/logging.md ---------------------------------------------------------------------- diff --git a/content/documentation/development/logging.md b/content/documentation/development/logging.md index 6f98f15..d2d367f 100644 --- a/content/documentation/development/logging.md +++ b/content/documentation/development/logging.md @@ -77,7 +77,7 @@ The `org.apache.sling.commons.log` bundle gets its initial configuration from th | `org.apache.sling.commons.log.file` | undefined | Sets the log file to which log messages are written. If this property is empty or missing, log messages are written to `System.out`. | | `org.apache.sling.commons.log.file.number` | 5 | The number of rotated files to keep. | | `org.apache.sling.commons.log.file.size` | '.'yyyy-MM-dd | Defines how the log file is rotated (by schedule or by size) and when to rotate. See the section *Log File Rotation* below for full details on log file rotation. | -| `org.apache.sling.commons.log.pattern` | \{0,date,dd.MM.yyyy HH:mm:ss.SSS\} \*\{4\}\* \[\{2\}\]({{ refs.-2.path }}) \{3\} \{5\} | The `MessageFormat` pattern to use for formatting log messages with the root logger. | +| `org.apache.sling.commons.log.pattern` | \{0,date,dd.MM.yyyy HH:mm:ss.SSS\} \*\{4\}\* \{2\} \{3\} \{5\} | The `MessageFormat` pattern to use for formatting log messages with the root logger. | | `org.apache.sling.commons.log.julenabled` | n/a | Enables the `java.util.logging` support. | | `org.apache.sling.commons.log.configurationFile` | n/a | Path for the Logback config file which would be used to configure logging. If the path is not absolute then it would be resolved against Sling Home | | `org.apache.sling.commons.log.packagingDataEnabled` | true | Boolean property to control packaging data support of Logback. See [Packaging Data][11] section of Logback for more details | @@ -104,7 +104,7 @@ The following properties may be set: |--|--|--|--| | `org.apache.sling.commons.log.level` | `String` | `INFO` | Sets the logging level of the loggers. This may be any of the defined logging levels `DEBUG`, `INFO`, `WARN`, `ERROR` and `FATAL`. | | `org.apache.sling.commons.log.file` | `String` | undefined | Sets the log file to which log messages are written. If this property is empty or missing, log messages are written to `System.out`. This property should refer to the file name of a configured Log Writer (see below). If no Log Writer is configured with the same file name an implicit Log Writer configuration with default configuration is created. | -| `org.apache.sling.commons.log.pattern` | `String` | \{0,date,dd.MM.yyyy HH:mm:ss.SSS\} \*\{4\}\* \[\{2\}\]({{ refs.-2.path }}) \{3\} \{5\} | The `java.util.MessageFormat` pattern to use for formatting log messages with the root logger. This is a `java.util.MessageFormat` pattern supporting up to six arguments: \{0\} The timestamp of type `java.util.Date`, \{1\} the log marker, \{2\} the name of the current thread, \{3\} the name of the logger, \{4\} the log level and \{5\} the actual log message. If the log call includes a Throwable, the stacktrace is just appended to the message regardless of the pattern. | +| `org.apache.sling.commons.log.pattern` | `String` | \{0,date,dd.MM.yyyy HH:mm:ss.SSS\} \*\{4\}\* \{2\} \{3\} \{5\} | The `java.util.MessageFormat` pattern to use for formatting log messages with the root logger. This is a `java.util.MessageFormat` pattern supporting up to six arguments: \{0\} The timestamp of type `java.util.Date`, \{1\} the log marker, \{2\} the name of the current thread, \{3\} the name of the logger, \{4\} the log level and \{5\} the actual log message. If the log call includes a Throwable, the stacktrace is just appended to the message regardless of the pattern. | | `org.apache.sling.commons.log.names` | `String\[\]` | -- | A list of logger names to which this configuration applies. | | `org.apache.sling.commons.log.additiv` | `Boolean` | false | If set to false then logs from these loggers would not be sent to any appender attached higher in the hierarchy | http://git-wip-us.apache.org/repos/asf/sling-site/blob/1d7eb3f3/content/documentation/getting-started.md ---------------------------------------------------------------------- diff --git a/content/documentation/getting-started.md b/content/documentation/getting-started.md index e16f9ae..f859d76 100644 --- a/content/documentation/getting-started.md +++ b/content/documentation/getting-started.md @@ -16,8 +16,8 @@ We recommend you read through following topics to get as fast as possible into S * [Architecture](/documentation/the-sling-engine/architecture.html) * [Dispatching Requests](/documentation/the-sling-engine/dispatching-requests.html) * [Resources](/documentation/the-sling-engine/resources.html) -* [{{ refs.ide-tooling.headers.title }}](/documentation/development/ide-tooling.html) +* [Sling IDE Tooling](/documentation/development/ide-tooling.html) * [Manipulating Content - The SlingPostServlet (servlets.post)](/documentation/bundles/manipulating-content-the-slingpostservlet-servlets-post.html) * [Request Parameters](/documentation/the-sling-engine/request-parameters.html) * [Authentication](/documentation/the-sling-engine/authentication.html) -* [Eventing and Jobs]({{ refs.eventing-and-jobs.path }}) +* [Eventing and Jobs](/documentation/bundles/apache-sling-eventing-and-job-handling.html) http://git-wip-us.apache.org/repos/asf/sling-site/blob/1d7eb3f3/content/documentation/legacy/logging.md ---------------------------------------------------------------------- diff --git a/content/documentation/legacy/logging.md b/content/documentation/legacy/logging.md index b4d6468..99e0c1b 100644 --- a/content/documentation/legacy/logging.md +++ b/content/documentation/legacy/logging.md @@ -33,7 +33,7 @@ The `org.apache.sling.commons.log` bundle gets the initial configuration from th | `org.apache.sling.commons.log.file` | undefined | Sets the log file to which log messages are written. If this property is empty or missing, log messages are written to `System.out`. | | `org.apache.sling.commons.log.file.number` | 5 | The number of rotated files to keep. | | `org.apache.sling.commons.log.file.size` | '.'yyyy-MM-dd | Defines how the log file is rotated (by schedule or by size) and when to rotate. See the section *Log File Rotation* below for full details on log file rotation. | -| `org.apache.sling.commons.log.pattern` | \{0,date,dd.MM.yyyy HH:mm:ss.SSS\} \*\{4\}\* \[\{2\}\]({{ refs.-2.path }}) \{3\} \{5\} | The `MessageFormat` pattern to use for formatting log messages with the root logger. | +| `org.apache.sling.commons.log.pattern` | \{0,date,dd.MM.yyyy HH:mm:ss.SSS\} \*\{4\}\* \{2\} \{3\} \{5\} | The `MessageFormat` pattern to use for formatting log messages with the root logger. | | `org.apache.sling.commons.log.julenabled` | n/a | Enables the `java.util.logging` support. | @@ -52,7 +52,7 @@ The following properties may be set: |--|--|--|--| | `org.apache.sling.commons.log.level` | `String` | `INFO` | Sets the logging level of the loggers. This may be any of the defined logging levels `DEBUG`, `INFO`, `WARN`, `ERROR` and `FATAL`. | | `org.apache.sling.commons.log.file` | `String` | undefined | Sets the log file to which log messages are written. If this property is empty or missing, log messages are written to `System.out`. This property should refer to the file name of a configured Log Writer (see below). If no Log Writer is configured with the same file name an implicit Log Writer configuration with default configuration is created. | -| `org.apache.sling.commons.log.pattern` | `String` | \{0,date,dd.MM.yyyy HH:mm:ss.SSS\} \*\{4\}\* \[\{2\}\]({{ refs.-2.path }}) \{3\} \{5\} | The `java.util.MessageFormat` pattern to use for formatting log messages with the root logger. This is a `java.util.MessageFormat` pattern supporting up to six arguments: \{0\} The timestamp of type `java.util.Date`, \{1\} the log marker, \{2\} the name of the current thread, \{3\} the name of the logger, \{4\} the debug level and \{5\} the actual debug message. If the log call includes a Throwable, the stacktrace is just appended to the message regardless of the pattern. | +| `org.apache.sling.commons.log.pattern` | `String` | \{0,date,dd.MM.yyyy HH:mm:ss.SSS\} \*\{4\}\* \{2\} \{3\} \{5\} | The `java.util.MessageFormat` pattern to use for formatting log messages with the root logger. This is a `java.util.MessageFormat` pattern supporting up to six arguments: \{0\} The timestamp of type `java.util.Date`, \{1\} the log marker, \{2\} the name of the current thread, \{3\} the name of the logger, \{4\} the debug level and \{5\} the actual debug message. If the log call includes a Throwable, the stacktrace is just appended to the message regardless of the pattern. | | `org.apache.sling.commons.log.names` | `String\[\]` | -- | A list of logger names to which this configuration applies. | http://git-wip-us.apache.org/repos/asf/sling-site/blob/1d7eb3f3/content/documentation/the-sling-engine.md ---------------------------------------------------------------------- diff --git a/content/documentation/the-sling-engine.md b/content/documentation/the-sling-engine.md index 933937e..906c52b 100644 --- a/content/documentation/the-sling-engine.md +++ b/content/documentation/the-sling-engine.md @@ -7,7 +7,7 @@ status=published * [Architecture](/documentation/the-sling-engine/architecture.html) * [Authentication](/documentation/the-sling-engine/authentication.html) -* [{{ refs.service-authentication.headers.title }}](/documentation/the-sling-engine/service-authentication.html) +* [Service Authentication](/documentation/the-sling-engine/service-authentication.html) ## Request Handling @@ -30,4 +30,4 @@ status=published ## Misc * [Adapters](/documentation/the-sling-engine/adapters.html) -* [{{ refs.featureflags.headers.title }}](/documentation/the-sling-engine/featureflags.html) +* [Feature Flags](/documentation/the-sling-engine/featureflags.html) http://git-wip-us.apache.org/repos/asf/sling-site/blob/1d7eb3f3/content/documentation/the-sling-engine/architecture.md ---------------------------------------------------------------------- diff --git a/content/documentation/the-sling-engine/architecture.md b/content/documentation/the-sling-engine/architecture.md index d0cb977..71e1255 100644 --- a/content/documentation/the-sling-engine/architecture.md +++ b/content/documentation/the-sling-engine/architecture.md @@ -43,9 +43,6 @@ Based on the OSGi Framework specification, the Compendium Services specification The Sling API is an extension to the Servlet API which provides more functionality to interact with the Sling framework and also to extend Sling itself and to implement Sling applications. -See the [Sling API]({{ refs.sling-api.path }}) page for more information. - - ## Request Processing Traditional Web Application framework emply more or less elaborate methods to select a Servlet or Controller based on the request URL, which in turn tries to load some data (usually from a database) to act upon and finally to render the result somehow. @@ -77,7 +74,7 @@ Besides scripting languages, such as ECMAScript, Groovy, JSP, Sling also support As a result of mapping servlets into the resource tree and the possibility to adapt resource to an adaptor data type, scripts and servlets may be handled completely transparently: The servlet resolver just looks for a resource matching the resource type and adapts the resource found to `javax.jcr.Servlet`. If the resource happens to be provided by a servlet resource provider, the adapter is of course the servlet itself. If the resource happens to be a script, the adapter is a servlet facade which internally calls the script language implementation to evaluate the script. -See the [Servlet Resolution]({{ refs.servlet-resolution.path }}) page for more information. +See the [Servlet Resolution](/documentation/the-sling-engine/servlets.html) page for more information. http://git-wip-us.apache.org/repos/asf/sling-site/blob/1d7eb3f3/content/documentation/the-sling-engine/authentication.md ---------------------------------------------------------------------- diff --git a/content/documentation/the-sling-engine/authentication.md b/content/documentation/the-sling-engine/authentication.md index fb364da..ed07c4f 100644 --- a/content/documentation/the-sling-engine/authentication.md +++ b/content/documentation/the-sling-engine/authentication.md @@ -23,7 +23,7 @@ The important thing to note here is, that at the time the `handleSecurity` metho The following pages describe the full details of request authentication in Sling in full detail: -* [Tasks](/documentation/the-sling-engine/authentication/authentication-tasks.html): {{ refs.authentication-tasks.headers.excerpt }} -* [Actors](/documentation/the-sling-engine/authentication/authentication-actors.html): {{ refs.authentication-actors.headers.excerpt }} -* [Framework](/documentation/the-sling-engine/authentication/authentication-framework.html): {{ refs.authentication-framework.headers.excerpt }} -* [AuthenticationHandler](/documentation/the-sling-engine/authentication/authentication-authenticationhandler.html): {{ refs.authentication-authenticationhandler.headers.excerpt }} +* [Tasks](/documentation/the-sling-engine/authentication/authentication-tasks.html): Authentication tasks +* [Actors](/documentation/the-sling-engine/authentication/authentication-actors.html): Authentication actors and process +* [Framework](/documentation/the-sling-engine/authentication/authentication-framework.html): Authentication Framework, Auth Core bundle etc. +* [AuthenticationHandler](/documentation/the-sling-engine/authentication/authentication-authenticationhandler.html): Authentication Handler service API. http://git-wip-us.apache.org/repos/asf/sling-site/blob/1d7eb3f3/content/documentation/the-sling-engine/filters.md ---------------------------------------------------------------------- diff --git a/content/documentation/the-sling-engine/filters.md b/content/documentation/the-sling-engine/filters.md index 9dd9862..3521e29 100644 --- a/content/documentation/the-sling-engine/filters.md +++ b/content/documentation/the-sling-engine/filters.md @@ -18,8 +18,8 @@ For Sling to pick up a `javax.servlet.Filter` service for filter processing two | Property | Type | Default Value | Valid Values | Description | |--|--|--|--|--| -| `sling.filter.scope` | `String`, `String[]({{ refs..path }})` or `Vector<String>` | `request` | `REQUEST`, `INCLUDE`, `FORWARD`, `ERROR`, `COMPONENT` | Indication of which chain the filter should be added to. This property is required. If it is missing from the service, the service is ignored because it is assumed another consumer will be interested in using the service. Any unknown values of this property are also ignored causing the service to be completely ignored if none of the values provided by the property are valid. See below for the description of the filter chains. | -| `sling.filter.pattern` | `String`| `` | Any `String` value | Restrict the filter to paths that match the supplied regular expression. Requires Sling Engine 2.4.0. | +| `sling.filter.scope` | `String`, `String[]` or `Vector<String>` | `request` | `REQUEST`, `INCLUDE`, `FORWARD`, `ERROR`, `COMPONENT` | Indication of which chain the filter should be added to. This property is required. If it is missing from the service, the service is ignored because it is assumed another consumer will be interested in using the service. Any unknown values of this property are also ignored causing the service to be completely ignored if none of the values provided by the property are valid. See below for the description of the filter chains. | +| `sling.filter.pattern` | `String`| `(-)` | Any `String` value | Restrict the filter to paths that match the supplied regular expression. Requires Sling Engine 2.4.0. | | `service.ranking` | `Integer` | `0` | Any `Integer` value | Indication of where to place the filter in the filter chain. The higher the number the earlier in the filter chain. This value may span the whole range of integer values. Two filters with equal `service.ranking` property value (explicitly set or default value of zero) will be ordered according to their `service.id` service property as described in section 5.2.5, Service Properties, of the OSGi Core Specification R 4.2. | http://git-wip-us.apache.org/repos/asf/sling-site/blob/1d7eb3f3/content/documentation/the-sling-engine/mappings-for-resource-resolution.md ---------------------------------------------------------------------- diff --git a/content/documentation/the-sling-engine/mappings-for-resource-resolution.md b/content/documentation/the-sling-engine/mappings-for-resource-resolution.md index cddb7bb..5d96eed 100644 --- a/content/documentation/the-sling-engine/mappings-for-resource-resolution.md +++ b/content/documentation/the-sling-engine/mappings-for-resource-resolution.md @@ -11,7 +11,7 @@ status=published ### Properties The mapping of request URLs to resources is mainly configured in a configuration tree which is (by default) located below `/etc/map`. The actual location can be configured with the `resource.resolver.map.location` property of the `org.apache.sling.jcr.resource.internal.JcrResourceResolverFactoryImpl` configuration. -That way you can even make it [run mode specific](/documentation/bundles/sling-settings-org-apache-sling-settings.html) by having a unique path per [run mode specific OSGi configuration]({{ refs./jcr-installer-provider.path }}). +That way you can even make it run mode specific, by taking advantage of the Sling OSGi Installer's run mode awareness. When dealing with the new resource resolution we have a number of properties influencing the process: http://git-wip-us.apache.org/repos/asf/sling-site/blob/1d7eb3f3/content/documentation/the-sling-engine/request-parameters.md ---------------------------------------------------------------------- diff --git a/content/documentation/the-sling-engine/request-parameters.md b/content/documentation/the-sling-engine/request-parameters.md index 732bd3e..a02ffb4 100644 --- a/content/documentation/the-sling-engine/request-parameters.md +++ b/content/documentation/the-sling-engine/request-parameters.md @@ -13,7 +13,7 @@ The Servlet API specification provides the following methods to access the param | `HttpServletRequest.getQueryString()` | Returns the query part of the request URL | | `ServletRequest.getParameter(String)` | Returns the (first) named parameter | | `ServletRequest.getParameterValues(String)` | Returns all parameters of that name | -| `ServletRequest.getParameterMap()` | Returns all parameters as a map of `String[]({{ refs..path }})` | +| `ServletRequest.getParameterMap()` | Returns all parameters as a map of `String[]` | | `ServletRequest.getParameterNames()` | Returns an enumeration of the names of the parameters | | `ServletRequest.getParts()` | Returns all parts of the multipart request (since v3.0) | | `ServletRequest.getPart(String)` | Returns the request part with that name in case of multipart requests (since v3.0) | @@ -75,7 +75,7 @@ The first rule is essential as it helps decoding the form input correctly. The s When Sling is now receiving a request and is asked for the parameters, the parameters are parsed in two phases: The first phase just parses the raw input data using an identity transformation of bytes to characters. This identity transformation happens to generate strings as the original data was generated with `ISO-8859-1` encoding. The second phase locates the `_charset_` parameter and fixes the character encodings of the parameters as follows: * All names of the parameters are re-encoded - * The parameter values are re-encoded, unless the parameter value is an uploaded file. Actually the parameter (not the files of course) are internally as `byte[]({{ refs..path }})` where the conversion to a string is done on the fly (and yes, the conversion using the `_charset_` character encoding is of course cached for performance reasons) + * The parameter values are re-encoded, unless the parameter value is an uploaded file. Actually the parameter (not the files of course) are internally as `byte[]` where the conversion to a string is done on the fly (and yes, the conversion using the `_charset_` character encoding is of course cached for performance reasons) * If the parameter is an uploaded file, the file name is re-encoded on the fly when accessed <div class="info"> http://git-wip-us.apache.org/repos/asf/sling-site/blob/1d7eb3f3/content/documentation/the-sling-engine/resources.md ---------------------------------------------------------------------- diff --git a/content/documentation/the-sling-engine/resources.md b/content/documentation/the-sling-engine/resources.md index d538809..195c20b 100644 --- a/content/documentation/the-sling-engine/resources.md +++ b/content/documentation/the-sling-engine/resources.md @@ -59,7 +59,7 @@ As has been said, the absolute path mapping methods `resolve(HttpServletRequest, The general algorithm of the two methods is as follows: -1. Call `HttpServletRequest.getScheme(), .getServerName(), getServerPort` to get an absolute path out of the request URL: \[scheme\]({{ refs.scheme.path }})/\[host\].\[port\]\[path\] (`resolve(HttpServletRequest, String)` method only, which) +1. Call `HttpServletRequest.getScheme(), .getServerName(), getServerPort` to get an absolute path out of the request URL: \[scheme\]/\[host\].\[port\]\[path\] (`resolve(HttpServletRequest, String)` method only, which) 1. Check whether any virtual path matches the absolute path. If such a match exists, the next step is entered with the match. 1. Apply a list of mappings in order to create a mapped path. The first mapped path resolving to a Resource is assumed success and the Resource found is returned. 1. If no mapping created a mapped path addressing an existing Resource, the method fails and returns a `NonExistingResource` (for the http://git-wip-us.apache.org/repos/asf/sling-site/blob/1d7eb3f3/content/documentation/the-sling-engine/service-authentication.md ---------------------------------------------------------------------- diff --git a/content/documentation/the-sling-engine/service-authentication.md b/content/documentation/the-sling-engine/service-authentication.md index 06b6f53..6cfb80f 100644 --- a/content/documentation/the-sling-engine/service-authentication.md +++ b/content/documentation/the-sling-engine/service-authentication.md @@ -12,7 +12,7 @@ To access the data storage in the Resource Tree and/or the JCR Repository authentication is required to properly setup access control and guard sensitive data from unauthorized access. For regular request processing this authentication step is handled by the Sling -[{{ refs.authentication.headers.title }}](/documentation/the-sling-engine/authentication.html) +[Authentication](/documentation/the-sling-engine/authentication.html) subsystem. On the other hand there are also some background tasks to be executed http://git-wip-us.apache.org/repos/asf/sling-site/blob/1d7eb3f3/content/documentation/tutorials-how-tos/how-to-manage-events-in-sling.md ---------------------------------------------------------------------- diff --git a/content/documentation/tutorials-how-tos/how-to-manage-events-in-sling.md b/content/documentation/tutorials-how-tos/how-to-manage-events-in-sling.md index d827df4..ea1ae57 100644 --- a/content/documentation/tutorials-how-tos/how-to-manage-events-in-sling.md +++ b/content/documentation/tutorials-how-tos/how-to-manage-events-in-sling.md @@ -1,4 +1,4 @@ -title=How to Manage Job in Sling +title=How to Manage Jobs in Sling type=page status=published ~~~~~~ @@ -7,7 +7,7 @@ Apache Sling supports the execution of jobs with the guarantee of processing the For more details please refer to the following resources: -* [Eventing, Jobs and Scheduling section]({{ refs.eventing-and-jobs.path }}) to get detailed information on the eventing mechanisms in Sling. +* [Eventing and Job Handling](/documentation/bundles/apache-sling-eventing-and-job-handling.html) to get detailed information on the eventing mechanisms in Sling. * Package [org.osgi.service.event](http://www.osgi.org/javadoc/r4v42/org/osgi/service/event/package-summary.html) of the OSGI API. * Package [org.apache.sling.event](/apidocs/sling6/org/apache/sling/event/package-summary.html) of the Sling API. http://git-wip-us.apache.org/repos/asf/sling-site/blob/1d7eb3f3/content/guides.md ---------------------------------------------------------------------- diff --git a/content/guides.md b/content/guides.md index 6aeda8a..63094c3 100644 --- a/content/guides.md +++ b/content/guides.md @@ -1,23 +1,5 @@ -title=Guides +title=Guides (retired) type=page status=published ~~~~~~ -translation_pending: true - -These pages contain further information in a more informal way. - - * [Discover Sling in 15 minutes ](/documentation/getting-started/discover-sling-in-15-minutes.html) - title says it all - - * [Resources](/documentation/the-sling-engine/resources.html) -- Presents the Resource as the object around which Sling is built - * [Servlet Resolution]({{ refs.servlet-resolution.path }}) -- How Sling resolves the servlet or script responsible for rendering a Resource. - * [Request Parameters](/documentation/the-sling-engine/request-parameters.html) -- Explains how Sling provides request parameters to servlets, scripts and filters. - * [Repository Based Development](/documentation/development/repository-based-development.html) -- Shows how WebDAV is supported by Sling. - - * [Bundle Management](/documentation/tutorials-how-tos/installing-and-upgrading-bundles.html) -- Explains how to install, upgrade and uninstall Bundles using the Sling Management console. - - -These pages refer to the old Component API and launcher, and remain referred to here until more up to date documentation has been prepared: - - * [Getting and Building Sling](/documentation/development/getting-and-building-sling.html) -- A short recount on the first step for getting a running Sling instance after checking out the source from the SVN repository - * [Default Mapping and Rendering](/documentation/the-sling-engine/default-mapping-and-rendering.html) -- Explains default mapping of repository nodes to Content instances and selection of a default Component. - * [Dispatching Requests](/documentation/the-sling-engine/dispatching-requests.html) -- Explains how a Component may dispatch requests to include further content renderings in the response to the client's request +This page used to contain a list of mostly obsolete links, it has been retired in June 2017. \ No newline at end of file
