Updated README.
This commit is contained in:
parent
bc98ce3f5f
commit
14343c448a
1 changed files with 29 additions and 0 deletions
29
README.md
29
README.md
|
|
@ -6,6 +6,28 @@ The first is displaying the current image, the second one shows the other
|
||||||
images. The current image is switched with the one that has been clicked on in
|
images. The current image is switched with the one that has been clicked on in
|
||||||
the second container.
|
the second container.
|
||||||
|
|
||||||
|
## Installation
|
||||||
|
In the terminal, go either to the global module or site module level of your hierarchy.
|
||||||
|
Then invoke the following command.
|
||||||
|
```bash
|
||||||
|
git clone git@gitlab.com:lewp/modules-galleries-nevena.git modules/galleries/nevena
|
||||||
|
```
|
||||||
|
|
||||||
|
## Configuration
|
||||||
|
In your page file, add the following command to add the module to your page.
|
||||||
|
```php
|
||||||
|
$this->addModule(
|
||||||
|
"galleries_nevena",
|
||||||
|
[
|
||||||
|
"start_landscape_id" => $this->getPageId()."_l100.jpg",
|
||||||
|
"start_portrait_id" => $this->getPageId()."_p100.jpg",
|
||||||
|
"start_module_id" => "backgroundpicture",
|
||||||
|
"gallery_landscape_folder_id" => $this->getPageId()."_landscapes",
|
||||||
|
"gallery_portrait_folder_id" => $this->getPageId()."_portraits"
|
||||||
|
]
|
||||||
|
);
|
||||||
|
```
|
||||||
|
|
||||||
## Available parameters
|
## Available parameters
|
||||||
|
|
||||||
| Key | Default value | Example value | Description |
|
| Key | Default value | Example value | Description |
|
||||||
|
|
@ -20,6 +42,13 @@ the second container.
|
||||||
|
|
||||||
## Behavior
|
## Behavior
|
||||||
|
|
||||||
|
### Image folders
|
||||||
|
The images can be stored either in the global or the site module level, depending
|
||||||
|
on your application.
|
||||||
|
|
||||||
|
The images require to be in the resources/images folder in the nevena module folder,
|
||||||
|
the parameter ids are given relative to this folder.
|
||||||
|
|
||||||
### Orientation priority
|
### Orientation priority
|
||||||
If "landscape" has been chosen, the gallery_landscape_folder_id specifies the image stack that is being used.
|
If "landscape" has been chosen, the gallery_landscape_folder_id specifies the image stack that is being used.
|
||||||
The module checks then every image for its counter part in the portrait folder given as parameter.
|
The module checks then every image for its counter part in the portrait folder given as parameter.
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue