Review all href usages of target="_blank"

Do not force the user's browser to open new tabs when navigating within
the documentation pages. We discussed about this and agreed that doing
so is user hostile and goes away from how HTTP links have been working
for 30 years (i.e. leave users decide if THEY want a new tab or not, by
how they open the links).

Used these regexes:

From: target="blank"
To: target="_blank"

From: (\]\((?!http)[^)]+\))\{:target="_blank"\}
To: $1

From: (\]\(https?://docs.openvidu.io[^)]+\))\{:target="_blank"\}
To: $1

From: href="((?!http)\S+)" target="_blank"
To: href="$1"

From: href="(https?://docs.openvidu.io\S+)" target="_blank"
To: href="$1"
pull/704/head
Juan Navarro 2022-02-28 13:51:26 +01:00
parent 1173f04abc
commit 4d004e4a9e
17 changed files with 202 additions and 188 deletions

View File

@ -63,7 +63,7 @@ export class Connection {
role: string;
/**
* Whether the streams published by this Connection will be recorded or not. This only affects [INDIVIDUAL recording](/en/stable/advanced-features/recording/#individual-recording-selection) <a href="https://docs.openvidu.io/en/stable/openvidu-pro/" target="_blank" style="display: inline-block; background-color: rgb(0, 136, 170); color: white; font-weight: bold; padding: 0px 5px; margin-right: 5px; border-radius: 3px; font-size: 13px; line-height:21px; font-family: Montserrat, sans-serif">PRO</a>
* Whether the streams published by this Connection will be recorded or not. This only affects [INDIVIDUAL recording](/en/stable/advanced-features/recording/#individual-recording-selection) <a href="https://docs.openvidu.io/en/stable/openvidu-pro/" style="display: inline-block; background-color: rgb(0, 136, 170); color: white; font-weight: bold; padding: 0px 5px; margin-right: 5px; border-radius: 3px; font-size: 13px; line-height:21px; font-family: Montserrat, sans-serif">PRO</a>
*
* **Only defined for the local connection. In remote connections will be `undefined`**
*/

View File

@ -20,7 +20,7 @@ import { Session } from '../../OpenVidu/Session';
import { Event } from './Event';
/**
* **This feature is part of OpenVidu Pro tier** <a href="https://docs.openvidu.io/en/stable/openvidu-pro/" target="_blank" style="display: inline-block; background-color: rgb(0, 136, 170); color: white; font-weight: bold; padding: 0px 5px; margin-right: 5px; border-radius: 3px; font-size: 13px; line-height:21px; font-family: Montserrat, sans-serif">PRO</a>
* **This feature is part of OpenVidu Pro tier** <a href="https://docs.openvidu.io/en/stable/openvidu-pro/" style="display: inline-block; background-color: rgb(0, 136, 170); color: white; font-weight: bold; padding: 0px 5px; margin-right: 5px; border-radius: 3px; font-size: 13px; line-height:21px; font-family: Montserrat, sans-serif">PRO</a>
*
* Triggered by [[connectionPropertyChanged]]
*/

View File

@ -48,7 +48,7 @@ export interface SessionEventMap extends EventMap {
connectionDestroyed: ConnectionEvent;
/**
* **This feature is part of OpenVidu Pro tier** <a href="https://docs.openvidu.io/en/stable/openvidu-pro/" target="_blank" style="display: inline-block; background-color: rgb(0, 136, 170); color: white; font-weight: bold; padding: 0px 5px; margin-right: 5px; border-radius: 3px; font-size: 13px; line-height:21px; font-family: Montserrat, sans-serif">PRO</a>
* **This feature is part of OpenVidu Pro tier** <a href="https://docs.openvidu.io/en/stable/openvidu-pro/" style="display: inline-block; background-color: rgb(0, 136, 170); color: white; font-weight: bold; padding: 0px 5px; margin-right: 5px; border-radius: 3px; font-size: 13px; line-height:21px; font-family: Montserrat, sans-serif">PRO</a>
*
* Event dispatched when a property of the local [[Connection]] object changes.
*
@ -143,7 +143,7 @@ export interface SessionEventMap extends EventMap {
recordingStopped: RecordingEvent;
/**
* **This feature is part of OpenVidu Pro tier** <a href="https://docs.openvidu.io/en/stable/openvidu-pro/" target="_blank" style="display: inline-block; background-color: rgb(0, 136, 170); color: white; font-weight: bold; padding: 0px 5px; margin-right: 5px; border-radius: 3px; font-size: 13px; line-height:21px; font-family: Montserrat, sans-serif">PRO</a>
* **This feature is part of OpenVidu Pro tier** <a href="https://docs.openvidu.io/en/stable/openvidu-pro/" style="display: inline-block; background-color: rgb(0, 136, 170); color: white; font-weight: bold; padding: 0px 5px; margin-right: 5px; border-radius: 3px; font-size: 13px; line-height:21px; font-family: Montserrat, sans-serif">PRO</a>
*
* Event dispatched when the network quality level of a [[Connection]] changes. See [network quality](/en/stable/advanced-features/network-quality/).
*/

View File

@ -112,9 +112,10 @@ public class Connection {
/**
* Whether the streams published by this Connection will be recorded or not.
* This only affects <a href=
* "https://docs.openvidu.io/en/stable/advanced-features/recording/#individual-recording-selection"
* target="_blank">INDIVIDUAL recording</a>.
* This only affects
* <a href="https://docs.openvidu.io/en/stable/advanced-features/recording/#individual-recording-selection">
* INDIVIDUAL recording
* </a>.
*/
public boolean record() {
return this.connectionProperties.record();
@ -208,16 +209,16 @@ public class Connection {
/**
* Returns the token string associated to the Connection. This is the value that
* must be sent to the client-side to be consumed in OpenVidu Browser method
* <a href=
* "https://docs.openvidu.io/en/stable/api/openvidu-browser/classes/Session.html#connect"
* target="_blank">Session.connect</a>.
* <a href="https://docs.openvidu.io/en/stable/api/openvidu-browser/classes/Session.html#connect">
* Session.connect
* </a>.
*/
public String getToken() {
return this.token;
}
/**
* <a href="https://docs.openvidu.io/en/stable/openvidu-pro/" target="_blank"
* <a href="https://docs.openvidu.io/en/stable/openvidu-pro/"
* style="display: inline-block; background-color: rgb(0, 136, 170); color:
* white; font-weight: bold; padding: 0px 5px; margin-right: 5px; border-radius:
* 3px; font-size: 13px; line-height:21px; font-family: Montserrat,

View File

@ -125,9 +125,10 @@ public class ConnectionProperties {
/**
* Call this method to flag the streams published by this Connection to be
* recorded or not. This only affects <a href=
* "https://docs.openvidu.io/en/stable/advanced-features/recording/#individual-recording-selection"
* target="_blank">INDIVIDUAL recording</a>. If not set by default will be true.
* recorded or not. This only affects
* <a href="https://docs.openvidu.io/en/stable/advanced-features/recording/#individual-recording-selection">
* INDIVIDUAL recording
* </a>. If not set, by default will be true.
*/
public Builder record(boolean record) {
this.record = record;
@ -292,14 +293,15 @@ public class ConnectionProperties {
}
/**
* <a href="https://docs.openvidu.io/en/stable/openvidu-pro/" target="_blank"
* <a href="https://docs.openvidu.io/en/stable/openvidu-pro/"
* style="display: inline-block; background-color: rgb(0, 136, 170); color:
* white; font-weight: bold; padding: 0px 5px; margin-right: 5px; border-radius:
* 3px; font-size: 13px; line-height:21px; font-family: Montserrat,
* sans-serif">PRO</a> Whether the streams published by this Connection will be
* recorded or not. This only affects <a href=
* "https://docs.openvidu.io/en/stable/advanced-features/recording/#individual-recording-selection"
* target="_blank">INDIVIDUAL recording</a>.
* recorded or not. This only affects
* <a href="https://docs.openvidu.io/en/stable/advanced-features/recording/#individual-recording-selection">
* INDIVIDUAL recording
* </a>.
*/
public Boolean record() {
return this.record;

View File

@ -113,8 +113,9 @@ public class KurentoOptions {
* Defines the maximum number of Kbps that the Connection will be able to
* receive from Kurento Media Server per media stream. 0 means unconstrained.
* Giving a value to this property will override the global configuration set in
* <a href="https://docs.openvidu.io/en/stable/reference-docs/openvidu-config/"
* target="_blank">OpenVidu Server configuration</a> (parameter
* <a href="https://docs.openvidu.io/en/stable/reference-docs/openvidu-config/">
* OpenVidu Server configuration
* </a> (parameter
* <code>OPENVIDU_STREAMS_VIDEO_MAX_RECV_BANDWIDTH</code>) for every incoming
* stream of the user owning the token. <br>
* <strong>WARNING</strong>: the lower value set to this property limits every
@ -130,8 +131,9 @@ public class KurentoOptions {
* Defines the minimum number of Kbps that the Connection will try to receive
* from Kurento Media Server per media stream. 0 means unconstrained. Giving a
* value to this property will override the global configuration set in
* <a href= "https://docs.openvidu.io/en/stable/reference-docs/openvidu-config/"
* target="_blank">OpenVidu Server configuration</a> (parameter
* <a href= "https://docs.openvidu.io/en/stable/reference-docs/openvidu-config/">
* OpenVidu Server configuration
* </a> (parameter
* <code>OPENVIDU_STREAMS_VIDEO_MIN_RECV_BANDWIDTH</code>) for every incoming
* stream of the user owning the token.
*/
@ -143,8 +145,9 @@ public class KurentoOptions {
* Defines the maximum number of Kbps that the Connection will be able to send
* to Kurento Media Server per media stream. 0 means unconstrained. Giving a
* value to this property will override the global configuration set in
* <a href= "https://docs.openvidu.io/en/stable/reference-docs/openvidu-config/"
* target="_blank">OpenVidu Server configuration</a> (parameter
* <a href= "https://docs.openvidu.io/en/stable/reference-docs/openvidu-config/">
* OpenVidu Server configuration
* </a> (parameter
* <code>OPENVIDU_STREAMS_VIDEO_MAX_SEND_BANDWIDTH</code>) for every outgoing
* stream of the user owning the token. <br>
* <strong>WARNING</strong>: this value limits every other bandwidth of the
@ -159,8 +162,9 @@ public class KurentoOptions {
* Defines the minimum number of Kbps that the Connection will try to send to
* Kurento Media Server per media stream. 0 means unconstrained. Giving a value
* to this property will override the global configuration set in
* <a href= "https://docs.openvidu.io/en/stable/reference-docs/openvidu-config/"
* target="_blank">OpenVidu Server configuration</a> (parameter
* <a href= "https://docs.openvidu.io/en/stable/reference-docs/openvidu-config/">
* OpenVidu Server configuration
* </a> (parameter
* <code>OPENVIDU_STREAMS_VIDEO_MIN_SEND_BANDWIDTH</code>) for every outgoing
* stream of the user owning the token.
*/
@ -171,8 +175,9 @@ public class KurentoOptions {
/**
* Defines the names of the filters the Connection will be able to apply to its
* published streams. See
* <a href="https://docs.openvidu.io/en/stable/advanced-features/filters/"
* target= "_blank">Voice and video filters</a>.
* <a href="https://docs.openvidu.io/en/stable/advanced-features/filters/">
* Voice and video filters
* </a>.
*/
public String[] getAllowedFilters() {
return allowedFilters;
@ -180,8 +185,9 @@ public class KurentoOptions {
/**
* See if the Connection can apply certain filter. See
* <a href="https://docs.openvidu.io/en/stable/advanced-features/filters/"
* target= "_blank">Voice and video filters</a>.
* <a href="https://docs.openvidu.io/en/stable/advanced-features/filters/">
* Voice and video filters
* </a>.
*/
public boolean isFilterAllowed(String filterType) {
if (filterType == null) {

View File

@ -23,9 +23,10 @@ import com.google.gson.JsonObject;
* See {@link io.openvidu.java.client.Connection#getPublishers()}.
*
* <br>
* This is a backend representation of a published media stream (see <a href=
* "https://docs.openvidu.io/en/stable/api/openvidu-browser/classes/Stream.html"
* target="_blank"> OpenVidu Browser Stream class</a>).
* This is a backend representation of a published media stream (see
* <a href="https://docs.openvidu.io/en/stable/api/openvidu-browser/classes/Stream.html">
* OpenVidu Browser Stream class
* </a>).
*/
public class Publisher {

View File

@ -44,9 +44,10 @@ public enum RecordingLayout {
HORIZONTAL_PRESENTATION,
/**
* Use your own custom recording layout. See <a href=
* "https://docs.openvidu.io/en/stable/advanced-features/recording#custom-recording-layouts"
* target="_blank">Custom recording layouts</a> to learn more
* Use your own custom recording layout. See
* <a href="https://docs.openvidu.io/en/stable/advanced-features/recording#custom-recording-layouts">
* Custom recording layouts
* </a> to learn more.
*/
CUSTOM
}

View File

@ -202,9 +202,9 @@ public class RecordingProperties {
* to {@link io.openvidu.java.client.RecordingLayout#CUSTOM} you can call this
* method to set the relative path to the specific custom layout you want to
* use.<br>
* See <a href=
* "https://docs.openvidu.io/en/stable/advanced-features/recording#custom-recording-layouts"
* target="_blank">Custom recording layouts</a> to learn more
* See <a href="https://docs.openvidu.io/en/stable/advanced-features/recording#custom-recording-layouts">
* Custom recording layouts
* </a> to learn more
*/
public RecordingProperties.Builder customLayout(String path) {
this.customLayout = path;
@ -234,7 +234,7 @@ public class RecordingProperties {
}
/**
* <a href="https://docs.openvidu.io/en/stable/openvidu-pro/" target="_blank"
* <a href="https://docs.openvidu.io/en/stable/openvidu-pro/"
* style="display: inline-block; background-color: rgb(0, 136, 170); color:
* white; font-weight: bold; padding: 0px 5px; margin-right: 5px; border-radius:
* 3px; font-size: 13px; line-height:21px; font-family: Montserrat,
@ -390,9 +390,9 @@ public class RecordingProperties {
* If {@link io.openvidu.java.client.RecordingProperties#recordingLayout()} is
* set to {@link io.openvidu.java.client.RecordingLayout#CUSTOM}, this property
* defines the relative path to the specific custom layout you want to use.<br>
* See <a href=
* "https://docs.openvidu.io/en/stable/advanced-features/recording#custom-recording-layouts"
* target="_blank">Custom recording layouts</a> to learn more
* See <a href="https://docs.openvidu.io/en/stable/advanced-features/recording#custom-recording-layouts">
* Custom recording layouts
* </a> to learn more
*/
public String customLayout() {
return this.customLayout;
@ -423,7 +423,7 @@ public class RecordingProperties {
}
/**
* <a href="https://docs.openvidu.io/en/stable/openvidu-pro/" target="_blank"
* <a href="https://docs.openvidu.io/en/stable/openvidu-pro/"
* style="display: inline-block; background-color: rgb(0, 136, 170); color:
* white; font-weight: bold; padding: 0px 5px; margin-right: 5px; border-radius:
* 3px; font-size: 13px; line-height:21px; font-family: Montserrat,

View File

@ -451,7 +451,7 @@ public class Session {
}
/**
* <a href="https://docs.openvidu.io/en/stable/openvidu-pro/" target="_blank"
* <a href="https://docs.openvidu.io/en/stable/openvidu-pro/"
* style="display: inline-block; background-color: rgb(0, 136, 170); color:
* white; font-weight: bold; padding: 0px 5px; margin-right: 5px; border-radius:
* 3px; font-size: 13px; line-height:21px; font-family: Montserrat,
@ -474,10 +474,10 @@ public class Session {
* objects.<br>
* <br>
*
* The affected client will trigger one <a href=
* "/en/stable/api/openvidu-browser/classes/ConnectionPropertyChangedEvent.html"
* target="_blank">ConnectionPropertyChangedEvent</a> for each modified
* property.
* The affected client will trigger one
* <a href="/en/stable/api/openvidu-browser/classes/ConnectionPropertyChangedEvent.html">
* ConnectionPropertyChangedEvent
* </a> for each modified property.
*
* @param connectionId The Connection to modify
* @param connectionProperties A ConnectionProperties object with the new values

View File

@ -104,7 +104,7 @@ public class SessionProperties {
}
/**
* <a href="https://docs.openvidu.io/en/stable/openvidu-pro/" target="_blank"
* <a href="https://docs.openvidu.io/en/stable/openvidu-pro/"
* style="display: inline-block; background-color: rgb(0, 136, 170); color:
* white; font-weight: bold; padding: 0px 5px; margin-right: 5px; border-radius:
* 3px; font-size: 13px; line-height:21px; font-family: Montserrat,
@ -224,7 +224,7 @@ public class SessionProperties {
}
/**
* <a href="https://docs.openvidu.io/en/stable/openvidu-pro/" target="_blank"
* <a href="https://docs.openvidu.io/en/stable/openvidu-pro/"
* style="display: inline-block; background-color: rgb(0, 136, 170); color:
* white; font-weight: bold; padding: 0px 5px; margin-right: 5px; border-radius:
* 3px; font-size: 13px; line-height:21px; font-family: Montserrat,

View File

@ -55,7 +55,7 @@ export class Connection {
activeAt: number;
/**
* <a href="https://docs.openvidu.io/en/stable/openvidu-pro/" target="_blank" style="display: inline-block; background-color: rgb(0, 136, 170); color: white; font-weight: bold; padding: 0px 5px; margin-right: 5px; border-radius: 3px; font-size: 13px; line-height:21px; font-family: Montserrat, sans-serif">PRO</a>
* <a href="https://docs.openvidu.io/en/stable/openvidu-pro/" style="display: inline-block; background-color: rgb(0, 136, 170); color: white; font-weight: bold; padding: 0px 5px; margin-right: 5px; border-radius: 3px; font-size: 13px; line-height:21px; font-family: Montserrat, sans-serif">PRO</a>
* Geo location of the Connection, with the following format: `"CITY, COUNTRY"` (`"unknown"` if it wasn't possible to locate it)
*/
location: string;

View File

@ -40,7 +40,7 @@ export interface ConnectionProperties {
data?: string;
/**
* **This feature is part of OpenVidu Pro tier** <a href="https://docs.openvidu.io/en/stable/openvidu-pro/" target="_blank" style="display: inline-block; background-color: rgb(0, 136, 170); color: white; font-weight: bold; padding: 0px 5px; margin-right: 5px; border-radius: 3px; font-size: 13px; line-height:21px; font-family: Montserrat, sans-serif">PRO</a>
* **This feature is part of OpenVidu Pro tier** <a href="https://docs.openvidu.io/en/stable/openvidu-pro/" style="display: inline-block; background-color: rgb(0, 136, 170); color: white; font-weight: bold; padding: 0px 5px; margin-right: 5px; border-radius: 3px; font-size: 13px; line-height:21px; font-family: Montserrat, sans-serif">PRO</a>
*
* Whether to record the streams published by this Connection or not. This only affects [INDIVIDUAL recording](/en/stable/advanced-features/recording/#individual-recording-selection)
*

View File

@ -110,7 +110,7 @@ export interface RecordingProperties {
ignoreFailedStreams?: boolean;
/**
* **This feature is part of OpenVidu Pro tier** <a href="https://docs.openvidu.io/en/stable/openvidu-pro/" target="_blank" style="display: inline-block; background-color: rgb(0, 136, 170); color: white; font-weight: bold; padding: 0px 5px; margin-right: 5px; border-radius: 3px; font-size: 13px; line-height:21px; font-family: Montserrat, sans-serif">PRO</a>
* **This feature is part of OpenVidu Pro tier** <a href="https://docs.openvidu.io/en/stable/openvidu-pro/" style="display: inline-block; background-color: rgb(0, 136, 170); color: white; font-weight: bold; padding: 0px 5px; margin-right: 5px; border-radius: 3px; font-size: 13px; line-height:21px; font-family: Montserrat, sans-serif">PRO</a>
*
* The Media Node where to host the recording. The default option if this property is not defined is the same
* Media Node hosting the Session to record. This object defines the following properties as Media Node selector:

View File

@ -388,7 +388,7 @@ export class Session {
}
/**
* **This feature is part of OpenVidu Pro tier** <a href="https://docs.openvidu.io/en/stable/openvidu-pro/" target="_blank" style="display: inline-block; background-color: rgb(0, 136, 170); color: white; font-weight: bold; padding: 0px 5px; margin-right: 5px; border-radius: 3px; font-size: 13px; line-height:21px; font-family: Montserrat, sans-serif">PRO</a>
* **This feature is part of OpenVidu Pro tier** <a href="https://docs.openvidu.io/en/stable/openvidu-pro/" style="display: inline-block; background-color: rgb(0, 136, 170); color: white; font-weight: bold; padding: 0px 5px; margin-right: 5px; border-radius: 3px; font-size: 13px; line-height:21px; font-family: Montserrat, sans-serif">PRO</a>
*
* Updates the properties of a Connection with a [[ConnectionProperties]] object.
* Only these properties can be updated:

View File

@ -56,7 +56,7 @@ export interface SessionProperties {
customSessionId?: string;
/**
* **This feature is part of OpenVidu Pro tier** <a href="https://docs.openvidu.io/en/stable/openvidu-pro/" target="_blank" style="display: inline-block; background-color: rgb(0, 136, 170); color: white; font-weight: bold; padding: 0px 5px; margin-right: 5px; border-radius: 3px; font-size: 13px; line-height:21px; font-family: Montserrat, sans-serif">PRO</a>
* **This feature is part of OpenVidu Pro tier** <a href="https://docs.openvidu.io/en/stable/openvidu-pro/" style="display: inline-block; background-color: rgb(0, 136, 170); color: white; font-weight: bold; padding: 0px 5px; margin-right: 5px; border-radius: 3px; font-size: 13px; line-height:21px; font-family: Montserrat, sans-serif">PRO</a>
*
* The Media Node where to host the session. The default option if this property is not defined is the less loaded
* Media Node at the moment the first user joins the session. This object defines the following properties as Media Node selector:

View File

@ -7,12 +7,15 @@
<body>
<h1>Welcome to OpenVidu</h1>
<ul>
<li><strong>OpenVidu Server URL: </strong><span id="rest-api-url"></span>
<small>(consume <a
href="https://docs.openvidu.io/en/stable/reference-docs/REST-API/"
target="_blank">REST API</a> in this URL)
</small></li>
<li><strong>OpenVidu Dashboard: </strong><span id="dashboard-url"></span></li>
<li>
<strong>OpenVidu Server URL: </strong><span id="rest-api-url"></span>
<small>
(consume <a href="https://docs.openvidu.io/en/stable/reference-docs/REST-API/" target="_blank">REST API</a> in this URL)
</small>
</li>
<li>
<strong>OpenVidu Dashboard: </strong><span id="dashboard-url"></span>
</li>
</ul>
</body>
<script>