Skip to content

Commit

Permalink
Cleaned up Markdown
Browse files Browse the repository at this point in the history
  • Loading branch information
rimi-itk committed May 7, 2024
1 parent 7410949 commit 5ae3ae7
Show file tree
Hide file tree
Showing 11 changed files with 47 additions and 31 deletions.
14 changes: 8 additions & 6 deletions modules/os2forms_attachment/README.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,22 @@
# OS2Forms Attachment Drupal module

# Module purpose
## Module purpose

The aim of this module is to provide an OS2forms attachment element for adding PDF/HTML attachment.

It also supports creation of reusable headers/footers components which are used when rendering the attachments.

# How does it work
## How does it work

To add custom headers/footer ```admin/structure/webform/config/os2forms_attachment_component```
To add custom headers/footer `admin/structure/webform/config/os2forms_attachment_component`

To specify headers/footers that will override the default ones on a global level (**Third party settings** -> **Entity print** section): ```admin/structure/webform/config```
To specify headers/footers that will override the default ones on a global level (**Third party settings** -> **Entity
print** section): `admin/structure/webform/config`

To specify headers/footers that will override the default ones on a form level (**Third party settings** -> **Entity print** section): ```/admin/structure/webform/manage/[webform]/settings```
To specify headers/footers that will override the default ones on a form level (**Third party settings** -> **Entity
print** section): ```/admin/structure/webform/manage/[webform]/settings```

# Overwriting templates
## Overwriting templates

With some setups it might be necessary to overwrite templates
in order to access stylesheets or images.
Expand Down
9 changes: 5 additions & 4 deletions modules/os2forms_autocomplete/README.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,16 @@
# OS2Forms Autocomplete Drupal module

# Module purpose
## Module purpose

The aim of this module is to provide a genetic OS2Forms Autocomplete element which can return options from an external webservice.
The aim of this module is to provide a genetic OS2Forms Autocomplete element which can return options from an external
webservice.

# How does it work
## How does it work

Module exposes OS2Forms Autocomplete component that are available in the webform build process.

Build page:

```
```url
admin/structure/webform/manage/[webform]
```
3 changes: 1 addition & 2 deletions modules/os2forms_consent/README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@
# OS2forms Consent Drupal module

## Module purpose

The aim of this module is to provide integration consent provider.

## How does it work


7 changes: 4 additions & 3 deletions modules/os2forms_dawa/README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,11 @@
# OS2Forms DAWA Drupal module

# Module purpose
## Module purpose

The aim of this module is to provide integration with Danish Addresses Web API (DAWA https://dawa.aws.dk) and provider address autocomplete fields.
The aim of this module is to provide integration with Danish Addresses Web API (DAWA <https://dawa.aws.dk>) and provider
address autocomplete fields.

# How does it work
## How does it work

Module exposes couple of new Autocomplete components that are available in the webform build process.

Expand Down
9 changes: 7 additions & 2 deletions modules/os2forms_forloeb/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
# OS2Forms Forløb Change Log

All notable changes to this project should be documented in this file.

The format is based on [Keep a Changelog](http://keepachangelog.com/)
Expand All @@ -16,9 +17,11 @@ before starting to add changes.
## 2.5.2 - 27.03.2023

### Updated

- Bumped drupal/ultimate_cron version fixing [Deprecated function: Implicit conversion from float-string](https://www.drupal.org/project/ultimate_cron/issues/3256142).

## 2.5.1 - 10.03.2023

- Added github action for checking changelog changes when creating pull requests
- Added os2forms/os2forms dependency
- Changed composer patching configuration
Expand All @@ -29,18 +32,20 @@ before starting to add changes.
## 2.5.0 - 11.10.2022

### Added

- retry task controller action
- Added support for inheriting values without creating a submission

## 2.4.0

### Added

- Github CI action for checking Drupal Coding standards with PHP Code Sniffer
- Fixed coding standards issues


## Example of change log record
```

