Skip to content

Commit

Permalink
fixing links after refactoring xp docs
Browse files Browse the repository at this point in the history
  • Loading branch information
sigdestad committed Nov 21, 2023
1 parent 80eb326 commit 192780d
Show file tree
Hide file tree
Showing 8 changed files with 25 additions and 25 deletions.
2 changes: 1 addition & 1 deletion docs/content-studio.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ include::.variables.adoc[]

In this {document}, we'll give a short introduction to Content Studio, an app that serves as the main content management interface for XP, providing editors an efficient way of creating, and curating content without technical skills.

For a more comprehensive overview, watch https://www.youtube.com/watch?v=tR9KHOcZOs0[this short video on Content Studio basics] or head to the https://developer.enonic.com/docs/content-studio/stable[Content Studio reference documentation].
For a more comprehensive overview, watch https://www.youtube.com/watch?v=tR9KHOcZOs0[this short video on Content Studio basics] or head to the https://developer.enonic.com/docs/content-studio[Content Studio reference documentation].

NOTE: {see-prev-docs}

Expand Down
12 changes: 7 additions & 5 deletions docs/deployment.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -110,7 +110,7 @@ Enonic XP is compatibile with just about any public cloud out there. There's a n

Setting up the entire platform is beyond the scope of this tutorial. As such, we'll focus on the steps required for getting your app live - assuming you already have the platform running.

For more details on deplying the platform, check out https://developer.enonic.com/docs/xp/stable/deployment/strategies[the Deployment section of the XP reference docs].
For more details on deplying the platform, check out https://developer.enonic.com/docs/xp/stable/deployment[the Deployment section of the XP reference docs].

=== Installing the app

Expand Down Expand Up @@ -230,7 +230,9 @@ You might not be able to do much with that output, but it means the mapping has

Congrats! You've reached the end of this introduction. If you'd like to go further now, try one of the following guides which introduce additional aspects of the Enonic experience?

https://developer.enonic.com/docs/headless-cms-intro[Introduction to headless CMS]:: If you've enjoyed the headless aspects of this introduction, why not visit this guide to further your knowledge of how to use the GraphQL API and how to customize it.
https://developer.enonic.com/docs/next.xp[Building sites with Enonic and Next.js]:: Everything you need to start building Next.js-based sites with Enonic as your CMS. This integration allow editors to enjoy full WYSIWYG editing
https://developer.enonic.com/guides/my-first-site[My first site]:: If you're interested in building a traditional CMS-based application with server rendered pages in Enonic (no 3rd party framework required), this is the guide for you. It covers building pages and using building blocks such as regions, parts, and page templates.
https://developer.enonic.com/guides/my-first-webapp[My first webapp]:: Build webapps and APIs directly in Enonic. Focuses on JavaScript controllers, serving assets, and routing.

https://developer.enonic.com/guides/my-first-site[My first site]:: Building a website with the Enonic Framework (no 3rd party framework required). This tutorial also introduces the concept of pages, and building blocks such as regions, parts, and page templates.

https://developer.enonic.com/docs/next.xp[Building sites with Enonic and Next.js]:: Everything you need to start building Next.js-based sites with Enonic as your CMS - including full WYSIWYG editing. This tutorial also introduces the concept of pages, and building blocks such as regions, parts, and page templates.

https://developer.enonic.com/guides/my-first-webapp[My first webapp]:: Build and service webapps directly using the Enonic framework. Focuses on JavaScript controllers, serving assets, and basic routing.
2 changes: 1 addition & 1 deletion docs/headless-api.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -490,6 +490,6 @@ Which shows that two of those artists are from Generation X, and one of them is

== Dive deeper

- For more query examples and information about how to get up and running with Guillotine, you can check out https://developer.enonic.com/docs/headless-cms-intro[the headless CMS intro guide] or the https://developer.enonic.com/docs/guillotine[Guillotine docs]
- For more query examples and information about how to get up and running with Guillotine, you can check out https://developer.enonic.com/docs/intro[Quick introduction guide] or the https://developer.enonic.com/docs/guillotine[Guillotine docs]
- If you want to understand how to extend available schemas on the GraphQL Api, you can head to https://developer.enonic.com/docs/guillotine/stable/embed/extending[Extending section on Guillotine docs] or check some examples on this https://developer.enonic.com/docs/build-a-custom-selector#customizing_with_guilliotine_lib_optional[guide]
- If you want to learn more about GraphQL in general, the https://graphql.org/learn/[_Introduction to GraphQL_ documentation] is a good place to start
16 changes: 8 additions & 8 deletions docs/input-types.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ All input types share a number of options that affect how they act. These option
+
The `config` element is for input-specific configuration. Because the input types are so different to each other, they all support different options. The `config` element allows us to use regex validation for TextLine inputs, configure formatting options for HtmlAreas, and to dictate what numeric values a Long or a Double input accepts.

NOTE: All of the shared configuration options (`label`, `occurrences`, etc.) are described in more detail in the https://developer.enonic.com/docs/xp/stable/cms/schemas#input_types[input types schema documentation]. Additionally, all input types and their respective `config` options are listed in the https://developer.enonic.com/docs/xp/stable/cms/input-types[the input types documentation].
NOTE: All of the shared configuration options (`label`, `occurrences`, etc.), and the list of available input types are described in the https://developer.enonic.com/docs/xp/stable/cms/schemas/input-types[input types documentation].

To show an example of the configuration options work, let's examine some TextLine inputs with different configurations.

Expand Down Expand Up @@ -99,24 +99,24 @@ TIP: If `maximum` is greater than `0`, make sure that `minimum` is less than or

== Common inputs

Apart from the input types we've already gotten familiar with, XP also has input types created for other kinds of data. You can always find the full list over https://developer.enonic.com/docs/xp/stable/cms/input-types[at the input types reference docs], but some useful and common ones are:
Apart from the input types we've already gotten familiar with, XP also has input types created for other kinds of data. You can always find the full list over https://developer.enonic.com/docs/xp/stable/cms/schemas/input-types[at the input types reference docs], but some useful and common ones are:

https://developer.enonic.com/docs/xp/stable/cms/input-types#combobox[ComboBox]:: A dropdown menu containing predefined options for the user to select from. Allows selection of one or more options.
https://developer.enonic.com/docs/xp/stable/cms/schemas/input-types/combobox[ComboBox]:: A dropdown menu containing predefined options for the user to select from. Allows selection of one or more options.
+
.The ComboBox input type
image::input-type-combo-box.webp["A standard select list / dropdown list / combo box input type with a few visible dummy options.", {image-s}, align=center]
+
https://developer.enonic.com/docs/xp/stable/cms/input-types#date[Date] and https://developer.enonic.com/docs/xp/stable/cms/input-types#datetime[DateTime]:: Provides an interactive date picker (with a time component in DateTime's case) to save date and times.
https://developer.enonic.com/docs/xp/stable/cms/input-types#date[Date] and https://developer.enonic.com/docs/xp/stable/cms/schemas/input-types/datetime[DateTime]:: Provides an interactive date picker (with a time component in DateTime's case) to save date and times.
+
.The DateTime input type
image::input-type-date-time.webp["A calendar showing year and month with a time indicator to the side.", {image-s}, align=center]
+
https://developer.enonic.com/docs/xp/stable/cms/input-types#geopoint[GeoPoint]:: Stores GPS coordinates.
https://developer.enonic.com/docs/xp/stable/cms/schemas/input-types/geopoint[GeoPoint]:: Stores GPS coordinates.
+
.The GeoPoint input type
image::input-type-geo-point.webp["A text line input with coordinates.", {image-s}, align=center]
+
https://developer.enonic.com/docs/xp/stable/cms/input-types#htmlarea[HtmlArea]:: Provides a rich text, multi-line input. We'll discuss this in detail in xref:rich-text#[the next {document}].
https://developer.enonic.com/docs/xp/stable/cms/schemas/input-types/htmlarea[HtmlArea]:: Provides a rich text, multi-line input. We'll discuss this in detail in xref:rich-text#[the next {document}].
+
.The HtmlArea input type
image::input-type-html-area.png["A text area with a tools ribbon on the top. The ribbon provides rich text tools such as justification, macro insertion, text styles, etc.", {image-s}, align=center]
Expand All @@ -140,7 +140,7 @@ XP's image selector allows you to select an image for a piece of content and als
</input>
----

