Skip to content

Commit

Permalink
Merge pull request #331 from mfleeson/main
Browse files Browse the repository at this point in the history
Fixing image links #327
  • Loading branch information
HLeithner authored Nov 15, 2024
2 parents a27244a + 19c41f2 commit aa555cf
Show file tree
Hide file tree
Showing 46 changed files with 200 additions and 140 deletions.
File renamed without changes
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,9 @@ sidebar_position: 2
title: Accessiblemedia Form Field
---

Accessiblemedia Form Field
==========================

The **accessiblemedia** form field type provides modal access to the media manager for the choice of an image (like the media field) and allows the user to specify associated Alt Text. Users with appropriate permissions will be able to upload files.

- **type** (mandatory) must be *accessiblemedia*.
Expand All @@ -29,7 +32,8 @@ Implemented by: libraries/src/Form/Field/AccessiblemediaField.php
This will open the media manager with the directory /images/stories/ already selected.
It will allow the user to select a media item and to specify the associated Alt Text.

![](\img\accessiblemedia.jpg)
![Screenshot of accessible media field with alt input field](_assets/accessiblemedia/accessiblemedia.jpg)

The one the right is an Accessible Media Field.

Note that if you are using this field on the frontend then permissions restrictions are likely to be in force. If the user is not authorized to view or add media they will see an error page in the modal popup ("403 You are not authorized to view this resource.").
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@ sidebar_position: 2
title: Calendar Form Field
---

Calendar Form Field
===================

The **calendar** form field type provides a text box for entry of a date. An icon next to the text box provides a link
to a pop-up calendar, which can also be used to enter the date value. If the field has a saved value this is shown in
Expand Down Expand Up @@ -74,7 +76,7 @@ Implemented by: libraries/src/Form/Field/CalendarField.php
/>
```

![](D:\Mark\Documents\GitHub\DevelopersManual\static\img\screenshots\DatePicker1.calendar-en.png)
![Datepicker without time selector](_assets/calendar/DatePicker1.calendar-en.png)

## Example XML parameter definition for an advanced DatePicker

Expand All @@ -100,7 +102,7 @@ Implemented by: libraries/src/Form/Field/CalendarField.php
/>
```

![](D:\Mark\Documents\GitHub\DevelopersManual\static\img\screenshots\DatePicker2.calendar-en.png)
![Datepicker with time selector](_assets/calendar/DatePicker2.calendar-en.png)

The format attribute specifies the format that the date string will be saved in. It is also the format that manually
entered dates need to be enterered in; except that the punctuation character is ignored. The coding scheme used to
Expand Down
56 changes: 31 additions & 25 deletions docs/general-concepts/forms-fields/standard-fields/note.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,10 @@ sidebar_position: 2
title: Note Form Field
---

Note Form Field
===============


The **note** form field type makes it possible to create titles, texts, descriptions and even alert boxes. It also allows you to bring order in the settings for extensions, by separating them with useful titles. Or adding descriptions for certain settings (without having to rely on the tooltips). Or adding any other text you want.

- **type** (mandatory) must be *note*.
Expand All @@ -18,58 +22,60 @@ Implemented by: libraries/src/Form/Field/NoteField.php
## Example XML parameter definition

```xml
<field
<field
name="mynote"
type="note"
default=""
label="A heading goes here"
description=""
/>
/>
```

### Title and Description
In the following code examples we will use these example language strings:

