Skip to content

Commit d60bd68

Browse files
committed
DOC-2350: [WIP] Flattened legacy file structure
1 parent 51d0b22 commit d60bd68

File tree

622 files changed

+13714
-4570
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

622 files changed

+13714
-4570
lines changed

.gitignore

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,4 @@ node_modules
77
build/
88

99
# Antora tmp files
10-
_site/
11-
12-
# Moxiedoc files
13-
moxiedoc_nav.adoc
14-
modules/ROOT/pages/api/
10+
_site/

_scripts/api-reference.sh

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -13,22 +13,22 @@ rm -rf _data
1313
rm -rf "$API_TMPDIR"
1414
mkdir "$API_TMPDIR"
1515
curl -s "$TARBALL_URL" | tar xzf - -C "$API_TMPDIR" --strip-components 1
16-
npx moxiedoc "$API_TMPDIR/modules/tinymce/src/core/main/ts" -t antora -s "legacy" -o "$API_TMPDIR/tinymce-api-reference.zip"
16+
npx moxiedoc "$API_TMPDIR/modules/tinymce/src/core/main/ts" -t antora -o "$API_TMPDIR/tinymce-api-reference.zip"
1717
unzip -o "$API_TMPDIR/tinymce-api-reference.zip"
1818

1919
# remove old api adoc pages
20-
rm -rf modules/ROOT/pages/api/
20+
rm -rf modules/ROOT/pages/apis/
2121

2222
# removed old static api html pages (clear cache), it can corrupt the build
23-
rm -rf build/site/tinymce/5/api/
23+
rm -rf build/site/_/tinymce/5/apis/
2424

2525
# move newly generated adoc pages, antora will then generate new static html pages
26-
mv _data/antora/api modules/ROOT/pages/
26+
mv _data/antora modules/ROOT/pages/apis
2727

2828
# move api navigation
2929
mv _data/moxiedoc_nav.adoc modules/ROOT/moxiedoc_nav.adoc
3030

3131
# cleanup moxiedoc tmp _data folder
3232
rm -rf _data
3333

34-
echo "donesky"
34+
echo "API reference updated."

modules/ROOT/moxiedoc_nav.adoc

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
* API Reference
2+
** tinymce
3+
*** xref:apis/tinymce.root.adoc[tinymce]
4+
*** xref:apis/tinymce.addonmanager.adoc[tinymce.AddOnManager]
5+
*** xref:apis/tinymce.annotator.adoc[tinymce.Annotator]
6+
*** xref:apis/tinymce.editor.adoc[tinymce.Editor]
7+
*** xref:apis/tinymce.editormode.adoc[tinymce.EditorMode]
8+
*** xref:apis/tinymce.env.adoc[tinymce.Env]
9+
*** xref:apis/tinymce.event.adoc[tinymce.Event]
10+
*** xref:apis/tinymce.formatter.adoc[tinymce.Formatter]
11+
*** xref:apis/tinymce.notificationmanager.adoc[tinymce.NotificationManager]
12+
*** xref:apis/tinymce.plugin.adoc[tinymce.Plugin]
13+
*** xref:apis/tinymce.shortcuts.adoc[tinymce.Shortcuts]
14+
*** xref:apis/tinymce.theme.adoc[tinymce.Theme]
15+
*** xref:apis/tinymce.undomanager.adoc[tinymce.UndoManager]
16+
*** xref:apis/tinymce.windowmanager.adoc[tinymce.WindowManager]
17+
** tinymce.dom
18+
*** xref:apis/tinymce.dom.bookmarkmanager.adoc[tinymce.dom.BookmarkManager]
19+
*** xref:apis/tinymce.dom.domutils.adoc[tinymce.dom.DOMUtils]
20+
*** xref:apis/tinymce.dom.domquery.adoc[tinymce.dom.DomQuery]
21+
*** xref:apis/tinymce.dom.eventutils.adoc[tinymce.dom.EventUtils]
22+
*** xref:apis/tinymce.dom.rangeutils.adoc[tinymce.dom.RangeUtils]
23+
*** xref:apis/tinymce.dom.scriptloader.adoc[tinymce.dom.ScriptLoader]
24+
*** xref:apis/tinymce.dom.selection.adoc[tinymce.dom.Selection]
25+
*** xref:apis/tinymce.dom.serializer.adoc[tinymce.dom.Serializer]
26+
*** xref:apis/tinymce.dom.stylesheetloader.adoc[tinymce.dom.StyleSheetLoader]
27+
*** xref:apis/tinymce.dom.textseeker.adoc[tinymce.dom.TextSeeker]
28+
*** xref:apis/tinymce.dom.treewalker.adoc[tinymce.dom.TreeWalker]
29+
** tinymce.editor.ui
30+
*** xref:apis/tinymce.editor.ui.registry.adoc[tinymce.editor.ui.Registry]
31+
*** xref:apis/tinymce.editor.ui.ui.adoc[tinymce.editor.ui.Ui]
32+
** tinymce.geom
33+
*** xref:apis/tinymce.geom.rect.adoc[tinymce.geom.Rect]
34+
** tinymce.html
35+
*** xref:apis/tinymce.html.domparser.adoc[tinymce.html.DomParser]
36+
*** xref:apis/tinymce.html.entities.adoc[tinymce.html.Entities]
37+
*** xref:apis/tinymce.html.node.adoc[tinymce.html.Node]
38+
*** xref:apis/tinymce.html.saxparser.adoc[tinymce.html.SaxParser]
39+
*** xref:apis/tinymce.html.schema.adoc[tinymce.html.Schema]
40+
*** xref:apis/tinymce.html.serializer.adoc[tinymce.html.Serializer]
41+
*** xref:apis/tinymce.html.styles.adoc[tinymce.html.Styles]
42+
*** xref:apis/tinymce.html.writer.adoc[tinymce.html.Writer]
43+
** tinymce.util
44+
*** xref:apis/tinymce.util.delay.adoc[tinymce.util.Delay]
45+
*** xref:apis/tinymce.util.eventdispatcher.adoc[tinymce.util.EventDispatcher]
46+
*** xref:apis/tinymce.util.i18n.adoc[tinymce.util.I18n]
47+
*** xref:apis/tinymce.util.imageuploader.adoc[tinymce.util.ImageUploader]
48+
*** xref:apis/tinymce.util.json.adoc[tinymce.util.JSON]
49+
*** xref:apis/tinymce.util.jsonrequest.adoc[tinymce.util.JSONRequest]
50+
*** xref:apis/tinymce.util.observable.adoc[tinymce.util.Observable]
51+
*** xref:apis/tinymce.util.tools.adoc[tinymce.util.Tools]
52+
*** xref:apis/tinymce.util.uri.adoc[tinymce.util.URI]
53+
*** xref:apis/tinymce.util.xhr.adoc[tinymce.util.XHR]

modules/ROOT/nav.adoc

Lines changed: 290 additions & 290 deletions
Large diffs are not rendered by default.

modules/ROOT/pages/release-notes/6.0-upcoming-changes.adoc renamed to modules/ROOT/pages/6.0-upcoming-changes.adoc

Lines changed: 37 additions & 37 deletions
Large diffs are not rendered by default.
File renamed without changes.

modules/ROOT/pages/advanced/accessibility.adoc renamed to modules/ROOT/pages/advanced-accessibility.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ The following *Alt+key* and *Option+key* shortcuts can only be used when the con
3838
| Tab and the Arrow Keys
3939
|===
4040

41-
For additional navigation keyboard shortcuts and shortcuts for applying some commonly-used formats, see: xref:advanced/keyboard-shortcuts.adoc[Keyboard shortcuts].
41+
For additional navigation keyboard shortcuts and shortcuts for applying some commonly-used formats, see: xref:keyboard-shortcuts.adoc[Keyboard shortcuts].
4242

