Skip to content

Commit

Permalink
DOC-2368: additional improvements.
Browse files Browse the repository at this point in the history
  • Loading branch information
kemister85 committed Apr 11, 2024
1 parent 8025496 commit cd11eb9
Show file tree
Hide file tree
Showing 9 changed files with 48 additions and 43 deletions.
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
Plugin language files (such as `+./plugins/plugincode/langs/sv_SE.js+`) are required where the editor user interface is localized using the xref:ui-localization.adoc#language[language option]. Please refer to xref:bundling-plugins.adoc#plugin-language-files[plugin-language-files]
Plugin language files (such as `+./plugins/plugincode/langs/sv_SE.js+`) are required where the editor user interface is localized using the xref:ui-localization.adoc#language[language option].

The below plugins require these xref:bundling-plugins.adoc#plugin-language-files[plugin-language-files]

* Enhanced Tables (+advtable+)
* Accessibility Checker (+a11ychecker+)
* Enhanced Tables (+advtable+)
* Comments (+tinycomments+)
* ExportWord (+exportword+)
* Footnotes (+footnotes+)
Expand Down
41 changes: 37 additions & 4 deletions modules/ROOT/partials/module-loading/bundling-plugin-files.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -11,25 +11,53 @@ include::partial$plugin-files/plugin-file-bundling-message.adoc[]
include::partial$plugin-files/plugin-file-index.js.adoc[]

[NOTE]
====
include::partial$module-loading/admon-bundling-plugin-langs.adoc[]
====

[[accessibility-checker]]
'''

include::partial$plugin-files/plugin-file-bundling-also-requires.adoc[]

[[a11ychecker]]
=== Accessibility Checker (`+a11ychecker+`)

include::partial$plugin-files/plugin-file-list-a11ychecker.adoc[]

[[comments]]
[[tinycomments]]
=== Comments (`+tinycomments+`)

include::partial$plugin-files/plugin-file-list-tinycomments.adoc[]

[[advcode]]
=== Enhanced Code Editor (`+advcode+`)

include::partial$plugin-files/plugin-file-list-advcode.adoc[]

[[linkchecker]]
=== Link Checker (`+linkchecker+`)

include::partial$plugin-files/plugin-file-list-linkchecker.adoc[]

[[mediaembed]]
=== Media Embed (`+mediaembed+`)

include::partial$plugin-files/plugin-file-list-mediaembed.adoc[]

[[mentions]]
=== Mentions (`+mentions+`)

include::partial$plugin-files/plugin-file-list-mentions.adoc[]

[[pageembed]]
=== Pageembed (`+pageembed+`)

include::partial$plugin-files/plugin-file-list-pageembed.adoc[]

[[powerpaste]]
=== PowerPaste (`+powerpaste+`)

include::partial$plugin-files/plugin-file-list-powerpaste.adoc[]

'''

[[community-plugins]]
== Community plugins
Expand All @@ -38,11 +66,16 @@ include::partial$plugin-files/plugin-file-bundling-message.adoc[]

include::partial$plugin-files/plugin-file-index.js.adoc[]

'''

include::partial$plugin-files/plugin-file-bundling-also-requires.adoc[]

[[emoticons]]
=== Emoticons (`+emoticons+`)

include::partial$plugin-files/plugin-file-list-emoticons.adoc[]

'''

[[plugin-language-files]]
== Plugin language files
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
[TIP]
The below plugin/s also require the files outlined under each plugin section when bundling {productname} in addition to the xref:bundling-plugins.adoc#base-index-js-file[base `index.js`] file.
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@

[[base-index-js-file]]
.Base index.js required file for each plugin.
[source, js]
----
Expand Down
10 changes: 2 additions & 8 deletions modules/ROOT/partials/plugin-files/plugin-file-list-advcode.adoc
Original file line number Diff line number Diff line change
@@ -1,17 +1,11 @@
.Base js file
[source, js]
----
./plugins/advcode/plugin.js
----

.css or bundled css
.Requires css or bundled css
[source, js]
----
./plugins/advcode/codemirror.min.css //or
./plugins/advcode/codemirror_css.js // bundling requires v6.8.0 or later.
----

.other js files
.other js files required
[source, js]
----
./plugins/advcode/codemirror.min.js
Expand Down
Original file line number Diff line number Diff line change
@@ -1,10 +1,4 @@
.Base js file
[source, js]
----
./plugins/linkchecker/plugin.js
----

.css or bundled css
.Requires css or bundled css
[source, js]
----
./plugins/linkchecker/content.min.css //or
Expand Down
Original file line number Diff line number Diff line change
@@ -1,10 +1,4 @@
.Base js file
[source, js]
----
./plugins/mediaembed/plugin.js
----

.css or bundled css
.Requires css or bundled css
[source, js]
----
./plugins/mediaembed/content.min.css //or
Expand Down
Original file line number Diff line number Diff line change
@@ -1,10 +1,4 @@
.Base js file
[source, js]
----
./plugins/mentions/plugin.js
----

.css or bundled css
.Requries css or bundled css
[source, js]
----
./plugins/mentions/css/mentions.css //or
Expand Down
Original file line number Diff line number Diff line change
@@ -1,10 +1,4 @@
.Base js file
[source, js]
----
./plugins/pageembed/plugin.js
----

.css or bundled css
.Requires css or bundled css
[source, js]
----
./plugins/pageembed/css/empa30.css //or
Expand Down

0 comments on commit cd11eb9

Please sign in to comment.