```markdown
## [x.x.x] Release name
### Added
- Description on added functionality.
Expand Down
16 changes: 8 additions & 8 deletions modules/os2forms_forloeb/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,13 @@ Adds a Maestro workflow engine and advanced workflow functionality to OS2forms.

## Installing OS2forms 2.1 med Forløb

This module requires the codebase from the [OS2forms core project](https://github.com/OS2Forms/os2forms8) installed per the documentation and by selecting the os2forms_forloeb_profile at installation. After succesful installation you should have the OS2forms med Forløb Module available for install via gui.
This module requires the codebase from the [OS2forms core project](https://github.com/OS2Forms/os2forms8) installed per
the documentation and by selecting the os2forms_forloeb_profile at installation. After succesful installation you should
have the OS2forms med Forløb Module available for install via gui.

You can also install the module by using Drush:

```
```shell
./vendor/bin/drush pm:enable os2forms_forloeb
```

Expand All @@ -32,20 +34,18 @@ Settings for OS2Forms forløb are defined on `/admin/config/system/os2forms_forl

#### Known anonymous roles

In order to make the notifications work, Maestro workflow tasks must be assigned
to a *known anonymous role* and these roles are defined under *Known anonymous
roles*.
In order to make the notifications work, Maestro workflow tasks must be assigned to a *known anonymous role* and these
roles are defined under *Known anonymous roles*.

#### Processing

A notification is not sent to a user immediately, but added to a queue which
must be processed asynchronously. Specify the queue handling notification jobs.
A notification is not sent to a user immediately, but added to a queue which must be processed asynchronously. Specify
the queue handling notification jobs.

#### Templates

Define templates for emails and digital post (PDF).


To reference assets, e.g. stylesheet or images, in your templates,
you can use the `base_url` Twig variable to get the base URL:

Expand Down
5 changes: 2 additions & 3 deletions modules/os2forms_nemid/README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# OS2Forms Nemid Drupal module

# Module purpose
## Module purpose

The aim of this module is to provide custom NemId field and integration with OS2Web Nemlogin module.

# How does it work
## How does it work

Module exposes dozen of new NemID components that are available in the webform build process.

Expand All @@ -17,4 +17,3 @@ Besides this module adds a special settings to the Third Party Webform settings:
- Hide form if under address protection

Settings: admin/structure/webform/manage/[webform]/settings

7 changes: 6 additions & 1 deletion modules/os2forms_permissions_by_term/README.md
Original file line number Diff line number Diff line change
@@ -1,24 +1,29 @@
# OS2Forms permission by term module

This module implements permission by term access restrictions
on several lists and entity displays related to webform and maestro.

## Setup configuration

Add to your settings.php or local.settings.php
```

```php
$config['permissions_by_term.settings'] = [
'permissions_mode' => FALSE,
'require_all_terms_granted' => FALSE,
'disable_node_access_records' => FALSE
'target_bundles' => ['user_affiliation']
]
```

Alternative change your site configuration on admin/permissions-by-term/settings to match the above.

!note This is the recommended configuration of the permissions_by_term module. Using different values for
'require_all_terms_granted', 'permissions_mode' or 'disable_node_access_records' may cause unexpected results and should
be thoroughly tested.

## Usage

- The user affiliation taxonomy is added to webform config form and Maestro workflow forms.
- The Permissions by Term module adds a form element to the user form.
- When a user visits an entity of the above mentioned this module checks for match between the entity and the users
Expand Down
1 change: 1 addition & 0 deletions modules/os2forms_sbsys/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# OS2forms SBSYS integration Drupal module

## Module purpose

The aim of this module is to provide integration with SBSYS ESDH provider.

## How does it work
Expand Down
3 changes: 3 additions & 0 deletions modules/os2forms_webform_maps/README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,16 @@
# OS2Forms Webform Maps module for Drupal 9

## Module description

Provides integration with Leaflet maps and provides map element for webform.

## How does it work

The module provides a new element type for webform. The element type is called "OS2Forms Kort".
The element type is based on the Leaflet library. The element type provides a map with a marker
that can be moved around on the map. The element type also provides ways of changing layers on
the map. The data can be exported to PDF.

## Installation

The module can be installed using the standard Drupal installation procedure.
4 changes: 2 additions & 2 deletions modules/webform_embed/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
Webform Embed
# Webform Embed

This is a copy of the abandoned project https://www.drupal.org/project/webform_embed.
This is a copy of the abandoned project <https://www.drupal.org/project/webform_embed>.

Since there is no drupal 9 version available and there probably never will be, future maintenance of this module must be
handled by the os2forms development team.

0 comments on commit 5ae3ae7

Please sign in to comment.