diff --git a/docs/00-configurations.md b/docs/00-configurations.md index 39ccf2b..4cb1da7 100644 --- a/docs/00-configurations.md +++ b/docs/00-configurations.md @@ -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). @@ -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 diff --git a/docs/README.md b/docs/README.md index 0c08d7a..1ffc327 100644 --- a/docs/README.md +++ b/docs/README.md @@ -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