Skip to content

Commit

Permalink
Extends documentation (#41)
Browse files Browse the repository at this point in the history
- Adds notes about the hard-coded display limit for the decendants found
- Other tiny tweaks

* Update README.md
* Update 00-configurations.md
  • Loading branch information
kghbln committed May 17, 2018
1 parent 28a91df commit 6da04f0
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 3 deletions.
7 changes: 7 additions & 0 deletions docs/00-configurations.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
## Configuration

This file describes the configuration of the Semantic Breadcrumb Links (SBL) extension.

### General

- `$GLOBALS['egSBLTryToFindClosestDescendant']` if enabled SBL will try to find the closest descendant
(it will not work for subpages due to missing annotation information).

Expand All @@ -11,6 +15,9 @@ matches (`parent > grandparent > great-grandparent` etc.) that can be found rela
subject. If multiple parents or children are available for a subject then only one of each can be
displayed due to the nature of the breadcrumb trail.

Note that the display of these aforementioned decendants is limited to 20 (1 shown directly and 19 via
the dropdown) for best experience even though more may exist. This limit cannot be changed.

### Styling

The output can easily be adjusted using the deployed styles (in `res/sbl.styles.css`) together with
Expand Down
6 changes: 3 additions & 3 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
![image](https://cloud.githubusercontent.com/assets/1245473/16253761/85daa7b2-3839-11e6-833e-6ec2bc15756b.png)

SBL will try to generate a breadcrumb trail if a property relation can be matched including its
relational directionality. `>` indicates a `Has parent` (or `Is child of`) relationship
while `<` describes the closest descendant for a `Is parent of` affinity.
Semantic Breadcrumb Links (SBL) will try to generate a breadcrumb trail if a property relation can be matched
including its relational directionality. `>` indicates a `Has parent` (or `Is child of`) relationship while
`<` describes the closest descendant for a `Is parent of` affinity.

It is required to specify a property search pattern (by default `Has parent page` is assigned
as special property to `NS_MAIN`) in order to find relationships between a subject and its
Expand Down

0 comments on commit 6da04f0

Please sign in to comment.