Skip to content

DOC-3147: Removed documentBaseUrl property from Editor instances, use documentBaseURI instead.#3786

Closed
kemister85 wants to merge 2 commits into
feature/8.0.0/DOC-3147from
feature/8.0.0/DOC-3147_TINY-12182
Closed

DOC-3147: Removed documentBaseUrl property from Editor instances, use documentBaseURI instead.#3786
kemister85 wants to merge 2 commits into
feature/8.0.0/DOC-3147from
feature/8.0.0/DOC-3147_TINY-12182

Conversation

@kemister85
Copy link
Copy Markdown
Contributor

Ticket: DOC-3147

Site: Staging branch

Changes:

Update URL handling documentation to clarify documentBaseURI and documentBaseURL

This PR updates the documentation to accurately reflect URL handling in TinyMCE, specifically clarifying the distinction between documentBaseURI and documentBaseURL.

Changes made:

Documentation Updates

  • Added clear distinction between tinymce.documentBaseURL (EditorManager property) and editor.documentBaseURI (Editor instance methods)
  • Expanded documentBaseURI documentation with comprehensive examples of URL manipulation
  • Improved examples for URL path resolution using toAbsPath
  • Added detailed explanations of path normalization behavior
  • Retained documentBaseURL documentation in TinyMCE root API as it remains a supported property as this is maintained in tinymce/core.

File Changes

  • /modules/ROOT/partials/configuration/document_base_uri.adoc: Updated with accurate method documentation and examples
  • /modules/ROOT/pages/apis/tinymce.root.adoc: Retained documentBaseURL documentation
  • (Removed) /modules/ROOT/partials/configuration/document_base_url.adoc: Removed deprecated documentation

Testing

  • Verified all code examples work in TinyMCE fiddle
  • Confirmed URL manipulation methods work as documented
  • Validated path resolution examples with actual output

Related

  • Resolves [issue number if applicable]
  • References TinyMCE 8.0 release notes documenting the deprecation of editor.documentBaseUrl

Pre-checks:

  • Branch prefixed with feature/<version>/, hotfix/<version>/, staging/<version>/, or release/<version>/.
  • modules/ROOT/nav.adoc has been updated (if applicable).
  • Included a release note entry for any New product features.

Review:

  • Documentation Team Lead has reviewed

Add distinction between tinymce.documentBaseURL and editor.documentBaseURI
Expand documentBaseURI documentation with accurate method examples
Remove incorrect API method examples
Add detailed path resolution explanations
Retain documentBaseURL in TinyMCE root API docs
@kemister85 kemister85 added this to the TinyMCE 8.0.0 milestone Jul 2, 2025
@kemister85 kemister85 requested review from a team, abhinavgandham and soritaheng as code owners July 2, 2025 12:27
@kemister85 kemister85 added the upcoming release Documentation for features currently under development/QA label Jul 2, 2025
@kemister85 kemister85 requested review from EkimChau, ShiridiGandham and Skylite73 and removed request for a team July 2, 2025 12:27
@kemister85
Copy link
Copy Markdown
Contributor Author

closing PR, due to inaccuracies with the understanding of this change.

@kemister85 kemister85 closed this Jul 3, 2025
@kemister85 kemister85 deleted the feature/8.0.0/DOC-3147_TINY-12182 branch July 3, 2025 03:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

upcoming release Documentation for features currently under development/QA

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant