Skip to content

Commit 7e8901f

Browse files
hamza0867lnewson
andauthored
feature(Plugins/Premium Plugins/Advanced Tables): Update docs for the… (#2299)
* feature(Plugins/Premium Plugins/Advanced Tables): Update docs for the advanced tables premium plugin page * Update modules/ROOT/partials/commands/advtable-cmds.adoc Co-authored-by: Lee Newson <[email protected]> * Update modules/ROOT/pages/plugins/premium/advtable.adoc Co-authored-by: Lee Newson <[email protected]> * revert change to display admonitions inside table * Update modules/ROOT/partials/toolbar-button-ids/advtable-toolbar-buttons.adoc Co-authored-by: Lee Newson <[email protected]> * Update modules/ROOT/partials/menu-item-ids/advtable-menu-items.adoc Co-authored-by: Lee Newson <[email protected]> Co-authored-by: Lee Newson <[email protected]>
1 parent 02cbda7 commit 7e8901f

File tree

4 files changed

+21
-13
lines changed

4 files changed

+21
-13
lines changed

modules/ROOT/pages/plugins/opensource/table.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -150,6 +150,7 @@ include::partial$misc/plugin-menu-item-id-boilerplate.adoc[]
150150
tinymce.activeEditor.plugins.table.insertTable(2, 3);
151151
----
152152

153+
[[events]]
153154
== Events
154155

155156
include::partial$events/table-events.adoc[]

modules/ROOT/pages/plugins/premium/advcode.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
:plugincode: advcode
99
include::partial$misc/premiumplugin.adoc[]
1010

11-
This plugin adds a toolbar button that allows a user to edit the HTML code using a more advanced link:{baseurl}/enterprise/advcode/[code editor] than the default textarea.
11+
This plugin adds a toolbar button that allows a user to edit the HTML code using a more advanced xref:enterprise/advcode.adoc[code editor] than the default textarea.
1212

1313
If you are using Advanced Code Editor `advcode` plugin, make sure you do not use Code (`code`) plugin.
1414

modules/ROOT/pages/plugins/premium/advtable.adoc

Lines changed: 13 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -6,12 +6,16 @@
66
:pluginname: Advanced Tables
77
:plugincode: advtable
88
:plugincategory: premium
9-
include::partial$misc/requires_5_1v.adoc[] +
9+
10+
include::partial$misc/requires_5_1v.adoc[]
11+
1012
include::partial$misc/premiumplugin.adoc[]
1113

12-
The `advtable` plugin is a premium plugin that extends the core link:{baseurl}/plugins/opensource/table/[`table` plugin] by adding the following advanced functionality:
13-
- Sort options for rows and columns.
14-
- Row numbering column for tables. include::partial$misc/requires_5_9v.adoc[]
14+
The `advtable` plugin is a premium plugin that extends the core xref:plugins/opensource/table.adoc[`table` plugin] by adding the following advanced functionality:
15+
16+
* Sort options for rows and columns.
17+
* Row numbering column for tables.
18+
include::partial$misc/requires_5_9v.adoc[]
1519
1620
== Enabling the Advanced Tables plugin
1721

@@ -39,8 +43,8 @@ Tables can be sorted by row or column values using:
3943
|===
4044
| Sort rows based on the selected column | Advanced Sort Dialog
4145

42-
| image:{baseurl}/images/advtable_context_menu_sort.png[Advanced Tables enhanced contextual menu for sorting rows based on the selected Column (Sort > Sort table by column ascending/descending).]
43-
| image:{baseurl}/images/advtable_dialog_sort.png[Advanced Tables sort dialog (Sort > Advanced Sort{ellps}).]
46+
| image:advtable_context_menu_sort.png[Advanced Tables enhanced contextual menu for sorting rows based on the selected Column (Sort > Sort table by column ascending/descending).]
47+
| image:advtable_dialog_sort.png[Advanced Tables sort dialog (Sort > Advanced Sort{ellps}).]
4448
|===
4549

4650
The plugin is capable of sorting:
@@ -56,9 +60,9 @@ include::partial$misc/requires_5_9v.adoc[]
5660

5761
A row numbering column containing a series of values can be added to a table to help identify rows in a table. To allow row numbering on tables, the `advtablerownumbering` toolbar button and menu item can be used.
5862

59-
A numeric and alpha value series are available by default. The available value series can be configured using the <<advtable_value_series,`advtable_value_series` option>>.
63+
A numeric and alpha value series are available by default. The available value series can be configured using the xref:advtable_value_series[`advtable_value_series` option].
6064

61-
image::{baseurl}/images/advtable_row_numbering.png[Table with numeric row numbering column and row numbering menu open (Numeric item checked)]
65+
image::advtable_row_numbering.png[Table with numeric row numbering column and row numbering menu open (Numeric item checked)]
6266

6367
== Configuration options
6468

@@ -78,4 +82,4 @@ include::partial$commands/advtable-cmds.adoc[]
7882

7983
== Events
8084

81-
For events applicable to the Advanced Tables plugin, see: link:{baseurl}/plugins/opensource/table/#events[Table plugin - Events].
85+
For events applicable to the Advanced Tables plugin, see: xref:plugins/opensource/table.adoc#events[Table plugin - Events].

modules/ROOT/partials/configuration/advtable_value_series.adoc

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -70,15 +70,17 @@ Each top-level properties of the `advtable_value_series` object are used as the
7070
| generator
7171
| `+(info: GeneratorInfo, rowIndex: number, columnIndex: number) => GeneratorResult+`
7272
| Required
73-
| For details on creating a value series generator, see: <<creatingavalueseriesgenerator,Creating a value series generator>>.
73+
| For details on creating a value series generator, see: xref:creatingavalueseriesgenerator[Creating a value series generator].
7474
|===
7575

76+
[[creatingavalueseriesgenerator]]
7677
==== Creating a value series generator
7778

78-
The `generator` is a callback function used to specify how a table cell of a value series will update. The callback is passed information relating to: the generator and table cell, the row index, and column index of the table cell. For details, see: <<generatorinfo,GeneratorInfo>>. The callback should return an object containing the value and optionally, any classes and attributes to be applied to the table cell. For details, see: <<generatorresult,GeneratorResult>>.
79+
The `generator` is a callback function used to specify how a table cell of a value series will update. The callback is passed information relating to: the generator and table cell, the row index, and column index of the table cell. For details, see: xref:generatorinfo[GeneratorInfo]. The callback should return an object containing the value and optionally, any classes and attributes to be applied to the table cell. For details, see: xref:generatorresult[GeneratorResult].
7980

80-
If the "state" of the series needs to be kept between generator iterations, additional properties can be added to the generator result. The state can be accessed through the `prev` property of the `info` parameter. For details, see: <<generatorinfo,GeneratorInfo>>.
81+
If the "state" of the series needs to be kept between generator iterations, additional properties can be added to the generator result. The state can be accessed through the `prev` property of the `info` parameter. For details, see: xref:generatorinfo[GeneratorInfo].
8182

83+
[[generatorinfo]]
8284
===== GeneratorInfo
8385

8486
An object with the following properties is passed to the generator callback function as the `info` parameter.
@@ -111,6 +113,7 @@ An object with the following properties is passed to the generator callback func
111113
| The generator result from the previous iteration.
112114
|===
113115

116+
[[generatorresult]]
114117
===== GeneratorResult
115118

116119
The generator callback function should return an object with the following properties.

0 commit comments

Comments
 (0)