URL handling options

优质

小牛编辑

125浏览

2023-12-01

Q: How do I convert my URLs to relative, absolute, or absolute with domain?

Relative URLs

This will convert all URLs within the same domain to relative URLs. The URLs will be relative from the document_base_url.

relative_urls : true,
document_base_url : "http://www.example.com/path1/"

Example: http://www.example.com/path1/path2/file.htm » path2/file.htm

Absolute URLs

This will convert all relative URLs to absolute URLs. The URLs will be absolute based on the [document_base_url].

relative_urls : false,
remove_script_host : true,
document_base_url : "http://www.example.com/path1/"

Example: path2/file.htm » /path1/path2/file.htm

Domain absolute URLs

This will convert all relative URLs to absolute URLs. The URLs will be absolute based on the [document_base_url] with domain.

relative_urls : false,
remove_script_host : false,
document_base_url : "http://www.example.com/path1/"

Example: path2/file.htm » http://www.example.com/path1/path2/file.htm

allow_script_urls

Enabling this option will allow javascript: urls in links and images. This is disabled by default for security purposes so scripts can’t be injected by pasting contents from one site to another. If you still want to enable this option just set it to true.

Type: Boolean

Default Value: false

Possible Values: true, false

Example

tinymce.init({
  selector: 'textarea',  // change this value according to your HTML
  allow_script_urls: true
});

convert_urls

This option enables you to control whether TinyMCE is to be smart and restore URLs to their original values. URLs are automatically converted (messed up) by default because the browser’s built-in logic works this way. There is no way to get the real URL unless you store it away. If you set this option to false it tries to keep these URLs intact. This option is set to true by default, which means URLs are forced to be either absolute or relative depending on the state of relative_urls.

Type: Boolean

Default Value: true

Possible Values: true, false

tinymce.init({
  selector: 'textarea',  // change this value according to your HTML
  convert_urls: false
});

document_base_url

This option specifies the base URL for all relative URLs in the document. The default value is the directory of the current document. If a value is provided, it must specify a directory (not a document) and must end with a /.

This option also interacts with the relative_urls, remove_script_host, and convert_urls options to determine whether TinyMCE returns relative or absolute URLs. The FAQ contains a thorough description and examples of working with relative and absolute URLs.

Type: String

Example

tinymce.init({
  selector: 'textarea',  // change this value according to your HTML
  document_base_url: 'http://www.example.com/path1/'
});

relative_urls

If this option is set to true, all URLs returned from the MCFileManager will be relative from the specified document_base_url. If it’s set to false all URLs will be converted to absolute URLs.

Type: Boolean

Default Value: true

Possible Values: true, false

Example

tinymce.init({
  selector: 'textarea',  // change this value according to your HTML
  relative_urls: false
});

remove_script_host

If this option is enabled the protocol and host part of the URLs returned from the MCFileManager will be removed. This option is only used if the relative_urls option is set to false.

Type: Boolean

Default Value: true

Possible Values: true, false

Example

tinymce.init({
  selector: 'textarea',  // change this value according to your HTML
  remove_script_host: false
});

If disabled, URLs will be returned in this format: 'http://www.example.com/somedir/somefile.htm' instead of the default format: '/somedir/somefile.htm'.

urlconverter_callback

This option enables you to add your own URL converter logic. This option should contain a JavaScript function name.

The format of the converter function is: URLConverter(url, node, on_save), where:

url = the URL string to convert,
node = the element that contains the URL that is to be converted (this parameter may be set to null if there is no element for the URL), and
on_save is always set to true.
name = the attribute name that is being set.

This function should return the converted URL as a string. This option is set to an internal TinyMCE function .[convertURL()](/docs/api/tinymce/tinymce.editor/) by default. You may call this function from your extension in order to use the built-in convert options.

Type: Javascript Function

Example

function myCustomURLConverter(url, node, on_save, name) {
  // Do some custom URL conversion
  url = url.substring(3);

  // Return new URL
  return url;
}

tinyMCE.init({
  selector: 'textarea',  // change this value according to your HTML
  urlconverter_callback : 'myCustomURLConverter'
});

anchor_bottom

Lets you specify a custom name for the bottom anchor in the url type ahead drop down. To disable the bottom anchor from the drop down set it false.

Type: String

Default: #bottom

Example of custom value

tinymce.init({
  selector: 'textarea',
  anchor_bottom: '#mybottom'
});

Example of disabling

tinymce.init({
  selector: 'textarea',
  anchor_bottom: false
});

anchor_top

Lets you specify a custom name for the top anchor in the url type ahead drop down. To disable the to anchor from the drop down set it false.

Type: String

Default: #top

Example of custom value

tinymce.init({
  selector: 'textarea',
  anchor_top: '#mytop'
});

Example of disabling

tinymce.init({
  selector: 'textarea',
  anchor_top: false
});