@teipublisher/pb-components 1.43.0 → 1.43.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +7 -0
- package/css/components.css +5 -0
- package/dist/demo/components.css +15 -1
- package/dist/demo/pb-view2.html +135 -136
- package/dist/pb-component-docs.js +40 -40
- package/dist/pb-components-bundle.js +261 -261
- package/dist/pb-elements.json +93 -93
- package/dist/{pb-message-c4cd7861.js → pb-message-fbc1b645.js} +25 -26
- package/dist/pb-odd-editor.js +1 -1
- package/package.json +1 -1
- package/pb-elements.json +93 -93
- package/src/assets/components.css +5 -0
- package/src/pb-browse-docs.js +520 -519
- package/src/pb-clipboard.js +75 -74
- package/src/pb-collapse.js +183 -182
- package/src/pb-page.js +7 -4
- package/src/pb-table-grid.js +2 -2
- package/src/pb-view.js +1366 -1368
- package/src/theming.js +51 -16
package/dist/pb-elements.json
CHANGED
|
@@ -1307,7 +1307,7 @@
|
|
|
1307
1307
|
},
|
|
1308
1308
|
{
|
|
1309
1309
|
"name": "group",
|
|
1310
|
-
"description": "If set, requires the logged in user to be member of\nthe given group.",
|
|
1310
|
+
"description": "If set, requires the logged in user to be member of\r\nthe given group.",
|
|
1311
1311
|
"type": "string"
|
|
1312
1312
|
},
|
|
1313
1313
|
{
|
|
@@ -1356,7 +1356,7 @@
|
|
|
1356
1356
|
},
|
|
1357
1357
|
{
|
|
1358
1358
|
"name": "static",
|
|
1359
|
-
"description": "If set, rewrite URLs to load pages as static HTML files,\nso no TEI Publisher instance is required",
|
|
1359
|
+
"description": "If set, rewrite URLs to load pages as static HTML files,\r\nso no TEI Publisher instance is required",
|
|
1360
1360
|
"type": "boolean",
|
|
1361
1361
|
"default": "false"
|
|
1362
1362
|
},
|
|
@@ -1488,7 +1488,7 @@
|
|
|
1488
1488
|
{
|
|
1489
1489
|
"name": "group",
|
|
1490
1490
|
"attribute": "group",
|
|
1491
|
-
"description": "If set, requires the logged in user to be member of\nthe given group.",
|
|
1491
|
+
"description": "If set, requires the logged in user to be member of\r\nthe given group.",
|
|
1492
1492
|
"type": "string"
|
|
1493
1493
|
},
|
|
1494
1494
|
{
|
|
@@ -1547,7 +1547,7 @@
|
|
|
1547
1547
|
{
|
|
1548
1548
|
"name": "static",
|
|
1549
1549
|
"attribute": "static",
|
|
1550
|
-
"description": "If set, rewrite URLs to load pages as static HTML files,\nso no TEI Publisher instance is required",
|
|
1550
|
+
"description": "If set, rewrite URLs to load pages as static HTML files,\r\nso no TEI Publisher instance is required",
|
|
1551
1551
|
"type": "boolean",
|
|
1552
1552
|
"default": "false"
|
|
1553
1553
|
},
|
|
@@ -1779,7 +1779,7 @@
|
|
|
1779
1779
|
{
|
|
1780
1780
|
"name": "pb-clipboard",
|
|
1781
1781
|
"path": "./src/pb-clipboard.js",
|
|
1782
|
-
"description": "A component with a button which copies the contained content to the clipboard.\nUse for the typical 'quote this content as' hints on a webpage.",
|
|
1782
|
+
"description": "A component with a button which copies the contained content to the clipboard.\r\nUse for the typical 'quote this content as' hints on a webpage.",
|
|
1783
1783
|
"attributes": [
|
|
1784
1784
|
{
|
|
1785
1785
|
"name": "label",
|
|
@@ -2179,7 +2179,7 @@
|
|
|
2179
2179
|
{
|
|
2180
2180
|
"name": "pb-collapse",
|
|
2181
2181
|
"path": "./src/pb-collapse.js",
|
|
2182
|
-
"description": "A collapsible block: in collapsed state it only shows a header and expands if clicked.\nThe header should go into slot `collapse-trigger`, the content into `collapse-content`.\nExample:\n\n```html\n<pb-collapse>\n <div slot=\"collapse-trigger\">\n Metadata\n </div>\n <pb-view slot=\"collapse-content\" src=\"document1\" subscribe=\"transcription\" xpath=\"//teiHeader\"></pb-view>\n</pb-collapse>\n```",
|
|
2182
|
+
"description": "A collapsible block: in collapsed state it only shows a header and expands if clicked.\r\nThe header should go into slot `collapse-trigger`, the content into `collapse-content`.\r\nExample:\r\n\r\n```html\r\n<pb-collapse>\r\n <div slot=\"collapse-trigger\">\r\n Metadata\r\n </div>\r\n <pb-view slot=\"collapse-content\" src=\"document1\" subscribe=\"transcription\" xpath=\"//teiHeader\"></pb-view>\r\n</pb-collapse>\r\n```",
|
|
2183
2183
|
"attributes": [
|
|
2184
2184
|
{
|
|
2185
2185
|
"name": "horizontal",
|
|
@@ -2219,7 +2219,7 @@
|
|
|
2219
2219
|
},
|
|
2220
2220
|
{
|
|
2221
2221
|
"name": "toggles",
|
|
2222
|
-
"description": "By default, an open collapse is closed if another pb-collapse is expanded on the same event channel.\nSet to true to keep multiple pb-collapse open at the same time.",
|
|
2222
|
+
"description": "By default, an open collapse is closed if another pb-collapse is expanded on the same event channel.\r\nSet to true to keep multiple pb-collapse open at the same time.",
|
|
2223
2223
|
"type": "boolean",
|
|
2224
2224
|
"default": "false"
|
|
2225
2225
|
},
|
|
@@ -2301,7 +2301,7 @@
|
|
|
2301
2301
|
{
|
|
2302
2302
|
"name": "toggles",
|
|
2303
2303
|
"attribute": "toggles",
|
|
2304
|
-
"description": "By default, an open collapse is closed if another pb-collapse is expanded on the same event channel.\nSet to true to keep multiple pb-collapse open at the same time.",
|
|
2304
|
+
"description": "By default, an open collapse is closed if another pb-collapse is expanded on the same event channel.\r\nSet to true to keep multiple pb-collapse open at the same time.",
|
|
2305
2305
|
"type": "boolean",
|
|
2306
2306
|
"default": "false"
|
|
2307
2307
|
},
|
|
@@ -10748,42 +10748,42 @@
|
|
|
10748
10748
|
},
|
|
10749
10749
|
{
|
|
10750
10750
|
"name": "odd",
|
|
10751
|
-
"description": "The ODD to use for rendering the document. Overwrites an ODD defined on\n`pb-document`. The odd should be specified by its name without path\nor the `.odd` suffix.",
|
|
10751
|
+
"description": "The ODD to use for rendering the document. Overwrites an ODD defined on\r\n`pb-document`. The odd should be specified by its name without path\r\nor the `.odd` suffix.",
|
|
10752
10752
|
"type": "string"
|
|
10753
10753
|
},
|
|
10754
10754
|
{
|
|
10755
10755
|
"name": "view",
|
|
10756
|
-
"description": "The view type to use for paginating the document. Either `page`, `div` or `single`.\nOverwrites the same property specified on `pb-document`. Values have the following meaning:\n\nValue | Displayed content\n------|------------------\n`page` | content is displayed page by page as determined by tei:pb\n`div` | content is displayed by divisions\n`single` | do not paginate but display entire content at once",
|
|
10756
|
+
"description": "The view type to use for paginating the document. Either `page`, `div` or `single`.\r\nOverwrites the same property specified on `pb-document`. Values have the following meaning:\r\n\r\nValue | Displayed content\r\n------|------------------\r\n`page` | content is displayed page by page as determined by tei:pb\r\n`div` | content is displayed by divisions\r\n`single` | do not paginate but display entire content at once",
|
|
10757
10757
|
"type": "string"
|
|
10758
10758
|
},
|
|
10759
10759
|
{
|
|
10760
10760
|
"name": "node-id",
|
|
10761
|
-
"description": "An eXist nodeId. If specified, selects the root of the fragment of the document\nwhich should be displayed. Normally this property is set automatically by pagination.",
|
|
10761
|
+
"description": "An eXist nodeId. If specified, selects the root of the fragment of the document\r\nwhich should be displayed. Normally this property is set automatically by pagination.",
|
|
10762
10762
|
"type": "string"
|
|
10763
10763
|
},
|
|
10764
10764
|
{
|
|
10765
10765
|
"name": "xml-id",
|
|
10766
|
-
"description": "An xml:id to be displayed. If specified, this determines the root of the fragment to be\ndisplayed. Use to directly navigate to a specific section.",
|
|
10766
|
+
"description": "An xml:id to be displayed. If specified, this determines the root of the fragment to be\r\ndisplayed. Use to directly navigate to a specific section.",
|
|
10767
10767
|
"type": "array"
|
|
10768
10768
|
},
|
|
10769
10769
|
{
|
|
10770
10770
|
"name": "xpath",
|
|
10771
|
-
"description": "An optional XPath expression: the root of the fragment to be processed is determined\nby evaluating the given XPath expression. The XPath expression should be absolute.\nThe namespace of the document is declared as default namespace, so no prefixes should\nbe used.\n\nIf the `map` property is used, it may change scope for the displayed fragment.",
|
|
10771
|
+
"description": "An optional XPath expression: the root of the fragment to be processed is determined\r\nby evaluating the given XPath expression. The XPath expression should be absolute.\r\nThe namespace of the document is declared as default namespace, so no prefixes should\r\nbe used.\r\n\r\nIf the `map` property is used, it may change scope for the displayed fragment.",
|
|
10772
10772
|
"type": "string"
|
|
10773
10773
|
},
|
|
10774
10774
|
{
|
|
10775
10775
|
"name": "map",
|
|
10776
|
-
"description": "If defined denotes the local name of an XQuery function in `modules/map.xql`, which will be called\nwith the current root node and should return the node of a mapped fragment. This is helpful if one\nwants, for example, to show a translation fragment aligned with the part of the transcription currently\nshown. In this case, the properties of the `pb-view` would still point to the transcription, but the function\nidentified by map would return the corresponding fragment from the translation to be processed.\n\nNavigation in the document is still determined by the current root as defined through the `root`, `xpath`\nand `xmlId` properties.",
|
|
10776
|
+
"description": "If defined denotes the local name of an XQuery function in `modules/map.xql`, which will be called\r\nwith the current root node and should return the node of a mapped fragment. This is helpful if one\r\nwants, for example, to show a translation fragment aligned with the part of the transcription currently\r\nshown. In this case, the properties of the `pb-view` would still point to the transcription, but the function\r\nidentified by map would return the corresponding fragment from the translation to be processed.\r\n\r\nNavigation in the document is still determined by the current root as defined through the `root`, `xpath`\r\nand `xmlId` properties.",
|
|
10777
10777
|
"type": "string"
|
|
10778
10778
|
},
|
|
10779
10779
|
{
|
|
10780
10780
|
"name": "column-separator",
|
|
10781
|
-
"description": "CSS selector to find column breaks in the content returned\nfrom the server. If this property is set and column breaks\nare found, the component will display two columns side by side.",
|
|
10781
|
+
"description": "CSS selector to find column breaks in the content returned\r\nfrom the server. If this property is set and column breaks\r\nare found, the component will display two columns side by side.",
|
|
10782
10782
|
"type": "string"
|
|
10783
10783
|
},
|
|
10784
10784
|
{
|
|
10785
10785
|
"name": "load-css",
|
|
10786
|
-
"description": "If set, points to an external stylesheet which should be applied to\nthe text *after* the ODD-generated styles.",
|
|
10786
|
+
"description": "If set, points to an external stylesheet which should be applied to\r\nthe text *after* the ODD-generated styles.",
|
|
10787
10787
|
"type": "string"
|
|
10788
10788
|
},
|
|
10789
10789
|
{
|
|
@@ -10793,17 +10793,17 @@
|
|
|
10793
10793
|
},
|
|
10794
10794
|
{
|
|
10795
10795
|
"name": "use-language",
|
|
10796
|
-
"description": "If set, a refresh will be triggered if a `pb-i18n-update` event is received,\ne.g. due to the user selecting a different interface language.\n\nAlso requires `requireLanguage` to be set on the surrounding `pb-page`.\nSee there for more information.",
|
|
10796
|
+
"description": "If set, a refresh will be triggered if a `pb-i18n-update` event is received,\r\ne.g. due to the user selecting a different interface language.\r\n\r\nAlso requires `requireLanguage` to be set on the surrounding `pb-page`.\r\nSee there for more information.",
|
|
10797
10797
|
"type": "boolean"
|
|
10798
10798
|
},
|
|
10799
10799
|
{
|
|
10800
10800
|
"name": "infinite-scroll",
|
|
10801
|
-
"description": "Experimental: if enabled, the view will incrementally load new document fragments if the user tries to scroll\nbeyond the start or end of the visible text. The feature inserts a small blank section at the top\nand bottom. If this section becomes visible, a load operation will be triggered.\n\nNote: only browsers implementing the `IntersectionObserver` API are supported. Also the feature\ndoes not work in two-column mode or with animations.",
|
|
10801
|
+
"description": "Experimental: if enabled, the view will incrementally load new document fragments if the user tries to scroll\r\nbeyond the start or end of the visible text. The feature inserts a small blank section at the top\r\nand bottom. If this section becomes visible, a load operation will be triggered.\r\n\r\nNote: only browsers implementing the `IntersectionObserver` API are supported. Also the feature\r\ndoes not work in two-column mode or with animations.",
|
|
10802
10802
|
"type": "boolean"
|
|
10803
10803
|
},
|
|
10804
10804
|
{
|
|
10805
10805
|
"name": "src",
|
|
10806
|
-
"description": "The id of a `pb-document` element this view should display.\nSettings like `odd` or `view` will be taken from the `pb-document`\nunless overwritten by properties in this component.\n\nThis property is **required** and **must** point to an existing `pb-document` with\nthe given id.\n\nSetting the property after initialization will clear the properties xmlId, nodeId and odd.",
|
|
10806
|
+
"description": "The id of a `pb-document` element this view should display.\r\nSettings like `odd` or `view` will be taken from the `pb-document`\r\nunless overwritten by properties in this component.\r\n\r\nThis property is **required** and **must** point to an existing `pb-document` with\r\nthe given id.\r\n\r\nSetting the property after initialization will clear the properties xmlId, nodeId and odd.",
|
|
10807
10807
|
"type": "string"
|
|
10808
10808
|
},
|
|
10809
10809
|
{
|
|
@@ -10813,25 +10813,25 @@
|
|
|
10813
10813
|
},
|
|
10814
10814
|
{
|
|
10815
10815
|
"name": "on-update",
|
|
10816
|
-
"description": "If set to true, the component will not load automatically. Instead it will wait until it receives a `pb-update`\nevent. Use this to make one `pb-view` component dependent on another one. Default is 'false'.",
|
|
10816
|
+
"description": "If set to true, the component will not load automatically. Instead it will wait until it receives a `pb-update`\r\nevent. Use this to make one `pb-view` component dependent on another one. Default is 'false'.",
|
|
10817
10817
|
"type": "boolean",
|
|
10818
10818
|
"default": "false"
|
|
10819
10819
|
},
|
|
10820
10820
|
{
|
|
10821
10821
|
"name": "append-footnotes",
|
|
10822
|
-
"description": "The server returns footnotes separately. Set this property\nif you wish to append them to the main text.",
|
|
10822
|
+
"description": "The server returns footnotes separately. Set this property\r\nif you wish to append them to the main text.",
|
|
10823
10823
|
"type": "boolean",
|
|
10824
10824
|
"default": "false"
|
|
10825
10825
|
},
|
|
10826
10826
|
{
|
|
10827
10827
|
"name": "not-found",
|
|
10828
|
-
"description": "Message to display if no content was returned by the server.\nSet to empty string to show nothing.",
|
|
10828
|
+
"description": "Message to display if no content was returned by the server.\r\nSet to empty string to show nothing.",
|
|
10829
10829
|
"type": "string",
|
|
10830
10830
|
"default": "\"the server did not return any content\""
|
|
10831
10831
|
},
|
|
10832
10832
|
{
|
|
10833
10833
|
"name": "animation",
|
|
10834
|
-
"description": "wether to animate the view when new page is loaded. Defaults to 'false' meaning that no\nanimation takes place. If 'true' will apply a translateX transistion in forward/backward direction.",
|
|
10834
|
+
"description": "wether to animate the view when new page is loaded. Defaults to 'false' meaning that no\r\nanimation takes place. If 'true' will apply a translateX transistion in forward/backward direction.",
|
|
10835
10835
|
"type": "boolean",
|
|
10836
10836
|
"default": "false"
|
|
10837
10837
|
},
|
|
@@ -10849,30 +10849,30 @@
|
|
|
10849
10849
|
},
|
|
10850
10850
|
{
|
|
10851
10851
|
"name": "infinite-scroll-max",
|
|
10852
|
-
"description": "Maximum number of fragments to keep in memory if `infinite-scroll`\nis enabled. If the user is scrolling beyond the maximum, fragements\nwill be removed from the DOM before or after the current reading position.\nDefault is 10. Set to zero to allow loading the entire document.",
|
|
10852
|
+
"description": "Maximum number of fragments to keep in memory if `infinite-scroll`\r\nis enabled. If the user is scrolling beyond the maximum, fragements\r\nwill be removed from the DOM before or after the current reading position.\r\nDefault is 10. Set to zero to allow loading the entire document.",
|
|
10853
10853
|
"type": "number",
|
|
10854
10854
|
"default": "10"
|
|
10855
10855
|
},
|
|
10856
10856
|
{
|
|
10857
10857
|
"name": "disable-history",
|
|
10858
|
-
"description": "By default, navigating to next/previous page will update browser parameters,\nso reloading the page will load the correct position within the document.\n\nSet this property to disable location tracking for the component altogether.",
|
|
10858
|
+
"description": "By default, navigating to next/previous page will update browser parameters,\r\nso reloading the page will load the correct position within the document.\r\n\r\nSet this property to disable location tracking for the component altogether.",
|
|
10859
10859
|
"type": "boolean",
|
|
10860
10860
|
"default": "false"
|
|
10861
10861
|
},
|
|
10862
10862
|
{
|
|
10863
10863
|
"name": "before-update-event",
|
|
10864
|
-
"description": "If set to the name of an event, the content of the pb-view will not be replaced\nimmediately upon updates. Instead, an event is emitted, which contains the new content\nin property `root`. An event handler intercepting the event can thus modify the content.\nOnce it is done, it should pass the modified content to the callback function provided\nin the event detail under the name `render`. See the demo for an example.",
|
|
10864
|
+
"description": "If set to the name of an event, the content of the pb-view will not be replaced\r\nimmediately upon updates. Instead, an event is emitted, which contains the new content\r\nin property `root`. An event handler intercepting the event can thus modify the content.\r\nOnce it is done, it should pass the modified content to the callback function provided\r\nin the event detail under the name `render`. See the demo for an example.",
|
|
10865
10865
|
"type": "string"
|
|
10866
10866
|
},
|
|
10867
10867
|
{
|
|
10868
10868
|
"name": "no-scroll",
|
|
10869
|
-
"description": "If set, do not scroll the view to target node (e.g. given in URL hash) \nafter content was loaded.",
|
|
10869
|
+
"description": "If set, do not scroll the view to target node (e.g. given in URL hash) \r\nafter content was loaded.",
|
|
10870
10870
|
"type": "boolean",
|
|
10871
10871
|
"default": "false"
|
|
10872
10872
|
},
|
|
10873
10873
|
{
|
|
10874
10874
|
"name": "static",
|
|
10875
|
-
"description": "If set, rewrite URLs to load pages as static HTML files,\nso no TEI Publisher instance is required. Use this in combination with\n[tei-publisher-static](https://github.com/eeditiones/tei-publisher-static).\nThe value should point to the HTTP root path under which the static version\nwill be hosted. This is used to resolve CSS stylesheets.",
|
|
10875
|
+
"description": "If set, rewrite URLs to load pages as static HTML files,\r\nso no TEI Publisher instance is required. Use this in combination with\r\n[tei-publisher-static](https://github.com/eeditiones/tei-publisher-static).\r\nThe value should point to the HTTP root path under which the static version\r\nwill be hosted. This is used to resolve CSS stylesheets.",
|
|
10876
10876
|
"type": "string"
|
|
10877
10877
|
},
|
|
10878
10878
|
{
|
|
@@ -10897,7 +10897,7 @@
|
|
|
10897
10897
|
},
|
|
10898
10898
|
{
|
|
10899
10899
|
"name": "wait-for",
|
|
10900
|
-
"description": "A selector pointing to other components this component depends on.\nWhen method `wait` is called, it will wait until all referenced\ncomponents signal with a `pb-ready` event that they are ready and listening\nto events.\n\n`pb-view` by default sets this property to select `pb-toggle-feature` and `pb-select-feature` \nelements.",
|
|
10900
|
+
"description": "A selector pointing to other components this component depends on.\r\nWhen method `wait` is called, it will wait until all referenced\r\ncomponents signal with a `pb-ready` event that they are ready and listening\r\nto events.\r\n\r\n`pb-view` by default sets this property to select `pb-toggle-feature` and `pb-select-feature` \r\nelements.",
|
|
10901
10901
|
"type": "string"
|
|
10902
10902
|
},
|
|
10903
10903
|
{
|
|
@@ -10935,49 +10935,49 @@
|
|
|
10935
10935
|
{
|
|
10936
10936
|
"name": "odd",
|
|
10937
10937
|
"attribute": "odd",
|
|
10938
|
-
"description": "The ODD to use for rendering the document. Overwrites an ODD defined on\n`pb-document`. The odd should be specified by its name without path\nor the `.odd` suffix.",
|
|
10938
|
+
"description": "The ODD to use for rendering the document. Overwrites an ODD defined on\r\n`pb-document`. The odd should be specified by its name without path\r\nor the `.odd` suffix.",
|
|
10939
10939
|
"type": "string"
|
|
10940
10940
|
},
|
|
10941
10941
|
{
|
|
10942
10942
|
"name": "view",
|
|
10943
10943
|
"attribute": "view",
|
|
10944
|
-
"description": "The view type to use for paginating the document. Either `page`, `div` or `single`.\nOverwrites the same property specified on `pb-document`. Values have the following meaning:\n\nValue | Displayed content\n------|------------------\n`page` | content is displayed page by page as determined by tei:pb\n`div` | content is displayed by divisions\n`single` | do not paginate but display entire content at once",
|
|
10944
|
+
"description": "The view type to use for paginating the document. Either `page`, `div` or `single`.\r\nOverwrites the same property specified on `pb-document`. Values have the following meaning:\r\n\r\nValue | Displayed content\r\n------|------------------\r\n`page` | content is displayed page by page as determined by tei:pb\r\n`div` | content is displayed by divisions\r\n`single` | do not paginate but display entire content at once",
|
|
10945
10945
|
"type": "string"
|
|
10946
10946
|
},
|
|
10947
10947
|
{
|
|
10948
10948
|
"name": "nodeId",
|
|
10949
10949
|
"attribute": "node-id",
|
|
10950
|
-
"description": "An eXist nodeId. If specified, selects the root of the fragment of the document\nwhich should be displayed. Normally this property is set automatically by pagination.",
|
|
10950
|
+
"description": "An eXist nodeId. If specified, selects the root of the fragment of the document\r\nwhich should be displayed. Normally this property is set automatically by pagination.",
|
|
10951
10951
|
"type": "string"
|
|
10952
10952
|
},
|
|
10953
10953
|
{
|
|
10954
10954
|
"name": "xmlId",
|
|
10955
10955
|
"attribute": "xml-id",
|
|
10956
|
-
"description": "An xml:id to be displayed. If specified, this determines the root of the fragment to be\ndisplayed. Use to directly navigate to a specific section.",
|
|
10956
|
+
"description": "An xml:id to be displayed. If specified, this determines the root of the fragment to be\r\ndisplayed. Use to directly navigate to a specific section.",
|
|
10957
10957
|
"type": "array"
|
|
10958
10958
|
},
|
|
10959
10959
|
{
|
|
10960
10960
|
"name": "xpath",
|
|
10961
10961
|
"attribute": "xpath",
|
|
10962
|
-
"description": "An optional XPath expression: the root of the fragment to be processed is determined\nby evaluating the given XPath expression. The XPath expression should be absolute.\nThe namespace of the document is declared as default namespace, so no prefixes should\nbe used.\n\nIf the `map` property is used, it may change scope for the displayed fragment.",
|
|
10962
|
+
"description": "An optional XPath expression: the root of the fragment to be processed is determined\r\nby evaluating the given XPath expression. The XPath expression should be absolute.\r\nThe namespace of the document is declared as default namespace, so no prefixes should\r\nbe used.\r\n\r\nIf the `map` property is used, it may change scope for the displayed fragment.",
|
|
10963
10963
|
"type": "string"
|
|
10964
10964
|
},
|
|
10965
10965
|
{
|
|
10966
10966
|
"name": "map",
|
|
10967
10967
|
"attribute": "map",
|
|
10968
|
-
"description": "If defined denotes the local name of an XQuery function in `modules/map.xql`, which will be called\nwith the current root node and should return the node of a mapped fragment. This is helpful if one\nwants, for example, to show a translation fragment aligned with the part of the transcription currently\nshown. In this case, the properties of the `pb-view` would still point to the transcription, but the function\nidentified by map would return the corresponding fragment from the translation to be processed.\n\nNavigation in the document is still determined by the current root as defined through the `root`, `xpath`\nand `xmlId` properties.",
|
|
10968
|
+
"description": "If defined denotes the local name of an XQuery function in `modules/map.xql`, which will be called\r\nwith the current root node and should return the node of a mapped fragment. This is helpful if one\r\nwants, for example, to show a translation fragment aligned with the part of the transcription currently\r\nshown. In this case, the properties of the `pb-view` would still point to the transcription, but the function\r\nidentified by map would return the corresponding fragment from the translation to be processed.\r\n\r\nNavigation in the document is still determined by the current root as defined through the `root`, `xpath`\r\nand `xmlId` properties.",
|
|
10969
10969
|
"type": "string"
|
|
10970
10970
|
},
|
|
10971
10971
|
{
|
|
10972
10972
|
"name": "columnSeparator",
|
|
10973
10973
|
"attribute": "column-separator",
|
|
10974
|
-
"description": "CSS selector to find column breaks in the content returned\nfrom the server. If this property is set and column breaks\nare found, the component will display two columns side by side.",
|
|
10974
|
+
"description": "CSS selector to find column breaks in the content returned\r\nfrom the server. If this property is set and column breaks\r\nare found, the component will display two columns side by side.",
|
|
10975
10975
|
"type": "string"
|
|
10976
10976
|
},
|
|
10977
10977
|
{
|
|
10978
10978
|
"name": "loadCss",
|
|
10979
10979
|
"attribute": "load-css",
|
|
10980
|
-
"description": "If set, points to an external stylesheet which should be applied to\nthe text *after* the ODD-generated styles.",
|
|
10980
|
+
"description": "If set, points to an external stylesheet which should be applied to\r\nthe text *after* the ODD-generated styles.",
|
|
10981
10981
|
"type": "string"
|
|
10982
10982
|
},
|
|
10983
10983
|
{
|
|
@@ -10989,19 +10989,19 @@
|
|
|
10989
10989
|
{
|
|
10990
10990
|
"name": "useLanguage",
|
|
10991
10991
|
"attribute": "use-language",
|
|
10992
|
-
"description": "If set, a refresh will be triggered if a `pb-i18n-update` event is received,\ne.g. due to the user selecting a different interface language.\n\nAlso requires `requireLanguage` to be set on the surrounding `pb-page`.\nSee there for more information.",
|
|
10992
|
+
"description": "If set, a refresh will be triggered if a `pb-i18n-update` event is received,\r\ne.g. due to the user selecting a different interface language.\r\n\r\nAlso requires `requireLanguage` to be set on the surrounding `pb-page`.\r\nSee there for more information.",
|
|
10993
10993
|
"type": "boolean"
|
|
10994
10994
|
},
|
|
10995
10995
|
{
|
|
10996
10996
|
"name": "infiniteScroll",
|
|
10997
10997
|
"attribute": "infinite-scroll",
|
|
10998
|
-
"description": "Experimental: if enabled, the view will incrementally load new document fragments if the user tries to scroll\nbeyond the start or end of the visible text. The feature inserts a small blank section at the top\nand bottom. If this section becomes visible, a load operation will be triggered.\n\nNote: only browsers implementing the `IntersectionObserver` API are supported. Also the feature\ndoes not work in two-column mode or with animations.",
|
|
10998
|
+
"description": "Experimental: if enabled, the view will incrementally load new document fragments if the user tries to scroll\r\nbeyond the start or end of the visible text. The feature inserts a small blank section at the top\r\nand bottom. If this section becomes visible, a load operation will be triggered.\r\n\r\nNote: only browsers implementing the `IntersectionObserver` API are supported. Also the feature\r\ndoes not work in two-column mode or with animations.",
|
|
10999
10999
|
"type": "boolean"
|
|
11000
11000
|
},
|
|
11001
11001
|
{
|
|
11002
11002
|
"name": "src",
|
|
11003
11003
|
"attribute": "src",
|
|
11004
|
-
"description": "The id of a `pb-document` element this view should display.\nSettings like `odd` or `view` will be taken from the `pb-document`\nunless overwritten by properties in this component.\n\nThis property is **required** and **must** point to an existing `pb-document` with\nthe given id.\n\nSetting the property after initialization will clear the properties xmlId, nodeId and odd.",
|
|
11004
|
+
"description": "The id of a `pb-document` element this view should display.\r\nSettings like `odd` or `view` will be taken from the `pb-document`\r\nunless overwritten by properties in this component.\r\n\r\nThis property is **required** and **must** point to an existing `pb-document` with\r\nthe given id.\r\n\r\nSetting the property after initialization will clear the properties xmlId, nodeId and odd.",
|
|
11005
11005
|
"type": "string"
|
|
11006
11006
|
},
|
|
11007
11007
|
{
|
|
@@ -11013,28 +11013,28 @@
|
|
|
11013
11013
|
{
|
|
11014
11014
|
"name": "onUpdate",
|
|
11015
11015
|
"attribute": "on-update",
|
|
11016
|
-
"description": "If set to true, the component will not load automatically. Instead it will wait until it receives a `pb-update`\nevent. Use this to make one `pb-view` component dependent on another one. Default is 'false'.",
|
|
11016
|
+
"description": "If set to true, the component will not load automatically. Instead it will wait until it receives a `pb-update`\r\nevent. Use this to make one `pb-view` component dependent on another one. Default is 'false'.",
|
|
11017
11017
|
"type": "boolean",
|
|
11018
11018
|
"default": "false"
|
|
11019
11019
|
},
|
|
11020
11020
|
{
|
|
11021
11021
|
"name": "appendFootnotes",
|
|
11022
11022
|
"attribute": "append-footnotes",
|
|
11023
|
-
"description": "The server returns footnotes separately. Set this property\nif you wish to append them to the main text.",
|
|
11023
|
+
"description": "The server returns footnotes separately. Set this property\r\nif you wish to append them to the main text.",
|
|
11024
11024
|
"type": "boolean",
|
|
11025
11025
|
"default": "false"
|
|
11026
11026
|
},
|
|
11027
11027
|
{
|
|
11028
11028
|
"name": "notFound",
|
|
11029
11029
|
"attribute": "not-found",
|
|
11030
|
-
"description": "Message to display if no content was returned by the server.\nSet to empty string to show nothing.",
|
|
11030
|
+
"description": "Message to display if no content was returned by the server.\r\nSet to empty string to show nothing.",
|
|
11031
11031
|
"type": "string",
|
|
11032
11032
|
"default": "\"the server did not return any content\""
|
|
11033
11033
|
},
|
|
11034
11034
|
{
|
|
11035
11035
|
"name": "animation",
|
|
11036
11036
|
"attribute": "animation",
|
|
11037
|
-
"description": "wether to animate the view when new page is loaded. Defaults to 'false' meaning that no\nanimation takes place. If 'true' will apply a translateX transistion in forward/backward direction.",
|
|
11037
|
+
"description": "wether to animate the view when new page is loaded. Defaults to 'false' meaning that no\r\nanimation takes place. If 'true' will apply a translateX transistion in forward/backward direction.",
|
|
11038
11038
|
"type": "boolean",
|
|
11039
11039
|
"default": "false"
|
|
11040
11040
|
},
|
|
@@ -11060,34 +11060,34 @@
|
|
|
11060
11060
|
{
|
|
11061
11061
|
"name": "infiniteScrollMax",
|
|
11062
11062
|
"attribute": "infinite-scroll-max",
|
|
11063
|
-
"description": "Maximum number of fragments to keep in memory if `infinite-scroll`\nis enabled. If the user is scrolling beyond the maximum, fragements\nwill be removed from the DOM before or after the current reading position.\nDefault is 10. Set to zero to allow loading the entire document.",
|
|
11063
|
+
"description": "Maximum number of fragments to keep in memory if `infinite-scroll`\r\nis enabled. If the user is scrolling beyond the maximum, fragements\r\nwill be removed from the DOM before or after the current reading position.\r\nDefault is 10. Set to zero to allow loading the entire document.",
|
|
11064
11064
|
"type": "number",
|
|
11065
11065
|
"default": "10"
|
|
11066
11066
|
},
|
|
11067
11067
|
{
|
|
11068
11068
|
"name": "disableHistory",
|
|
11069
11069
|
"attribute": "disable-history",
|
|
11070
|
-
"description": "By default, navigating to next/previous page will update browser parameters,\nso reloading the page will load the correct position within the document.\n\nSet this property to disable location tracking for the component altogether.",
|
|
11070
|
+
"description": "By default, navigating to next/previous page will update browser parameters,\r\nso reloading the page will load the correct position within the document.\r\n\r\nSet this property to disable location tracking for the component altogether.",
|
|
11071
11071
|
"type": "boolean",
|
|
11072
11072
|
"default": "false"
|
|
11073
11073
|
},
|
|
11074
11074
|
{
|
|
11075
11075
|
"name": "beforeUpdate",
|
|
11076
11076
|
"attribute": "before-update-event",
|
|
11077
|
-
"description": "If set to the name of an event, the content of the pb-view will not be replaced\nimmediately upon updates. Instead, an event is emitted, which contains the new content\nin property `root`. An event handler intercepting the event can thus modify the content.\nOnce it is done, it should pass the modified content to the callback function provided\nin the event detail under the name `render`. See the demo for an example.",
|
|
11077
|
+
"description": "If set to the name of an event, the content of the pb-view will not be replaced\r\nimmediately upon updates. Instead, an event is emitted, which contains the new content\r\nin property `root`. An event handler intercepting the event can thus modify the content.\r\nOnce it is done, it should pass the modified content to the callback function provided\r\nin the event detail under the name `render`. See the demo for an example.",
|
|
11078
11078
|
"type": "string"
|
|
11079
11079
|
},
|
|
11080
11080
|
{
|
|
11081
11081
|
"name": "noScroll",
|
|
11082
11082
|
"attribute": "no-scroll",
|
|
11083
|
-
"description": "If set, do not scroll the view to target node (e.g. given in URL hash) \nafter content was loaded.",
|
|
11083
|
+
"description": "If set, do not scroll the view to target node (e.g. given in URL hash) \r\nafter content was loaded.",
|
|
11084
11084
|
"type": "boolean",
|
|
11085
11085
|
"default": "false"
|
|
11086
11086
|
},
|
|
11087
11087
|
{
|
|
11088
11088
|
"name": "static",
|
|
11089
11089
|
"attribute": "static",
|
|
11090
|
-
"description": "If set, rewrite URLs to load pages as static HTML files,\nso no TEI Publisher instance is required. Use this in combination with\n[tei-publisher-static](https://github.com/eeditiones/tei-publisher-static).\nThe value should point to the HTTP root path under which the static version\nwill be hosted. This is used to resolve CSS stylesheets.",
|
|
11090
|
+
"description": "If set, rewrite URLs to load pages as static HTML files,\r\nso no TEI Publisher instance is required. Use this in combination with\r\n[tei-publisher-static](https://github.com/eeditiones/tei-publisher-static).\r\nThe value should point to the HTTP root path under which the static version\r\nwill be hosted. This is used to resolve CSS stylesheets.",
|
|
11091
11091
|
"type": "string"
|
|
11092
11092
|
},
|
|
11093
11093
|
{
|
|
@@ -11117,7 +11117,7 @@
|
|
|
11117
11117
|
{
|
|
11118
11118
|
"name": "waitFor",
|
|
11119
11119
|
"attribute": "wait-for",
|
|
11120
|
-
"description": "A selector pointing to other components this component depends on.\nWhen method `wait` is called, it will wait until all referenced\ncomponents signal with a `pb-ready` event that they are ready and listening\nto events.\n\n`pb-view` by default sets this property to select `pb-toggle-feature` and `pb-select-feature` \nelements.",
|
|
11120
|
+
"description": "A selector pointing to other components this component depends on.\r\nWhen method `wait` is called, it will wait until all referenced\r\ncomponents signal with a `pb-ready` event that they are ready and listening\r\nto events.\r\n\r\n`pb-view` by default sets this property to select `pb-toggle-feature` and `pb-select-feature` \r\nelements.",
|
|
11121
11121
|
"type": "string"
|
|
11122
11122
|
},
|
|
11123
11123
|
{
|
|
@@ -11230,46 +11230,46 @@
|
|
|
11230
11230
|
{
|
|
11231
11231
|
"name": "pb-view",
|
|
11232
11232
|
"path": "./src/pb-view.js",
|
|
11233
|
-
"description": "This is the main component for viewing text which has been transformed via an ODD.\nThe document to be viewed is determined by the `pb-document` element the property\n`src` points to. If not overwritten, `pb-view` will use the settings defined by\nthe connected document, like view type, ODD etc.\n\n`pb-view` can display an entire document or just a fragment of it\nas defined by the properties `xpath`, `xmlId` or `nodeId`. The most common use case\nis to set `xpath` to point to a specific part of a document.\n\nNavigating to the next or previous fragment would usually be triggered by a separate\n`pb-navigation` element, which sends a `pb-navigate` event to the `pb-view`. However,\n`pb-view` also implements automatic loading of next/previous fragments if the user\nscrolls the page beyond the current viewport boudaries. To enable this, set property\n`infinite-scroll`.\n\nYou may also define optional parameters to be passed to the ODD in nested `pb-param`\ntags. These parameters can be accessed within the ODD via the `$parameters` map. For\nexample, the following snippet is being used to output breadcrumbs above the main text\nin the documentation view:\n\n```xml\n<section class=\"breadcrumbs\">\n <pb-view id=\"title-view1\" src=\"document1\" subscribe=\"transcription\">\n <pb-param name=\"mode\" value=\"breadcrumbs\"/>\n </pb-view>\n</section>\n```",
|
|
11233
|
+
"description": "This is the main component for viewing text which has been transformed via an ODD.\r\nThe document to be viewed is determined by the `pb-document` element the property\r\n`src` points to. If not overwritten, `pb-view` will use the settings defined by\r\nthe connected document, like view type, ODD etc.\r\n\r\n`pb-view` can display an entire document or just a fragment of it\r\nas defined by the properties `xpath`, `xmlId` or `nodeId`. The most common use case\r\nis to set `xpath` to point to a specific part of a document.\r\n\r\nNavigating to the next or previous fragment would usually be triggered by a separate\r\n`pb-navigation` element, which sends a `pb-navigate` event to the `pb-view`. However,\r\n`pb-view` also implements automatic loading of next/previous fragments if the user\r\nscrolls the page beyond the current viewport boudaries. To enable this, set property\r\n`infinite-scroll`.\r\n\r\nYou may also define optional parameters to be passed to the ODD in nested `pb-param`\r\ntags. These parameters can be accessed within the ODD via the `$parameters` map. For\r\nexample, the following snippet is being used to output breadcrumbs above the main text\r\nin the documentation view:\r\n\r\n```xml\r\n<section class=\"breadcrumbs\">\r\n <pb-view id=\"title-view1\" src=\"document1\" subscribe=\"transcription\">\r\n <pb-param name=\"mode\" value=\"breadcrumbs\"/>\r\n </pb-view>\r\n</section>\r\n```",
|
|
11234
11234
|
"attributes": [
|
|
11235
11235
|
{
|
|
11236
11236
|
"name": "odd",
|
|
11237
|
-
"description": "The ODD to use for rendering the document. Overwrites an ODD defined on\n`pb-document`. The odd should be specified by its name without path\nor the `.odd` suffix.",
|
|
11237
|
+
"description": "The ODD to use for rendering the document. Overwrites an ODD defined on\r\n`pb-document`. The odd should be specified by its name without path\r\nor the `.odd` suffix.",
|
|
11238
11238
|
"type": "string"
|
|
11239
11239
|
},
|
|
11240
11240
|
{
|
|
11241
11241
|
"name": "view",
|
|
11242
|
-
"description": "The view type to use for paginating the document. Either `page`, `div` or `single`.\nOverwrites the same property specified on `pb-document`. Values have the following meaning:\n\nValue | Displayed content\n------|------------------\n`page` | content is displayed page by page as determined by tei:pb\n`div` | content is displayed by divisions\n`single` | do not paginate but display entire content at once",
|
|
11242
|
+
"description": "The view type to use for paginating the document. Either `page`, `div` or `single`.\r\nOverwrites the same property specified on `pb-document`. Values have the following meaning:\r\n\r\nValue | Displayed content\r\n------|------------------\r\n`page` | content is displayed page by page as determined by tei:pb\r\n`div` | content is displayed by divisions\r\n`single` | do not paginate but display entire content at once",
|
|
11243
11243
|
"type": "string"
|
|
11244
11244
|
},
|
|
11245
11245
|
{
|
|
11246
11246
|
"name": "node-id",
|
|
11247
|
-
"description": "An eXist nodeId. If specified, selects the root of the fragment of the document\nwhich should be displayed. Normally this property is set automatically by pagination.",
|
|
11247
|
+
"description": "An eXist nodeId. If specified, selects the root of the fragment of the document\r\nwhich should be displayed. Normally this property is set automatically by pagination.",
|
|
11248
11248
|
"type": "string"
|
|
11249
11249
|
},
|
|
11250
11250
|
{
|
|
11251
11251
|
"name": "xml-id",
|
|
11252
|
-
"description": "An xml:id to be displayed. If specified, this determines the root of the fragment to be\ndisplayed. Use to directly navigate to a specific section.",
|
|
11252
|
+
"description": "An xml:id to be displayed. If specified, this determines the root of the fragment to be\r\ndisplayed. Use to directly navigate to a specific section.",
|
|
11253
11253
|
"type": "array"
|
|
11254
11254
|
},
|
|
11255
11255
|
{
|
|
11256
11256
|
"name": "xpath",
|
|
11257
|
-
"description": "An optional XPath expression: the root of the fragment to be processed is determined\nby evaluating the given XPath expression. The XPath expression should be absolute.\nThe namespace of the document is declared as default namespace, so no prefixes should\nbe used.\n\nIf the `map` property is used, it may change scope for the displayed fragment.",
|
|
11257
|
+
"description": "An optional XPath expression: the root of the fragment to be processed is determined\r\nby evaluating the given XPath expression. The XPath expression should be absolute.\r\nThe namespace of the document is declared as default namespace, so no prefixes should\r\nbe used.\r\n\r\nIf the `map` property is used, it may change scope for the displayed fragment.",
|
|
11258
11258
|
"type": "string"
|
|
11259
11259
|
},
|
|
11260
11260
|
{
|
|
11261
11261
|
"name": "map",
|
|
11262
|
-
"description": "If defined denotes the local name of an XQuery function in `modules/map.xql`, which will be called\nwith the current root node and should return the node of a mapped fragment. This is helpful if one\nwants, for example, to show a translation fragment aligned with the part of the transcription currently\nshown. In this case, the properties of the `pb-view` would still point to the transcription, but the function\nidentified by map would return the corresponding fragment from the translation to be processed.\n\nNavigation in the document is still determined by the current root as defined through the `root`, `xpath`\nand `xmlId` properties.",
|
|
11262
|
+
"description": "If defined denotes the local name of an XQuery function in `modules/map.xql`, which will be called\r\nwith the current root node and should return the node of a mapped fragment. This is helpful if one\r\nwants, for example, to show a translation fragment aligned with the part of the transcription currently\r\nshown. In this case, the properties of the `pb-view` would still point to the transcription, but the function\r\nidentified by map would return the corresponding fragment from the translation to be processed.\r\n\r\nNavigation in the document is still determined by the current root as defined through the `root`, `xpath`\r\nand `xmlId` properties.",
|
|
11263
11263
|
"type": "string"
|
|
11264
11264
|
},
|
|
11265
11265
|
{
|
|
11266
11266
|
"name": "column-separator",
|
|
11267
|
-
"description": "CSS selector to find column breaks in the content returned\nfrom the server. If this property is set and column breaks\nare found, the component will display two columns side by side.",
|
|
11267
|
+
"description": "CSS selector to find column breaks in the content returned\r\nfrom the server. If this property is set and column breaks\r\nare found, the component will display two columns side by side.",
|
|
11268
11268
|
"type": "string"
|
|
11269
11269
|
},
|
|
11270
11270
|
{
|
|
11271
11271
|
"name": "load-css",
|
|
11272
|
-
"description": "If set, points to an external stylesheet which should be applied to\nthe text *after* the ODD-generated styles.",
|
|
11272
|
+
"description": "If set, points to an external stylesheet which should be applied to\r\nthe text *after* the ODD-generated styles.",
|
|
11273
11273
|
"type": "string"
|
|
11274
11274
|
},
|
|
11275
11275
|
{
|
|
@@ -11279,17 +11279,17 @@
|
|
|
11279
11279
|
},
|
|
11280
11280
|
{
|
|
11281
11281
|
"name": "use-language",
|
|
11282
|
-
"description": "If set, a refresh will be triggered if a `pb-i18n-update` event is received,\ne.g. due to the user selecting a different interface language.\n\nAlso requires `requireLanguage` to be set on the surrounding `pb-page`.\nSee there for more information.",
|
|
11282
|
+
"description": "If set, a refresh will be triggered if a `pb-i18n-update` event is received,\r\ne.g. due to the user selecting a different interface language.\r\n\r\nAlso requires `requireLanguage` to be set on the surrounding `pb-page`.\r\nSee there for more information.",
|
|
11283
11283
|
"type": "boolean"
|
|
11284
11284
|
},
|
|
11285
11285
|
{
|
|
11286
11286
|
"name": "infinite-scroll",
|
|
11287
|
-
"description": "Experimental: if enabled, the view will incrementally load new document fragments if the user tries to scroll\nbeyond the start or end of the visible text. The feature inserts a small blank section at the top\nand bottom. If this section becomes visible, a load operation will be triggered.\n\nNote: only browsers implementing the `IntersectionObserver` API are supported. Also the feature\ndoes not work in two-column mode or with animations.",
|
|
11287
|
+
"description": "Experimental: if enabled, the view will incrementally load new document fragments if the user tries to scroll\r\nbeyond the start or end of the visible text. The feature inserts a small blank section at the top\r\nand bottom. If this section becomes visible, a load operation will be triggered.\r\n\r\nNote: only browsers implementing the `IntersectionObserver` API are supported. Also the feature\r\ndoes not work in two-column mode or with animations.",
|
|
11288
11288
|
"type": "boolean"
|
|
11289
11289
|
},
|
|
11290
11290
|
{
|
|
11291
11291
|
"name": "src",
|
|
11292
|
-
"description": "The id of a `pb-document` element this view should display.\nSettings like `odd` or `view` will be taken from the `pb-document`\nunless overwritten by properties in this component.\n\nThis property is **required** and **must** point to an existing `pb-document` with\nthe given id.\n\nSetting the property after initialization will clear the properties xmlId, nodeId and odd.",
|
|
11292
|
+
"description": "The id of a `pb-document` element this view should display.\r\nSettings like `odd` or `view` will be taken from the `pb-document`\r\nunless overwritten by properties in this component.\r\n\r\nThis property is **required** and **must** point to an existing `pb-document` with\r\nthe given id.\r\n\r\nSetting the property after initialization will clear the properties xmlId, nodeId and odd.",
|
|
11293
11293
|
"type": "string"
|
|
11294
11294
|
},
|
|
11295
11295
|
{
|
|
@@ -11299,25 +11299,25 @@
|
|
|
11299
11299
|
},
|
|
11300
11300
|
{
|
|
11301
11301
|
"name": "on-update",
|
|
11302
|
-
"description": "If set to true, the component will not load automatically. Instead it will wait until it receives a `pb-update`\nevent. Use this to make one `pb-view` component dependent on another one. Default is 'false'.",
|
|
11302
|
+
"description": "If set to true, the component will not load automatically. Instead it will wait until it receives a `pb-update`\r\nevent. Use this to make one `pb-view` component dependent on another one. Default is 'false'.",
|
|
11303
11303
|
"type": "boolean",
|
|
11304
11304
|
"default": "false"
|
|
11305
11305
|
},
|
|
11306
11306
|
{
|
|
11307
11307
|
"name": "append-footnotes",
|
|
11308
|
-
"description": "The server returns footnotes separately. Set this property\nif you wish to append them to the main text.",
|
|
11308
|
+
"description": "The server returns footnotes separately. Set this property\r\nif you wish to append them to the main text.",
|
|
11309
11309
|
"type": "boolean",
|
|
11310
11310
|
"default": "false"
|
|
11311
11311
|
},
|
|
11312
11312
|
{
|
|
11313
11313
|
"name": "not-found",
|
|
11314
|
-
"description": "Message to display if no content was returned by the server.\nSet to empty string to show nothing.",
|
|
11314
|
+
"description": "Message to display if no content was returned by the server.\r\nSet to empty string to show nothing.",
|
|
11315
11315
|
"type": "string",
|
|
11316
11316
|
"default": "\"the server did not return any content\""
|
|
11317
11317
|
},
|
|
11318
11318
|
{
|
|
11319
11319
|
"name": "animation",
|
|
11320
|
-
"description": "wether to animate the view when new page is loaded. Defaults to 'false' meaning that no\nanimation takes place. If 'true' will apply a translateX transistion in forward/backward direction.",
|
|
11320
|
+
"description": "wether to animate the view when new page is loaded. Defaults to 'false' meaning that no\r\nanimation takes place. If 'true' will apply a translateX transistion in forward/backward direction.",
|
|
11321
11321
|
"type": "boolean",
|
|
11322
11322
|
"default": "false"
|
|
11323
11323
|
},
|
|
@@ -11335,30 +11335,30 @@
|
|
|
11335
11335
|
},
|
|
11336
11336
|
{
|
|
11337
11337
|
"name": "infinite-scroll-max",
|
|
11338
|
-
"description": "Maximum number of fragments to keep in memory if `infinite-scroll`\nis enabled. If the user is scrolling beyond the maximum, fragements\nwill be removed from the DOM before or after the current reading position.\nDefault is 10. Set to zero to allow loading the entire document.",
|
|
11338
|
+
"description": "Maximum number of fragments to keep in memory if `infinite-scroll`\r\nis enabled. If the user is scrolling beyond the maximum, fragements\r\nwill be removed from the DOM before or after the current reading position.\r\nDefault is 10. Set to zero to allow loading the entire document.",
|
|
11339
11339
|
"type": "number",
|
|
11340
11340
|
"default": "10"
|
|
11341
11341
|
},
|
|
11342
11342
|
{
|
|
11343
11343
|
"name": "disable-history",
|
|
11344
|
-
"description": "By default, navigating to next/previous page will update browser parameters,\nso reloading the page will load the correct position within the document.\n\nSet this property to disable location tracking for the component altogether.",
|
|
11344
|
+
"description": "By default, navigating to next/previous page will update browser parameters,\r\nso reloading the page will load the correct position within the document.\r\n\r\nSet this property to disable location tracking for the component altogether.",
|
|
11345
11345
|
"type": "boolean",
|
|
11346
11346
|
"default": "false"
|
|
11347
11347
|
},
|
|
11348
11348
|
{
|
|
11349
11349
|
"name": "before-update-event",
|
|
11350
|
-
"description": "If set to the name of an event, the content of the pb-view will not be replaced\nimmediately upon updates. Instead, an event is emitted, which contains the new content\nin property `root`. An event handler intercepting the event can thus modify the content.\nOnce it is done, it should pass the modified content to the callback function provided\nin the event detail under the name `render`. See the demo for an example.",
|
|
11350
|
+
"description": "If set to the name of an event, the content of the pb-view will not be replaced\r\nimmediately upon updates. Instead, an event is emitted, which contains the new content\r\nin property `root`. An event handler intercepting the event can thus modify the content.\r\nOnce it is done, it should pass the modified content to the callback function provided\r\nin the event detail under the name `render`. See the demo for an example.",
|
|
11351
11351
|
"type": "string"
|
|
11352
11352
|
},
|
|
11353
11353
|
{
|
|
11354
11354
|
"name": "no-scroll",
|
|
11355
|
-
"description": "If set, do not scroll the view to target node (e.g. given in URL hash) \nafter content was loaded.",
|
|
11355
|
+
"description": "If set, do not scroll the view to target node (e.g. given in URL hash) \r\nafter content was loaded.",
|
|
11356
11356
|
"type": "boolean",
|
|
11357
11357
|
"default": "false"
|
|
11358
11358
|
},
|
|
11359
11359
|
{
|
|
11360
11360
|
"name": "static",
|
|
11361
|
-
"description": "If set, rewrite URLs to load pages as static HTML files,\nso no TEI Publisher instance is required. Use this in combination with\n[tei-publisher-static](https://github.com/eeditiones/tei-publisher-static).\nThe value should point to the HTTP root path under which the static version\nwill be hosted. This is used to resolve CSS stylesheets.",
|
|
11361
|
+
"description": "If set, rewrite URLs to load pages as static HTML files,\r\nso no TEI Publisher instance is required. Use this in combination with\r\n[tei-publisher-static](https://github.com/eeditiones/tei-publisher-static).\r\nThe value should point to the HTTP root path under which the static version\r\nwill be hosted. This is used to resolve CSS stylesheets.",
|
|
11362
11362
|
"type": "string"
|
|
11363
11363
|
},
|
|
11364
11364
|
{
|
|
@@ -11383,7 +11383,7 @@
|
|
|
11383
11383
|
},
|
|
11384
11384
|
{
|
|
11385
11385
|
"name": "wait-for",
|
|
11386
|
-
"description": "A selector pointing to other components this component depends on.\nWhen method `wait` is called, it will wait until all referenced\ncomponents signal with a `pb-ready` event that they are ready and listening\nto events.\n\n`pb-view` by default sets this property to select `pb-toggle-feature` and `pb-select-feature` \nelements.",
|
|
11386
|
+
"description": "A selector pointing to other components this component depends on.\r\nWhen method `wait` is called, it will wait until all referenced\r\ncomponents signal with a `pb-ready` event that they are ready and listening\r\nto events.\r\n\r\n`pb-view` by default sets this property to select `pb-toggle-feature` and `pb-select-feature` \r\nelements.",
|
|
11387
11387
|
"type": "string"
|
|
11388
11388
|
},
|
|
11389
11389
|
{
|
|
@@ -11397,49 +11397,49 @@
|
|
|
11397
11397
|
{
|
|
11398
11398
|
"name": "odd",
|
|
11399
11399
|
"attribute": "odd",
|
|
11400
|
-
"description": "The ODD to use for rendering the document. Overwrites an ODD defined on\n`pb-document`. The odd should be specified by its name without path\nor the `.odd` suffix.",
|
|
11400
|
+
"description": "The ODD to use for rendering the document. Overwrites an ODD defined on\r\n`pb-document`. The odd should be specified by its name without path\r\nor the `.odd` suffix.",
|
|
11401
11401
|
"type": "string"
|
|
11402
11402
|
},
|
|
11403
11403
|
{
|
|
11404
11404
|
"name": "view",
|
|
11405
11405
|
"attribute": "view",
|
|
11406
|
-
"description": "The view type to use for paginating the document. Either `page`, `div` or `single`.\nOverwrites the same property specified on `pb-document`. Values have the following meaning:\n\nValue | Displayed content\n------|------------------\n`page` | content is displayed page by page as determined by tei:pb\n`div` | content is displayed by divisions\n`single` | do not paginate but display entire content at once",
|
|
11406
|
+
"description": "The view type to use for paginating the document. Either `page`, `div` or `single`.\r\nOverwrites the same property specified on `pb-document`. Values have the following meaning:\r\n\r\nValue | Displayed content\r\n------|------------------\r\n`page` | content is displayed page by page as determined by tei:pb\r\n`div` | content is displayed by divisions\r\n`single` | do not paginate but display entire content at once",
|
|
11407
11407
|
"type": "string"
|
|
11408
11408
|
},
|
|
11409
11409
|
{
|
|
11410
11410
|
"name": "nodeId",
|
|
11411
11411
|
"attribute": "node-id",
|
|
11412
|
-
"description": "An eXist nodeId. If specified, selects the root of the fragment of the document\nwhich should be displayed. Normally this property is set automatically by pagination.",
|
|
11412
|
+
"description": "An eXist nodeId. If specified, selects the root of the fragment of the document\r\nwhich should be displayed. Normally this property is set automatically by pagination.",
|
|
11413
11413
|
"type": "string"
|
|
11414
11414
|
},
|
|
11415
11415
|
{
|
|
11416
11416
|
"name": "xmlId",
|
|
11417
11417
|
"attribute": "xml-id",
|
|
11418
|
-
"description": "An xml:id to be displayed. If specified, this determines the root of the fragment to be\ndisplayed. Use to directly navigate to a specific section.",
|
|
11418
|
+
"description": "An xml:id to be displayed. If specified, this determines the root of the fragment to be\r\ndisplayed. Use to directly navigate to a specific section.",
|
|
11419
11419
|
"type": "array"
|
|
11420
11420
|
},
|
|
11421
11421
|
{
|
|
11422
11422
|
"name": "xpath",
|
|
11423
11423
|
"attribute": "xpath",
|
|
11424
|
-
"description": "An optional XPath expression: the root of the fragment to be processed is determined\nby evaluating the given XPath expression. The XPath expression should be absolute.\nThe namespace of the document is declared as default namespace, so no prefixes should\nbe used.\n\nIf the `map` property is used, it may change scope for the displayed fragment.",
|
|
11424
|
+
"description": "An optional XPath expression: the root of the fragment to be processed is determined\r\nby evaluating the given XPath expression. The XPath expression should be absolute.\r\nThe namespace of the document is declared as default namespace, so no prefixes should\r\nbe used.\r\n\r\nIf the `map` property is used, it may change scope for the displayed fragment.",
|
|
11425
11425
|
"type": "string"
|
|
11426
11426
|
},
|
|
11427
11427
|
{
|
|
11428
11428
|
"name": "map",
|
|
11429
11429
|
"attribute": "map",
|
|
11430
|
-
"description": "If defined denotes the local name of an XQuery function in `modules/map.xql`, which will be called\nwith the current root node and should return the node of a mapped fragment. This is helpful if one\nwants, for example, to show a translation fragment aligned with the part of the transcription currently\nshown. In this case, the properties of the `pb-view` would still point to the transcription, but the function\nidentified by map would return the corresponding fragment from the translation to be processed.\n\nNavigation in the document is still determined by the current root as defined through the `root`, `xpath`\nand `xmlId` properties.",
|
|
11430
|
+
"description": "If defined denotes the local name of an XQuery function in `modules/map.xql`, which will be called\r\nwith the current root node and should return the node of a mapped fragment. This is helpful if one\r\nwants, for example, to show a translation fragment aligned with the part of the transcription currently\r\nshown. In this case, the properties of the `pb-view` would still point to the transcription, but the function\r\nidentified by map would return the corresponding fragment from the translation to be processed.\r\n\r\nNavigation in the document is still determined by the current root as defined through the `root`, `xpath`\r\nand `xmlId` properties.",
|
|
11431
11431
|
"type": "string"
|
|
11432
11432
|
},
|
|
11433
11433
|
{
|
|
11434
11434
|
"name": "columnSeparator",
|
|
11435
11435
|
"attribute": "column-separator",
|
|
11436
|
-
"description": "CSS selector to find column breaks in the content returned\nfrom the server. If this property is set and column breaks\nare found, the component will display two columns side by side.",
|
|
11436
|
+
"description": "CSS selector to find column breaks in the content returned\r\nfrom the server. If this property is set and column breaks\r\nare found, the component will display two columns side by side.",
|
|
11437
11437
|
"type": "string"
|
|
11438
11438
|
},
|
|
11439
11439
|
{
|
|
11440
11440
|
"name": "loadCss",
|
|
11441
11441
|
"attribute": "load-css",
|
|
11442
|
-
"description": "If set, points to an external stylesheet which should be applied to\nthe text *after* the ODD-generated styles.",
|
|
11442
|
+
"description": "If set, points to an external stylesheet which should be applied to\r\nthe text *after* the ODD-generated styles.",
|
|
11443
11443
|
"type": "string"
|
|
11444
11444
|
},
|
|
11445
11445
|
{
|
|
@@ -11451,19 +11451,19 @@
|
|
|
11451
11451
|
{
|
|
11452
11452
|
"name": "useLanguage",
|
|
11453
11453
|
"attribute": "use-language",
|
|
11454
|
-
"description": "If set, a refresh will be triggered if a `pb-i18n-update` event is received,\ne.g. due to the user selecting a different interface language.\n\nAlso requires `requireLanguage` to be set on the surrounding `pb-page`.\nSee there for more information.",
|
|
11454
|
+
"description": "If set, a refresh will be triggered if a `pb-i18n-update` event is received,\r\ne.g. due to the user selecting a different interface language.\r\n\r\nAlso requires `requireLanguage` to be set on the surrounding `pb-page`.\r\nSee there for more information.",
|
|
11455
11455
|
"type": "boolean"
|
|
11456
11456
|
},
|
|
11457
11457
|
{
|
|
11458
11458
|
"name": "infiniteScroll",
|
|
11459
11459
|
"attribute": "infinite-scroll",
|
|
11460
|
-
"description": "Experimental: if enabled, the view will incrementally load new document fragments if the user tries to scroll\nbeyond the start or end of the visible text. The feature inserts a small blank section at the top\nand bottom. If this section becomes visible, a load operation will be triggered.\n\nNote: only browsers implementing the `IntersectionObserver` API are supported. Also the feature\ndoes not work in two-column mode or with animations.",
|
|
11460
|
+
"description": "Experimental: if enabled, the view will incrementally load new document fragments if the user tries to scroll\r\nbeyond the start or end of the visible text. The feature inserts a small blank section at the top\r\nand bottom. If this section becomes visible, a load operation will be triggered.\r\n\r\nNote: only browsers implementing the `IntersectionObserver` API are supported. Also the feature\r\ndoes not work in two-column mode or with animations.",
|
|
11461
11461
|
"type": "boolean"
|
|
11462
11462
|
},
|
|
11463
11463
|
{
|
|
11464
11464
|
"name": "src",
|
|
11465
11465
|
"attribute": "src",
|
|
11466
|
-
"description": "The id of a `pb-document` element this view should display.\nSettings like `odd` or `view` will be taken from the `pb-document`\nunless overwritten by properties in this component.\n\nThis property is **required** and **must** point to an existing `pb-document` with\nthe given id.\n\nSetting the property after initialization will clear the properties xmlId, nodeId and odd.",
|
|
11466
|
+
"description": "The id of a `pb-document` element this view should display.\r\nSettings like `odd` or `view` will be taken from the `pb-document`\r\nunless overwritten by properties in this component.\r\n\r\nThis property is **required** and **must** point to an existing `pb-document` with\r\nthe given id.\r\n\r\nSetting the property after initialization will clear the properties xmlId, nodeId and odd.",
|
|
11467
11467
|
"type": "string"
|
|
11468
11468
|
},
|
|
11469
11469
|
{
|
|
@@ -11475,28 +11475,28 @@
|
|
|
11475
11475
|
{
|
|
11476
11476
|
"name": "onUpdate",
|
|
11477
11477
|
"attribute": "on-update",
|
|
11478
|
-
"description": "If set to true, the component will not load automatically. Instead it will wait until it receives a `pb-update`\nevent. Use this to make one `pb-view` component dependent on another one. Default is 'false'.",
|
|
11478
|
+
"description": "If set to true, the component will not load automatically. Instead it will wait until it receives a `pb-update`\r\nevent. Use this to make one `pb-view` component dependent on another one. Default is 'false'.",
|
|
11479
11479
|
"type": "boolean",
|
|
11480
11480
|
"default": "false"
|
|
11481
11481
|
},
|
|
11482
11482
|
{
|
|
11483
11483
|
"name": "appendFootnotes",
|
|
11484
11484
|
"attribute": "append-footnotes",
|
|
11485
|
-
"description": "The server returns footnotes separately. Set this property\nif you wish to append them to the main text.",
|
|
11485
|
+
"description": "The server returns footnotes separately. Set this property\r\nif you wish to append them to the main text.",
|
|
11486
11486
|
"type": "boolean",
|
|
11487
11487
|
"default": "false"
|
|
11488
11488
|
},
|
|
11489
11489
|
{
|
|
11490
11490
|
"name": "notFound",
|
|
11491
11491
|
"attribute": "not-found",
|
|
11492
|
-
"description": "Message to display if no content was returned by the server.\nSet to empty string to show nothing.",
|
|
11492
|
+
"description": "Message to display if no content was returned by the server.\r\nSet to empty string to show nothing.",
|
|
11493
11493
|
"type": "string",
|
|
11494
11494
|
"default": "\"the server did not return any content\""
|
|
11495
11495
|
},
|
|
11496
11496
|
{
|
|
11497
11497
|
"name": "animation",
|
|
11498
11498
|
"attribute": "animation",
|
|
11499
|
-
"description": "wether to animate the view when new page is loaded. Defaults to 'false' meaning that no\nanimation takes place. If 'true' will apply a translateX transistion in forward/backward direction.",
|
|
11499
|
+
"description": "wether to animate the view when new page is loaded. Defaults to 'false' meaning that no\r\nanimation takes place. If 'true' will apply a translateX transistion in forward/backward direction.",
|
|
11500
11500
|
"type": "boolean",
|
|
11501
11501
|
"default": "false"
|
|
11502
11502
|
},
|
|
@@ -11522,34 +11522,34 @@
|
|
|
11522
11522
|
{
|
|
11523
11523
|
"name": "infiniteScrollMax",
|
|
11524
11524
|
"attribute": "infinite-scroll-max",
|
|
11525
|
-
"description": "Maximum number of fragments to keep in memory if `infinite-scroll`\nis enabled. If the user is scrolling beyond the maximum, fragements\nwill be removed from the DOM before or after the current reading position.\nDefault is 10. Set to zero to allow loading the entire document.",
|
|
11525
|
+
"description": "Maximum number of fragments to keep in memory if `infinite-scroll`\r\nis enabled. If the user is scrolling beyond the maximum, fragements\r\nwill be removed from the DOM before or after the current reading position.\r\nDefault is 10. Set to zero to allow loading the entire document.",
|
|
11526
11526
|
"type": "number",
|
|
11527
11527
|
"default": "10"
|
|
11528
11528
|
},
|
|
11529
11529
|
{
|
|
11530
11530
|
"name": "disableHistory",
|
|
11531
11531
|
"attribute": "disable-history",
|
|
11532
|
-
"description": "By default, navigating to next/previous page will update browser parameters,\nso reloading the page will load the correct position within the document.\n\nSet this property to disable location tracking for the component altogether.",
|
|
11532
|
+
"description": "By default, navigating to next/previous page will update browser parameters,\r\nso reloading the page will load the correct position within the document.\r\n\r\nSet this property to disable location tracking for the component altogether.",
|
|
11533
11533
|
"type": "boolean",
|
|
11534
11534
|
"default": "false"
|
|
11535
11535
|
},
|
|
11536
11536
|
{
|
|
11537
11537
|
"name": "beforeUpdate",
|
|
11538
11538
|
"attribute": "before-update-event",
|
|
11539
|
-
"description": "If set to the name of an event, the content of the pb-view will not be replaced\nimmediately upon updates. Instead, an event is emitted, which contains the new content\nin property `root`. An event handler intercepting the event can thus modify the content.\nOnce it is done, it should pass the modified content to the callback function provided\nin the event detail under the name `render`. See the demo for an example.",
|
|
11539
|
+
"description": "If set to the name of an event, the content of the pb-view will not be replaced\r\nimmediately upon updates. Instead, an event is emitted, which contains the new content\r\nin property `root`. An event handler intercepting the event can thus modify the content.\r\nOnce it is done, it should pass the modified content to the callback function provided\r\nin the event detail under the name `render`. See the demo for an example.",
|
|
11540
11540
|
"type": "string"
|
|
11541
11541
|
},
|
|
11542
11542
|
{
|
|
11543
11543
|
"name": "noScroll",
|
|
11544
11544
|
"attribute": "no-scroll",
|
|
11545
|
-
"description": "If set, do not scroll the view to target node (e.g. given in URL hash) \nafter content was loaded.",
|
|
11545
|
+
"description": "If set, do not scroll the view to target node (e.g. given in URL hash) \r\nafter content was loaded.",
|
|
11546
11546
|
"type": "boolean",
|
|
11547
11547
|
"default": "false"
|
|
11548
11548
|
},
|
|
11549
11549
|
{
|
|
11550
11550
|
"name": "static",
|
|
11551
11551
|
"attribute": "static",
|
|
11552
|
-
"description": "If set, rewrite URLs to load pages as static HTML files,\nso no TEI Publisher instance is required. Use this in combination with\n[tei-publisher-static](https://github.com/eeditiones/tei-publisher-static).\nThe value should point to the HTTP root path under which the static version\nwill be hosted. This is used to resolve CSS stylesheets.",
|
|
11552
|
+
"description": "If set, rewrite URLs to load pages as static HTML files,\r\nso no TEI Publisher instance is required. Use this in combination with\r\n[tei-publisher-static](https://github.com/eeditiones/tei-publisher-static).\r\nThe value should point to the HTTP root path under which the static version\r\nwill be hosted. This is used to resolve CSS stylesheets.",
|
|
11553
11553
|
"type": "string"
|
|
11554
11554
|
},
|
|
11555
11555
|
{
|
|
@@ -11579,7 +11579,7 @@
|
|
|
11579
11579
|
{
|
|
11580
11580
|
"name": "waitFor",
|
|
11581
11581
|
"attribute": "wait-for",
|
|
11582
|
-
"description": "A selector pointing to other components this component depends on.\nWhen method `wait` is called, it will wait until all referenced\ncomponents signal with a `pb-ready` event that they are ready and listening\nto events.\n\n`pb-view` by default sets this property to select `pb-toggle-feature` and `pb-select-feature` \nelements.",
|
|
11582
|
+
"description": "A selector pointing to other components this component depends on.\r\nWhen method `wait` is called, it will wait until all referenced\r\ncomponents signal with a `pb-ready` event that they are ready and listening\r\nto events.\r\n\r\n`pb-view` by default sets this property to select `pb-toggle-feature` and `pb-select-feature` \r\nelements.",
|
|
11583
11583
|
"type": "string"
|
|
11584
11584
|
},
|
|
11585
11585
|
{
|