fix links

enonic · Mar 27, 2024 · b087ccb · b087ccb
1 parent 266d5fb
commit b087ccb
Show file tree

Hide file tree

Showing 42 changed files with 111 additions and 110 deletions.
diff --git a/docs/admin.adoc b/docs/admin.adoc
@@ -25,7 +25,7 @@ Two of them are system applications that are installed on all installations:
 
 NOTE: If you are used to working in the Content Studio, you will miss it in a clean installation, as it has now been pulled out from the core
 and must be installed from Market in the Applications app.  The Content Studio documentation may be found here:
-link:https://developer.enonic.com/docs/content-studio[Content Studio Doc]
+https://developer.enonic.com/docs/content-studio[Content Studio Doc]
 
 == Languages
 

diff --git a/docs/admin/widgets.adoc b/docs/admin/widgets.adoc
@@ -67,7 +67,7 @@ NOTE: Widget icon will not be used for Dashboard widgets, only for Content Studi
 Widget interface is simply a unique identifier (or widget type, if you will) that links the widget to its extension point (i.e. Dashboard or Content Studio's context panel). XP currently supports one type of widgets: Dashboard Widgets (interface `admin.dashboard`).
 
 TIP: Content Studio supports other types of widgets that will be embedded inside the Content Studio UI.
-Read more about Content Studio widgets link:https://developer.enonic.com/docs/content-studio/stable/widgets[here]
+Read more about Content Studio widgets https://developer.enonic.com/docs/content-studio/stable/widgets[here]
 
 === Dashboard Widgets
 

diff --git a/docs/api.adoc b/docs/api.adoc
@@ -9,7 +9,7 @@ This section offers detailed documentation on our APIs.
 
 Enonic XP provides multiple APIs, from web endpoints, via Core Javascript libraries to the Java API.
 
-TIP: Looking for our *Headless CMS GraphQL API?* To give it a quick spin, link:https://www.enonic.com/sign-up[sign up for a Free Plan] or visit the https://developer.enonic.com/start[Developer quickstart].
+TIP: Looking for our *Headless CMS GraphQL API?* To give it a quick spin, https://www.enonic.com/sign-up[sign up for a Free Plan] or visit the https://developer.enonic.com/start[Developer quickstart].
 
 == Endpoints
 
@@ -19,14 +19,14 @@ The <<runtime#, XP Runtime>> provides access to various <<runtime/engines#, Engi
 
 XP ships with a large number of build in JavaScript libraries that can be accessed when <<development#, developing Enonic apps>>. These are listed below this page in the documentation menu.
 
-Alternatively browse our link:https://developer.enonic.com/jsdoc[JSDocs].
+Alternatively browse our https://developer.enonic.com/jsdoc[JSDocs].
 
 
 == TypeScript definitions
 
 === Install
 
-To add types for corresponding library use NPM (or similar package manager) and install them as any other dependency. All types can be found under link:https://www.npmjs.com/org/enonic-types[@enonic-types] organisation on NPM.
+To add types for corresponding library use NPM (or similar package manager) and install them as any other dependency. All types can be found under https://www.npmjs.com/org/enonic-types[@enonic-types] organisation on NPM.
 
 === Libraries
 
@@ -84,7 +84,7 @@ import type {Content} from '@enonic-types/core';
 
 `Content` contains the `x` property that has a very special `XpXData` type.
 
-`XpXData` is an interface that is added to the global scope, so it can be modified using the link:https://www.typescriptlang.org/docs/handbook/declaration-merging.html#merging-interfaces[declaration merging]. This allows you to set the shape of the XData in your project, simply by declaring the `XpXData` like this:
+`XpXData` is an interface that is added to the global scope, so it can be modified using the https://www.typescriptlang.org/docs/handbook/declaration-merging.html#merging-interfaces[declaration merging]. This allows you to set the shape of the XData in your project, simply by declaring the `XpXData` like this:
 
 ```ts
 declare global {
@@ -203,4 +203,4 @@ const helper = __.newBean('com.me.project.SomeHelper');
 
 == JavaDoc
 
-Java developers or anyone interested in the Platform core may check out our JavaDoc (link:https://repo.enonic.com/public/com/enonic/xp/docs/{version}/docs-{version}-javadoc.zip[zipfile download]).
+Java developers or anyone interested in the Platform core may check out our JavaDoc (https://repo.enonic.com/public/com/enonic/xp/docs/{version}/docs-{version}-javadoc.zip[zipfile download]).
diff --git a/docs/api/lib-portal.adoc b/docs/api/lib-portal.adoc
@@ -742,6 +742,7 @@ var url = portalLib.pageUrl({
 ```
 
 === processHtml
+[#processHtml]
 
 This function replaces abstract internal links to images and internal content items contained in an HTML text with full URLs.
 It will also render embedded macros.

diff --git a/docs/api/lib-project.adoc b/docs/api/lib-project.adoc
@@ -32,7 +32,7 @@ const projectLib = require('/lib/xp/project');
 Adds permissions to an existing Content Project.
 To modify permissions, user must have `Owner` permissions for the project, or either `system.admin` or `cms.admin` role.
 
-TIP: You can read about project permissions in the dedicated link:https://developer.enonic.com/docs/content-studio/stable/projects#roles[Content Projects] section
+TIP: You can read about project permissions in the dedicated https://developer.enonic.com/docs/content-studio/stable/projects#roles[Content Projects] section
 
 [.lead]
 Parameters

diff --git a/docs/apps.adoc b/docs/apps.adoc
@@ -18,7 +18,7 @@ Fundamentally, most of XP's core software components are built like applications
 
 == Enonic Market
 
-link:https://market.enonic.com[Enonic market] is the go-to place for official apps from Enonic, as well as 3rd party applications.
+https://market.enonic.com[Enonic market] is the go-to place for official apps from Enonic, as well as 3rd party applications.
 The marketplace also offers starter kits and software libraries that help you create new apps better and faster.
 
 == Installation
@@ -58,9 +58,9 @@ You may build applications that go from serving content via a standard GraphQL A
 
 The CMS offering essentially consist of three parts:
 
-* Content Studio - Editorial admin interface, available as an app on link:https://market.enonic.com/vendors/enonic/content-studio[Enonic Market]
+* Content Studio - Editorial admin interface, available as an app on https://market.enonic.com/vendors/enonic/content-studio[Enonic Market]
 * Content API - Low level API built on top of the NoSQL Storage
-* GraphQL API - The built on top of the Content API, available on link:https://market.enonic.com/vendors/enonic/guillotine[Enonic Market]
+* GraphQL API - The built on top of the Content API, available on https://market.enonic.com/vendors/enonic/guillotine[Enonic Market]
 * Site Engine - Content driven rendering engine, based on the HTTP engine
 
 Learn more about the <<cms#,Content Management System>> and the <<runtime/engines/site-engine#, site engine>>.

diff --git a/docs/cms.adoc b/docs/cms.adoc
@@ -11,8 +11,8 @@ The full range of CMS capabilities are made available through individual, but ti
 
 * <<api/lib-content#, Content API>> - Included in the XP core, built on top of the NoSQL Storage
 * <<runtime/engines/site-engine#,Site Engine>> - Included in the XP core, built on top of the Javascript Framework og web app Engine.
-* link:https://developer.enonic.com/docs/content-studio[Content Studio] - Authoring interface available on Enonic Market.
-* link:https://developer.enonic.com/docs/intro[Headless GraphQL API] - Available as both application and library.
+* https://developer.enonic.com/docs/content-studio[Content Studio] - Authoring interface available on Enonic Market.
+* https://developer.enonic.com/docs/intro[Headless GraphQL API] - Available as both application and library.
 
 == Content Types
 

diff --git a/docs/cms/page-templates.adoc b/docs/cms/page-templates.adoc
@@ -29,4 +29,4 @@ Page template rendering is built-in functionality when using the <<../framework/
 
 If you are using a 3rd party front-end, you will have to ensure the same logic is also applied there.
 
-TIP: Also, check out our link:https://developer.enonic.com/docs/next.xp[Next.js integration], where page templates are supported out-of-the-box.
+TIP: Also, check out our https://developer.enonic.com/docs/next.xp[Next.js integration], where page templates are supported out-of-the-box.
diff --git a/docs/cms/schemas.adoc b/docs/cms/schemas.adoc
@@ -15,7 +15,7 @@ Each schema will produce a deterministic set of properties with valid values and
 [#forms]
 == Forms
 
-First and foremost, schemas define forms that can be edited through an administrative interface, typically link:https://developer.enonic.com/docs/content-studio[Content Studio].
+First and foremost, schemas define forms that can be edited through an administrative interface, typically https://developer.enonic.com/docs/content-studio[Content Studio].
 
 In addition to the user interface, schemas also have a back-end equivalent that can be used programmatically, for instance through the content API.
 

diff --git a/docs/cms/schemas/input-types/contentselector.adoc b/docs/cms/schemas/input-types/contentselector.adoc
@@ -71,7 +71,7 @@ XP's patterns have a few cases where they differ from normal Java Regular Expres
 Most content type names start with the name of the application where they are stored. It may be quite messy and hard to maintain the whole application name in every pattern, so the `${app}` template expression can be used to replace it.
 
 .The '*' character
-In most regex engines, the `*` character means "0 or more of the preceding token". However, XP treats it differently and interprets it as "0 or more of any character(s) except for line breaks". In that way, it's similar to link:https://en.wikipedia.org/wiki/Glob_%28programming%29[glob patterns].
+In most regex engines, the `*` character means "0 or more of the preceding token". However, XP treats it differently and interprets it as "0 or more of any character(s) except for line breaks". In that way, it's similar to https://en.wikipedia.org/wiki/Glob_%28programming%29[glob patterns].
 
 To further clarify, in XP:
 

diff --git a/docs/cms/schemas/input-types/customselector.adoc b/docs/cms/schemas/input-types/customselector.adoc
@@ -8,7 +8,7 @@
 Selector with customizable data source. Useful for live integrations with external data sources.
 
 
-TIP: Tutorial: Check out link:https://developer.enonic.com/docs/build-a-custom-selector[Building a custom selector] for hands on learning.
+TIP: Tutorial: Check out https://developer.enonic.com/docs/build-a-custom-selector[Building a custom selector] for hands on learning.
 
 == Usage
 

diff --git a/docs/cms/schemas/input-types/htmlarea.adoc b/docs/cms/schemas/input-types/htmlarea.adoc
@@ -9,7 +9,7 @@ A field for entering multi-line text with rich-formatting options.
 
 == Appearance
 
-The rich text editor as seen with default configuration. The `Add` button indicated that this setup also supports multiple occurences of the editor.
+The rich text editor as seen with default configuration. The `Add` button indicated that this setup also supports multiple occurrences of the editor.
 
 image::Html-area-editor.png[Input field with a toolbar at the top. Source and fullscreen buttons on the bottom left, 600]
 
@@ -36,7 +36,7 @@ image::Html-area-editor.png[Input field with a toolbar at the top. Source and fu
 
 
 TIP: If you are manually outputting contents of an HtmlArea input in your template, you might have to use
-<<../../../api/lib-portal#processhtml,processHtml()>> function which will process macros and generate correct links inside the HTML content.
+<<../../../api/lib-portal#processHtml,processHtml()>> function which will process macros and generate correct links inside the HTML content.
 
 TIP: HTML Area is configured with default set of tools but the toolbar can be customized. Using the config setting you can exclude specific tools from being shown (use "*" to exclude all tools at once) and/or include those that you want to have in the toolbar. Separate tools with a space and use "|" character to group tool buttons together. Complete list of supported tools can be found below.
 
@@ -52,7 +52,7 @@ Below is the complete list of available editor tools:
 
 | Format | Text format menu
 | Bold | Bold text
-| Italic | Italic text
+| Italic | Italic text
 | Underline | Underline text
 | JustifyBlock | Justify content
 | JustifyLeft | Left align content

diff --git a/docs/cms/schemas/input-types/radiobutton.adoc b/docs/cms/schemas/input-types/radiobutton.adoc
@@ -26,7 +26,7 @@ image::Radio-buttons.png[two button where one of them is selected, 200]
   <default>one</default>  // <3>
 </input>
 ----
-<1> *occurences* only make supports minumum=1 or 0 - maximum will always be 1.
+<1> *occurrences* only make supports minimum=1 or 0 - maximum will always be 1.
 <2> *option* elements and the `@value` attribute defines the actual value to store when the option is selected.
 Multiple ``option`` elements are allowed and ordered. Optional `i18n` attribute can be used to localise the option label.
 <3> *default* is optional, and may be equal to one of the option values.

diff --git a/docs/cms/schemas/input-types/textline.adoc b/docs/cms/schemas/input-types/textline.adoc
@@ -39,7 +39,7 @@ image::TextLine.png[Text Line with various settings, 700]
 <3> *show-counter* specifies whether text length counter should be shown (default: hidden)
 <4> *regexp* supports validation by defining regular expressions
 +
-NOTE: Regex validation is performed by the browser's link:https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/RegExp/test[regex testing function]. Visit https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Regular_Expressions#writing_a_regular_expression_pattern[MDN's documentation on regexes] for more information on the supported expressions and character classes.
+NOTE: Regex validation is performed by the browser's https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/RegExp/test[regex testing function]. Visit https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Regular_Expressions#writing_a_regular_expression_pattern[MDN's documentation on regexes] for more information on the supported expressions and character classes.
 
 [#spellcheck]
 == Spell checking

diff --git a/docs/cms/sites.adoc b/docs/cms/sites.adoc
@@ -4,7 +4,7 @@
 
 Sites add support for building building pages, in addition to form-based content.
 
-NOTE: For a hands on introduction to sites and the concepts described here, visit the link:https://developer.enonic.com/docs/my-first-site[My first site tutorial].
+NOTE: For a hands on introduction to sites and the concepts described here, visit the https://developer.enonic.com/docs/my-first-site[My first site tutorial].
 
 == Introduction
 

diff --git a/docs/cms/styles.adoc b/docs/cms/styles.adoc
@@ -7,7 +7,7 @@ XP supports definition of custom styles for use in rich text content.
 == Introduction
 
 Styles are used to add effects and styling to elements of the
-link:https://developer.enonic.com/docs/content-studio/stable/editor/rich-text-editor#custom_image_styles[Rich Text Editor].
+https://developer.enonic.com/docs/content-studio/stable/editor/rich-text-editor#custom_image_styles[Rich Text Editor].
 
 Custom styles typically map to a CSS class for client-side styling. Image styles additionally support instructions for the image service, enabling image crops and filters to be applied server-side.
 

diff --git a/docs/deployment/backup-restore.adoc b/docs/deployment/backup-restore.adoc
@@ -40,9 +40,9 @@ Enonic XP offers both <<../runtime/management#, management endpoints>>, and inte
 
 As an alternative to working with the APIs. Check out the following tools:
 
-* link:https://developer.enonic.com/docs/enonic-cli[Enonic CLI] - Enonic's command line interface
-* link:https://market.enonic.com/vendors/glenn-ricaud/data-toolbox[Data toolbox] - Admin app
-* link:https://market.enonic.com/vendors/enonic/snapshotter[Snapshotter] - Continuously snapshots your systems
+* https://developer.enonic.com/docs/enonic-cli[Enonic CLI] - Enonic's command line interface
+* https://market.enonic.com/vendors/glenn-ricaud/data-toolbox[Data toolbox] - Admin app
+* https://market.enonic.com/vendors/enonic/snapshotter[Snapshotter] - Continuously snapshots your systems
 
 [#snapshot-restore]
 == Snapshot - restore

diff --git a/docs/deployment/clustering.adoc b/docs/deployment/clustering.adoc
@@ -54,7 +54,7 @@ A combined node running XP should minimum have 4GB of memory and 2vCPU. A genera
 
 Master nodes can be configured with less memory and capacity as they are generally not processing requests or queries.
 
-Since Elasticsearch is embedded in XP, be sure also to setup virtual memory, file descriptors and swap setting correctly for __elasticsearch__. Read more about that in the link:https://www.elastic.co/guide/en/elasticsearch/reference/2.4/setup-configuration.html[elasticsearch documentation].
+Since Elasticsearch is embedded in XP, be sure also to setup virtual memory, file descriptors and swap setting correctly for __elasticsearch__. Read more about that in the https://www.elastic.co/guide/en/elasticsearch/reference/2.4/setup-configuration.html[elasticsearch documentation].
 
 == XP node setup
 
@@ -152,13 +152,13 @@ NOTE: If you decide to change location of `$XP_HOME/snapshots` from default you
 
 === Pre-installed apps
 
-You can pre-install apps in XP by placing the jars of those apps to `$XP_HOME/deploy`. We recommend placing the link:https://market.enonic.com/vendors/enonic/snapshotter[snapshotter app] there to enable automatic snapshots.
+You can pre-install apps in XP by placing the jars of those apps to `$XP_HOME/deploy`. We recommend placing the https://market.enonic.com/vendors/enonic/snapshotter[snapshotter app] there to enable automatic snapshots.
 
 NOTE: The pre-installed apps can be placed on distinct nodes, but for instance in the case of the snapshotter app, it should simply be placed on all nodes.
 
 === Shard replication
 
-Once your cluster has started you will have to set the number of shard replicas you want the data nodes to store. In this case we have 2 data nodes, so we want 2 copies of each shard in the cluster (1 per data node). To do that we should set the number of replicas to 1. Setting that number to 1 means that the cluster will have 1 primary shard, and 1 replica shard, totalling 2 copies. We can do this with the link:https://developer.enonic.com/docs/enonic-cli[Enonic CLI]:
+Once your cluster has started you will have to set the number of shard replicas you want the data nodes to store. In this case we have 2 data nodes, so we want 2 copies of each shard in the cluster (1 per data node). To do that we should set the number of replicas to 1. Setting that number to 1 means that the cluster will have 1 primary shard, and 1 replica shard, totalling 2 copies. We can do this with the https://developer.enonic.com/docs/enonic-cli[Enonic CLI]:
 
 [source,bash]
 ----
@@ -186,7 +186,7 @@ When running XP in a cluster, we generally recommend using sticky sessions. Stic
 . Any kind of node-local file handling will ONLY work across requests if the request is handled by the same node.
 . Performance is generally better and more consistent for users
 
-For session-based logins, XP now supports link:https://developer.enonic.com/docs/xp/stable/deployment/config#sessionstore[session replication] between nodes. This effectively prevents users from loosing their session, even when a node is stopped, but this does not mitigate the problems mentioned above.
+For session-based logins, XP now supports https://developer.enonic.com/docs/xp/stable/deployment/config#sessionstore[session replication] between nodes. This effectively prevents users from loosing their session, even when a node is stopped, but this does not mitigate the problems mentioned above.
 
 
 == Backup and restore