4343
== How to work with the editor
4444

@@ -64,4 +64,4 @@ Dialogs such as *Insert/Edit Image* are opened from either a menu item or a tool
6464

6565
== Accessibility options
6666

67-
{productname} has accessibility options that can be set when initializing the editor, see: xref:configure/accessibility.adoc[Accessibility options].
67+
{productname} has accessibility options that can be set when initializing the editor, see: xref:configure-accessibility.adoc[Accessibility options].

modules/ROOT/pages/configure/advanced-editing-behavior.adoc renamed to modules/ROOT/pages/advanced-editing-behavior.adoc

File renamed without changes.
Lines changed: 22 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -129,7 +129,7 @@ include::partial$misc/requires_5_2v.adoc[]
129129

130130
| SwitchMode
131131
| `{ mode: string }`
132-
| Fired when the editor mode is changed. The available modes are "design" and "readonly". Additional modes can be registered using {productname} API xref:api/tinymce/tinymce.editormode.adoc#register['tinymce.activeEditor.mode.register()'].
132+
| Fired when the editor mode is changed. The available modes are "design" and "readonly". Additional modes can be registered using {productname} API xref:apis/tinymce.editormode.adoc#register['tinymce.activeEditor.mode.register()'].
133133

134134
| ScrollWindow
135135
| (Same data as the native https://developer.mozilla.org/en-US/docs/Web/API/Element/scroll_event[scroll event])
@@ -263,7 +263,7 @@ include::partial$misc/requires_5_9v.adoc[]
263263

264264
| Dirty
265265
| N/A
266-
| Fired when the editor transitions from a "pristine" state to a "dirty" state. The editor is "dirty" when xref:api/tinymce/tinymce.undomanager.adoc[an undo level] has been _created_ since initialization or the last saved state. To check if the editor is "dirty", use the xref:api/tinymce/tinymce.editor.adoc#isDirty[`editor.isDirty` API].
266+
| Fired when the editor transitions from a "pristine" state to a "dirty" state. The editor is "dirty" when xref:apis/tinymce.undomanager.adoc[an undo level] has been _created_ since initialization or the last saved state. To check if the editor is "dirty", use the xref:apis/tinymce.editor.adoc#isDirty[`editor.isDirty` API].
267267

268268
| CloseWindow
269269
| `{ dialog: DialogApi }`
@@ -275,7 +275,7 @@ include::partial$misc/requires_5_9v.adoc[]
275275

276276
| ProgressState
277277
| `{ state: boolean, time?: number }`
278-
| Fired when a change to the editor progress state is scheduled using the {productname} API xref:api/tinymce/tinymce.editor.adoc#setProgressState[`tinymce.activeEditor.setProgressState()`].
278+
| Fired when a change to the editor progress state is scheduled using the {productname} API xref:apis/tinymce.editor.adoc#setProgressState[`tinymce.activeEditor.setProgressState()`].
279279

280280
| AfterProgressState
281281
| `{ state: boolean }`
@@ -292,7 +292,7 @@ include::partial$misc/requires_5_7v.adoc[]
292292

293293
| SetAttrib
294294
| `{ attrElm: Element, attrName: string, attrValue: string }`
295-
| Fired when an attribute is updated using the editor xref:api/tinymce.dom/tinymce.dom.domutils.adoc[DOMUtils API].
295+
| Fired when an attribute is updated using the editor xref:apis/tinymce.dom.domutils.adoc[DOMUtils API].
296296

297297
| ResizeEditor
298298
| N/A
@@ -358,12 +358,12 @@ include::partial$misc/requires_5_1v.adoc[]
358358

359359
| BeforeOpenNotification
360360
| `{ notification: NotificationSpec }`
361-
| Fired before a notification is displayed. For information on the Notifications Specification (`NotificationSpec`), see: xref:advanced/creating-custom-notifications.adoc[Create custom notifications].
361+
| Fired before a notification is displayed. For information on the Notifications Specification (`NotificationSpec`), see: xref:creating-custom-notifications.adoc[Create custom notifications].
362362
include::partial$misc/requires_5_6v.adoc[]
363363

364364
| OpenNotification
365365
| `{ notification: NotificationApi }`
366-
| Fired after a notification is displayed. For information on the Notifications API (`NotificationApi`), see: xref:advanced/creating-custom-notifications.adoc[Create custom notifications].
366+
| Fired after a notification is displayed. For information on the Notifications API (`NotificationApi`), see: xref:creating-custom-notifications.adoc[Create custom notifications].
367367
include::partial$misc/requires_5_6v.adoc[]
368368
|===
369369

@@ -400,7 +400,7 @@ For events applicable to the Advanced Tables plugin, see: xref:tableevents[Table
400400
[[autosaveevents]]
401401
=== Autosave events
402402

403-
The following events are provided by the xref:plugins/opensource/autosave.adoc[Autosave plugin].
403+
The following events are provided by the xref:autosave.adoc[Autosave plugin].
404404

405405
|===
406406
| Name | Data | Description
@@ -421,7 +421,7 @@ The following events are provided by the xref:plugins/opensource/autosave.adoc[A
421421
[[charactermapevents]]
422422
=== Character Map events
423423

424-
The following event is provided by the xref:plugins/opensource/charmap.adoc[Character Map plugin].
424+
The following event is provided by the xref:charmap.adoc[Character Map plugin].
425425

426426
|===
427427
| Name | Data | Description
@@ -434,7 +434,7 @@ The following event is provided by the xref:plugins/opensource/charmap.adoc[Char
434434
[[commentsevents]]
435435
=== Comments events
436436

437-
The following event is provided by the xref:plugins/premium/comments/index.adoc[Comments plugin].
437+
The following event is provided by the xref:comments.adoc[Comments plugin].
438438

439439
|===
440440
| Name | Data | Description
@@ -452,7 +452,7 @@ include::partial$events/export-events.adoc[]
452452
[[formatpainterevents]]
453453
=== Format Painter events
454454

455-
The following event is provided by the xref:plugins/premium/formatpainter.adoc[Format Painter plugin].
455+
The following event is provided by the xref:premium-formatpainter.adoc[Format Painter plugin].
456456

457457
|===
458458
| Name | Data | Description
@@ -465,7 +465,7 @@ The following event is provided by the xref:plugins/premium/formatpainter.adoc[F
465465
[[fullscreenevents]]
466466
=== Fullscreen events
467467

468-
The following event is provided by the xref:plugins/opensource/fullscreen.adoc[Fullscreen plugin].
468+
The following event is provided by the xref:fullscreen.adoc[Fullscreen plugin].
469469

470470
|===
471471
| Name | Data | Description
@@ -478,7 +478,7 @@ The following event is provided by the xref:plugins/opensource/fullscreen.adoc[F
478478
[[importcssevents]]
479479
=== Import CSS events
480480

481-
The following event is provided by the xref:plugins/opensource/importcss.adoc[Import CSS plugin].
481+
The following event is provided by the xref:importcss.adoc[Import CSS plugin].
482482

483483
|===
484484
| Name | Data | Description
@@ -491,7 +491,7 @@ The following event is provided by the xref:plugins/opensource/importcss.adoc[Im
491491
[[linkcheckerevents]]
492492
=== Link checker events
493493

494-
The following event is provided by the xref:plugins/premium/linkchecker.adoc[Link Checker plugin].
494+
The following event is provided by the xref:linkchecker.adoc[Link Checker plugin].
495495

496496
|===
497497
| Name | Data | Description
@@ -504,7 +504,7 @@ The following event is provided by the xref:plugins/premium/linkchecker.adoc[Lin
504504
[[listsevents]]
505505
=== Lists events
506506

507-
The following event is provided by the xref:plugins/opensource/lists.adoc[Lists plugin].
507+
The following event is provided by the xref:lists.adoc[Lists plugin].
508508

509509
|===
510510
| Name | Data | Description
@@ -517,7 +517,7 @@ The following event is provided by the xref:plugins/opensource/lists.adoc[Lists
517517
[[mediaembedevents]]
518518
=== Media Embed events
519519

520-
The following event is provided by the xref:plugins/premium/mediaembed.adoc[Media Embed plugin].
520+
The following event is provided by the xref:mediaembed.adoc[Media Embed plugin].
521521

522522
|===
523523
| Name | Data | Description
@@ -530,7 +530,7 @@ The following event is provided by the xref:plugins/premium/mediaembed.adoc[Medi
530530
[[pasteevents]]
531531
=== Paste events
532532

533-
The following events are provided by the xref:plugins/opensource/paste.adoc[Paste plugin].
533+
The following events are provided by the xref:paste.adoc[Paste plugin].
534534

535535
|===
536536
| Name | Data | Description
@@ -551,7 +551,7 @@ The following events are provided by the xref:plugins/opensource/paste.adoc[Past
551551
[[permanentpenevents]]
552552
=== Permanent Pen events
553553

554-
The following events are provided by the xref:plugins/premium/permanentpen.adoc[Permanent Pen plugin].
554+
The following events are provided by the xref:premium-permanentpen.adoc[Permanent Pen plugin].
555555

556556
|===
557557
| Name | Data | Description
@@ -568,7 +568,7 @@ The following events are provided by the xref:plugins/premium/permanentpen.adoc[
568568
[[powerpasteevents]]
569569
=== PowerPaste events
570570

571-
The following events are provided by the xref:plugins/premium/powerpaste.adoc[PowerPaste plugin].
571+
The following events are provided by the xref:powerpaste.adoc[PowerPaste plugin].
572572

573573
|===
574574
| Name | Data | Description
@@ -589,7 +589,7 @@ The following events are provided by the xref:plugins/premium/powerpaste.adoc[Po
589589
[[spellcheckerevents]]
590590
=== Spell Checker events
591591

592-
The following events are provided by the xref:plugins/opensource/spellchecker.adoc[Spell Checker plugin].
592+
The following events are provided by the xref:spellchecker.adoc[Spell Checker plugin].
593593

594594
include::partial$DEPRECATED/spellchecker.adoc[]
595595

@@ -618,7 +618,7 @@ include::partial$events/table-events.adoc[]
618618
[[visualblocksevents]]
619619
=== Visual Blocks events
620620

621-
The following event is provided by the xref:plugins/opensource/visualblocks.adoc[Visual Blocks plugin].
621+
The following event is provided by the xref:visualblocks.adoc[Visual Blocks plugin].
622622

623623
|===
624624
| Name | Data | Description
@@ -631,7 +631,7 @@ The following event is provided by the xref:plugins/opensource/visualblocks.adoc
631631
[[visualcharactersevents]]
632632
=== Visual Characters events
633633

634-
The following event is provided by the xref:plugins/opensource/visualchars.adoc[Visual Characters plugin].
634+
The following event is provided by the xref:visualchars.adoc[Visual Characters plugin].
635635

636636
|===
637637
| Name | Data | Description
@@ -644,7 +644,7 @@ The following event is provided by the xref:plugins/opensource/visualchars.adoc[
644644
[[wordcountevents]]
645645
=== Word Count events
646646

647-
The following event is provided by the xref:plugins/opensource/wordcount.adoc[Word Count plugin].
647+
The following event is provided by the xref:wordcount.adoc[Word Count plugin].
648648

649649
|===
650650
| Name | Data | Description

modules/ROOT/pages/general-configuration-guide/advanced-install.adoc renamed to modules/ROOT/pages/advanced-install.adoc

File renamed without changes.

0 commit comments

Comments
 (0)