```xml
```ini
LOREMIPSUM="Lorem ipsum dolor sit amet"
LOREMIPSUM_DESC="Consectetuer adipiscing elit, sed diam"
```
With this note field you can either use the title or the description or both.

```xml
<field name="opt10" type="text" label="Some Other Option" />
<field name="note11" type="note" label="LOREMIPSUM" />
<field name="opt11" type="text" label="Some Other Option" />
<field name="note12" type="note" description="LOREMIPSUM_DESC" />
<field name="opt12" type="text" label="Some Other Option" />
<field name="note13" type="note" label="LOREMIPSUM" description="LOREMIPSUM_DESC" />
<field name="opt13" type="text" label="Some Other Option" />
<field name="opt10" type="text" label="Some Other Option" />
<field name="note11" type="note" label="LOREMIPSUM" />
<field name="opt11" type="text" label="Some Other Option" />
<field name="note12" type="note" description="LOREMIPSUM_DESC" />
<field name="opt12" type="text" label="Some Other Option" />
<field name="note13" type="note" label="LOREMIPSUM" description="LOREMIPSUM_DESC" />
<field name="opt13" type="text" label="Some Other Option" />
```

![](D:\Mark\Documents\GitHub\DevelopersManual\static\img\screenshots\note-form-field-title-screenshot.png)
![Screenshot with title field](_assets/note/note-form-field-title-screenshot.png)

### Classes (Alerts)
You can add classes to the note. In this way you can easily make (Bootstrap) alerts and also add other styling via class names (like a 'well').
```xml
<field name="opt20" type="text" label="Some Other Option" />
<field name="note21" type="note" class="alert" label="LOREMIPSUM" description="LOREMIPSUM_DESC" />
<field name="opt21" type="text" label="Some Other Option" />
<field name="note22" type="note" class="alert alert-info" label="LOREMIPSUM" description="LOREMIPSUM_DESC" />
<field name="opt22" type="text" label="Some Other Option" />
<field name="note23" type="note" class="alert alert-success" label="LOREMIPSUM" description="LOREMIPSUM_DESC" />
<field name="opt23" type="text" label="Some Other Option" />
<field name="note24" type="note" class="alert alert-error" label="LOREMIPSUM" description="LOREMIPSUM_DESC" />
<field name="opt24" type="text" label="Some Other Option" />
<field name="opt20" type="text" label="Some Other Option" />
<field name="note21" type="note" class="alert" label="LOREMIPSUM" description="LOREMIPSUM_DESC" />
<field name="opt21" type="text" label="Some Other Option" />
<field name="note22" type="note" class="alert alert-info" label="LOREMIPSUM" description="LOREMIPSUM_DESC" />
<field name="opt22" type="text" label="Some Other Option" />
<field name="note23" type="note" class="alert alert-success" label="LOREMIPSUM" description="LOREMIPSUM_DESC" />
<field name="opt23" type="text" label="Some Other Option" />
<field name="note24" type="note" class="alert alert-error" label="LOREMIPSUM" description="LOREMIPSUM_DESC" />
<field name="opt24" type="text" label="Some Other Option" />
```
![](D:\Mark\Documents\GitHub\DevelopersManual\static\img\screenshots\note-form-field-classes-screenshot.png)

![Screenshot with classes set](_assets/note/note-form-field-classes-screenshot.png)

### Close Button
A close button can be added to the alerts by adding the close="true" attribute to the tag. If you use a class other than the alert, use the required value for the data-dismiss of the Bootstrap close icon instead of the value true. Here is the code to test the close icon on an alert.
```xml
<field name="opt30" type="text" label="Some Other Option" />
<field name="note31" type="note" class="alert" close="true" label="LOREMIPSUM" description="LOREMIPSUM_DESC" />
<field name="opt31" type="text" label="Some Other Option" />
<field name="opt30" type="text" label="Some Other Option" />
<field name="note31" type="note" class="alert" close="true" label="LOREMIPSUM" description="LOREMIPSUM_DESC" />
<field name="opt31" type="text" label="Some Other Option" />
```
![](D:\Mark\Documents\GitHub\DevelopersManual\static\img\screenshots\note-form-field-close-screenshot.png)

![Screenshot with note close button](_assets/note/note-form-field-close-screenshot.png)

Be aware that a closed alert/note cannot be reopened by the user without page reload. It's not a show/hide functionality.
Binary file removed static/img/screenshots/Params.timezones.jpg
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,9 @@ sidebar_position: 2
title: Accessiblemedia Form Field
---

Accessiblemedia Form Field
==========================

The **accessiblemedia** form field type provides modal access to the media manager for the choice of an image (like the media field) and allows the user to specify associated Alt Text. Users with appropriate permissions will be able to upload files.

- **type** (mandatory) must be *accessiblemedia*.
Expand All @@ -29,7 +32,8 @@ Implemented by: libraries/src/Form/Field/AccessiblemediaField.php
This will open the media manager with the directory /images/stories/ already selected.
It will allow the user to select a media item and to specify the associated Alt Text.

![](\img\accessiblemedia.jpg)
![Screenshot of accessible media field with alt input field](_assets/accessiblemedia/accessiblemedia.jpg)

The one the right is an Accessible Media Field.

Note that if you are using this field on the frontend then permissions restrictions are likely to be in force. If the user is not authorized to view or add media they will see an error page in the modal popup ("403 You are not authorized to view this resource.").
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@ sidebar_position: 2
title: Calendar Form Field
---

Calendar Form Field
===================

The **calendar** form field type provides a text box for entry of a date. An icon next to the text box provides a link
to a pop-up calendar, which can also be used to enter the date value. If the field has a saved value this is shown in
Expand Down Expand Up @@ -74,7 +76,7 @@ Implemented by: libraries/src/Form/Field/CalendarField.php
/>
```

![](D:\Mark\Documents\GitHub\DevelopersManual\static\img\screenshots\DatePicker1.calendar-en.png)
![Datepicker without time selector](_assets/calendar/DatePicker1.calendar-en.png)

## Example XML parameter definition for an advanced DatePicker

Expand All @@ -100,7 +102,7 @@ Implemented by: libraries/src/Form/Field/CalendarField.php
/>
```

![](D:\Mark\Documents\GitHub\DevelopersManual\static\img\screenshots\DatePicker2.calendar-en.png)
![Datepicker with time selector](_assets/calendar/DatePicker2.calendar-en.png)

The format attribute specifies the format that the date string will be saved in. It is also the format that manually
entered dates need to be enterered in; except that the punctuation character is ignored. The coding scheme used to
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,10 @@ sidebar_position: 2
title: Note Form Field
---

Note Form Field
===============


The **note** form field type makes it possible to create titles, texts, descriptions and even alert boxes. It also allows you to bring order in the settings for extensions, by separating them with useful titles. Or adding descriptions for certain settings (without having to rely on the tooltips). Or adding any other text you want.

- **type** (mandatory) must be *note*.
Expand All @@ -18,58 +22,60 @@ Implemented by: libraries/src/Form/Field/NoteField.php
## Example XML parameter definition

```xml
<field
<field
name="mynote"
type="note"
default=""
label="A heading goes here"
description=""
/>
/>
```

### Title and Description
In the following code examples we will use these example language strings:

```xml
```ini
LOREMIPSUM="Lorem ipsum dolor sit amet"
LOREMIPSUM_DESC="Consectetuer adipiscing elit, sed diam"
```
With this note field you can either use the title or the description or both.

```xml
<field name="opt10" type="text" label="Some Other Option" />
<field name="note11" type="note" label="LOREMIPSUM" />
<field name="opt11" type="text" label="Some Other Option" />
<field name="note12" type="note" description="LOREMIPSUM_DESC" />
<field name="opt12" type="text" label="Some Other Option" />
<field name="note13" type="note" label="LOREMIPSUM" description="LOREMIPSUM_DESC" />
<field name="opt13" type="text" label="Some Other Option" />
<field name="opt10" type="text" label="Some Other Option" />
<field name="note11" type="note" label="LOREMIPSUM" />
<field name="opt11" type="text" label="Some Other Option" />
<field name="note12" type="note" description="LOREMIPSUM_DESC" />
<field name="opt12" type="text" label="Some Other Option" />
<field name="note13" type="note" label="LOREMIPSUM" description="LOREMIPSUM_DESC" />
<field name="opt13" type="text" label="Some Other Option" />
```

![](D:\Mark\Documents\GitHub\DevelopersManual\static\img\screenshots\note-form-field-title-screenshot.png)
![Screenshot with title field](_assets/note/note-form-field-title-screenshot.png)

