Skip to content

Commit b470703

Browse files
Update readme with instructions for placing blocks with other themes (#197)
* Update readme with instructions for placing blocks with other themes * Add more detail to readme instructions
1 parent aa57be2 commit b470703

File tree

1 file changed

+23
-1
lines changed

1 file changed

+23
-1
lines changed

README.md

Lines changed: 23 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,29 @@ Provides paginated navigation through pages with an overview page and
44
block. A part of the LocalGovDrupal distribution, that can also be installed
55
stand-alone.
66

7-
Content types:
7+
## Install process:
8+
9+
Standard Drupal module installation process applies. But...
10+
11+
The 2 x block configuration files are only installed if you are using the LocalGov Drupal base theme or Scarfolk theme.
12+
So before installing this module, copy these two files
13+
14+
config/optional/block.block.localgov_guides_contents_base.yml
15+
config/optional/block.block.localgov_guides_prev_next_block_base.yml
16+
17+
and make the following changes to the copies of the files:
18+
19+
- name the copies of the files consistently for your theme, e.g. localgov_guides_contents_mytheme.yml
20+
- update the id parameters, .e.g id: localgov_guides_contents_mytheme
21+
- replace "localgov_base" with your theme name, update the id and set a region available to the theme:
22+
23+
Note: if you have a long machine name for your theme, consider shortening the naming used here to avoid running into errors.
24+
25+
You can revert these changes after module installation as these files are no longer needed.
26+
27+
Alternatively, add these two blocks from the Drupal block layout admin page.
28+
29+
## Content types:
830

931
* Overview - the top level section for each guide;
1032
* Page - the page that can be placed in a guide.

0 commit comments

Comments
 (0)