Read more about the https://developer.enonic.com/docs/xp/stable/cms/input-types#imageselector[configuration of image selectors] in the reference docs.
Read more about the https://developer.enonic.com/docs/xp/stable/cms/schemas/input-types/imageselector[configuration of image selectors] in the reference docs.

After you've added an image (or several), you can highlight it and click the edit button. This will take you to the image editing form. This is the same form as we saw in xref:media-and-images#_editing_images[the previous {document}].

Expand All @@ -158,7 +158,7 @@ The ContentSelector input type allows you to reference other content. Let's say

Because referencing other content types comes with a lot of variability, the ContentSelector type has configuration options to support this. You can choose to allow only certain content types or only content that's available at a certain path. You can also change whether the selector should show content in a tree-style hierarchy or as a flat list of content.

https://developer.enonic.com/docs/xp/stable/cms/input-types#contentselector[The full list of ContentSelector configuration options] is available in the reference docs, including a number of examples to explain content inclusion and exclusion. However, a simple configuration could look like this:
https://developer.enonic.com/docs/xp/stable/cms/schemas/input-types/contentselector[The full list of ContentSelector configuration options] is available in the reference docs, including a number of examples to explain content inclusion and exclusion. However, a simple configuration could look like this:

.A basic ContentSelector configuration that only allows one specific content type
[source, xml]
Expand Down
4 changes: 2 additions & 2 deletions docs/medias-and-attachments.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -125,9 +125,9 @@ image::image-cropped-focused.jpg["A crop of the lion in the savannah. In this sq

== Attachments

XP has an input type named https://developer.enonic.com/docs/xp/stable/cms/input-types#attachmentuploader[AttachmentUploader] that enables uploading of one or more files that will be stored as attachments to the current content.
XP has an input type named https://developer.enonic.com/docs/xp/stable/cms/schemas/input-types/attachmentuploader[AttachmentUploader] that enables uploading of one or more files that will be stored as attachments to the current content.

This differs from the previously presented media content, which is a separate content itself that can be linked on other content types, for example, by using the https://developer.enonic.com/docs/xp/stable/cms/input-types#imageselector[ImageSelector] input type.
This differs from the previously presented media content, which is a separate content itself that can be linked on other content types, for example, by using the https://developer.enonic.com/docs/xp/stable/cms/schemas/input-types/imageselector[ImageSelector] input type.

To take a look on how attachments work, let's update the Artist content type to use the input type _AttachmentUploader_.

Expand Down
4 changes: 2 additions & 2 deletions docs/rich-text.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ If you want to work with rich text in Content Studio, HtmlArea is the input type

This input type offers some very powerful editing capabilities and a lot of configuration options.

This whole {document} is dedicated to https://developer.enonic.com/docs/xp/stable/cms/input-types#htmlarea[HtmlArea input type] and the editor used to define its data. For a full detailed exaplanation of the Rich text editor used in content studio, please visit the https://developer.enonic.com/docs/content-studio/stable/editor/rich-text-editor[Rich text editor reference documentation].
This whole {document} is dedicated to https://developer.enonic.com/docs/xp/stable/cms/schemas/input-types/htmlarea[HtmlArea input type] and the editor used to define its data. For a full detailed exaplanation of the Rich text editor used in content studio, please visit the https://developer.enonic.com/docs/content-studio/stable/editor/rich-text-editor[Rich text editor reference documentation].

NOTE: {see-prev-docs}

Expand Down Expand Up @@ -70,7 +70,7 @@ Finally, if you want to exclude most tools, but not all, you can exclude all and
.An HtmlArea with a selection of tools and `<exclude>*</exclude>`
image::input-type-html-area-some-controls.png[An HtmlArea configured to include a selection of editing tools, {image-s}, align=center]

As introduced in the beginning, for a full overview of the available text tools and HtmlArea configuration options, visit the https://developer.enonic.com/docs/xp/stable/cms/input-types#htmlarea[HtmlArea input type reference docs].
As introduced in the beginning, for a full overview of the available text tools and HtmlArea configuration options, visit the https://developer.enonic.com/docs/xp/stable/cms/schemas/input-types/htmlarea[HtmlArea input type reference docs].

=== Task: {content-type-2-capitalized} description

Expand Down
8 changes: 3 additions & 5 deletions docs/sets.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -40,8 +40,7 @@ image::field-set.png["A field set containing TextLine and TextArea inputs. The f

Item sets also allow you to group input fields, but as opposed to field sets, item sets group values _both_ visually _and_ on a structural level. Item sets can be arbitrarily nested.

- The https://developer.enonic.com/docs/xp/stable/cms/sets#item_set[item set documentation] does a standout job of explaining exactly how they work, so check that out for an overview.
- The https://developer.enonic.com/docs/xp/stable/cms/schemas#item_set[item set schema documentation] contains all the information you'd need on how to create an item set schema.
- The https://developer.enonic.com/docs/xp/stable/cms/schemas/item-set[item set documentation] does a standout job of explaining exactly how they work, so check that out for an overview.

.An item set containing contact info
image::item-set-sample.png["A pair of visually grouped inputs on a card element. The card has a header that says 'contact info'. There is also a button to add more contact info forms.", {image-s}, align=center]
Expand All @@ -52,8 +51,7 @@ Option sets enable editors (working in Content Studio) to choose from a set of p

Option sets where users can select only one of a number of options are known as _single-select_ option sets. You can also use a _multi-select_ option set if the user should be able to select multiple options simultaneously. We'll look at this too in a task.

- The https://developer.enonic.com/docs/xp/stable/cms/sets#option_set[option set reference documentation] provides a good overview (with accompanying pictures) of how option sets work.
- The https://developer.enonic.com/docs/xp/stable/cms/schemas#option_set[option set schema overview] is very thorough and full of examples on how to use the various configuration options.
- The https://developer.enonic.com/docs/xp/stable/cms/schemas/option-set[option set reference documentation] provides a good overview (with accompanying pictures) of how option sets work.

.A multi-select option set
image::option-set-sample.png["An input form labelled 'multi-selection'. The user has selected one out of four options. Some options contain extra data such as an image selector or other input fields.", {image-s}, align=center]
Expand All @@ -66,7 +64,7 @@ They won't look or behave any different from if you manually typed the same fiel

Mixins go in the `/src/main/resources/site/mixins` directory, following the same naming pattern as the other schemas we've seen (`<mixin-name>/<mixin-name>.xml`).

We'll see them in the upcoming task, but if you want to learn more about them, consult https://developer.enonic.com/docs/xp/stable/cms/mixins[the mixins reference documentation].
We'll see them in the upcoming task, but if you want to learn more about them, consult https://developer.enonic.com/docs/xp/stable/cms/schemas/mixins[the mixins reference documentation].

== Tasks

Expand Down
2 changes: 1 addition & 1 deletion docs/setup.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -142,7 +142,7 @@ GLOBAL OPTIONS:

As can be seen, there are a lot of commands and their subcommands to help you. On this guide, we'll only cover the necessary ones to be able to start developing on XP.

NOTE: Consider checking the https://developer.enonic.com/docs/enonic-cli/stable[CLI documentation] to further investigate its capabilities.
NOTE: Consider checking the https://developer.enonic.com/docs/enonic-cli[CLI documentation] to further investigate its capabilities.

== Git

Expand Down

0 comments on commit 192780d

Please sign in to comment.