### Classes (Alerts)
You can add classes to the note. In this way you can easily make (Bootstrap) alerts and also add other styling via class names (like a 'well').
```xml
<field name="opt20" type="text" label="Some Other Option" />
<field name="note21" type="note" class="alert" label="LOREMIPSUM" description="LOREMIPSUM_DESC" />
<field name="opt21" type="text" label="Some Other Option" />
<field name="note22" type="note" class="alert alert-info" label="LOREMIPSUM" description="LOREMIPSUM_DESC" />
<field name="opt22" type="text" label="Some Other Option" />
<field name="note23" type="note" class="alert alert-success" label="LOREMIPSUM" description="LOREMIPSUM_DESC" />
<field name="opt23" type="text" label="Some Other Option" />
<field name="note24" type="note" class="alert alert-error" label="LOREMIPSUM" description="LOREMIPSUM_DESC" />
<field name="opt24" type="text" label="Some Other Option" />
<field name="opt20" type="text" label="Some Other Option" />
<field name="note21" type="note" class="alert" label="LOREMIPSUM" description="LOREMIPSUM_DESC" />
<field name="opt21" type="text" label="Some Other Option" />
<field name="note22" type="note" class="alert alert-info" label="LOREMIPSUM" description="LOREMIPSUM_DESC" />
<field name="opt22" type="text" label="Some Other Option" />
<field name="note23" type="note" class="alert alert-success" label="LOREMIPSUM" description="LOREMIPSUM_DESC" />
<field name="opt23" type="text" label="Some Other Option" />
<field name="note24" type="note" class="alert alert-error" label="LOREMIPSUM" description="LOREMIPSUM_DESC" />
<field name="opt24" type="text" label="Some Other Option" />
```
![](D:\Mark\Documents\GitHub\DevelopersManual\static\img\screenshots\note-form-field-classes-screenshot.png)

![Screenshot with classes set](_assets/note/note-form-field-classes-screenshot.png)

### Close Button
A close button can be added to the alerts by adding the close="true" attribute to the tag. If you use a class other than the alert, use the required value for the data-dismiss of the Bootstrap close icon instead of the value true. Here is the code to test the close icon on an alert.
```xml
<field name="opt30" type="text" label="Some Other Option" />
<field name="note31" type="note" class="alert" close="true" label="LOREMIPSUM" description="LOREMIPSUM_DESC" />
<field name="opt31" type="text" label="Some Other Option" />
<field name="opt30" type="text" label="Some Other Option" />
<field name="note31" type="note" class="alert" close="true" label="LOREMIPSUM" description="LOREMIPSUM_DESC" />
<field name="opt31" type="text" label="Some Other Option" />
```
![](D:\Mark\Documents\GitHub\DevelopersManual\static\img\screenshots\note-form-field-close-screenshot.png)

![Screenshot with note close button](_assets/note/note-form-field-close-screenshot.png)

Be aware that a closed alert/note cannot be reopened by the user without page reload. It's not a show/hide functionality.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,9 @@ sidebar_position: 2
title: Accessiblemedia Form Field
---

Accessiblemedia Form Field
==========================

The **accessiblemedia** form field type provides modal access to the media manager for the choice of an image (like the media field) and allows the user to specify associated Alt Text. Users with appropriate permissions will be able to upload files.

- **type** (mandatory) must be *accessiblemedia*.
Expand All @@ -29,7 +32,8 @@ Implemented by: libraries/src/Form/Field/AccessiblemediaField.php
This will open the media manager with the directory /images/stories/ already selected.
It will allow the user to select a media item and to specify the associated Alt Text.

![](\img\accessiblemedia.jpg)
![Screenshot of accessible media field with alt input field](_assets/accessiblemedia/accessiblemedia.jpg)

The one the right is an Accessible Media Field.

Note that if you are using this field on the frontend then permissions restrictions are likely to be in force. If the user is not authorized to view or add media they will see an error page in the modal popup ("403 You are not authorized to view this resource.").
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@ sidebar_position: 2
title: Calendar Form Field
---

Calendar Form Field
===================

The **calendar** form field type provides a text box for entry of a date. An icon next to the text box provides a link
to a pop-up calendar, which can also be used to enter the date value. If the field has a saved value this is shown in
Expand Down Expand Up @@ -74,7 +76,7 @@ Implemented by: libraries/src/Form/Field/CalendarField.php
/>
```

![](D:\Mark\Documents\GitHub\DevelopersManual\static\img\screenshots\DatePicker1.calendar-en.png)
![Datepicker without time selector](_assets/calendar/DatePicker1.calendar-en.png)

## Example XML parameter definition for an advanced DatePicker

Expand All @@ -100,7 +102,7 @@ Implemented by: libraries/src/Form/Field/CalendarField.php
/>
```

![](D:\Mark\Documents\GitHub\DevelopersManual\static\img\screenshots\DatePicker2.calendar-en.png)
![Datepicker with time selector](_assets/calendar/DatePicker2.calendar-en.png)

The format attribute specifies the format that the date string will be saved in. It is also the format that manually
entered dates need to be enterered in; except that the punctuation character is ignored. The coding scheme used to
Expand Down
Loading

0 comments on commit aa555cf

Please sign in to comment.