fix: i18n domain and translators comments

Author: Soare-Robert-Daniel

classes/Visualizer/Module/Admin.php

@@ -110,6 +110,7 @@ public function render_review_notice( $footer_text ) {
 			foreach ( $visualizer_page_ids as $page_to_check ) {
 				if ( strpos( $current_screen->id, $page_to_check ) !== false ) {
 					$footer_text = sprintf(
+						// translators: %1$s - the name of the plugin (Visualizer), %2$s - message (You can help us by leaving a), %3$s - HTML entity code.
 						__( 'Enjoying %1$s? %2$s %3$s rating. Thank you for being so supportive!', 'visualizer' ),
 						'<b>Visualizer</b>',
 						esc_html__( 'You can help us by leaving a', 'visualizer' ),
@@ -1335,7 +1336,7 @@ public function add_black_friday_data( $configs ) {
 		$config = $configs['default'];
 
 		// translators: %1$s - HTML tag, %2$s - discount, %3$s - HTML tag, %4$s - product name.
-		$message_template = __( 'Our biggest sale of the year: %1$sup to %2$s OFF%3$s on %4$s. Don\'t miss this limited-time offer.', 'wp-cloudflare-page-cache' );
+		$message_template = __( 'Our biggest sale of the year: %1$sup to %2$s OFF%3$s on %4$s. Don\'t miss this limited-time offer.', 'visualizer' );
 		$product_label    = 'Visualizer';
 		$discount         = '70%';
 
@@ -1345,7 +1346,7 @@ public function add_black_friday_data( $configs ) {
 
 		if ( $is_pro ) {
 			// translators: %1$s - HTML tag, %2$s - discount, %3$s - HTML tag, %4$s - product name.
-			$message_template = __( 'Get %1$sup to %2$s off%3$s when you upgrade your %4$s plan or renew early.', 'wp-cloudflare-page-cache' );
+			$message_template = __( 'Get %1$sup to %2$s off%3$s when you upgrade your %4$s plan or renew early.', 'visualizer' );
 			$product_label    = 'Visualizer Pro';
 			$discount         = '30%';
 		}

classes/Visualizer/Module/Sources.php

@@ -138,7 +138,9 @@ public function addProUpsell( $old, $feature = null ) {
 			( in_array( $feature, $biz_features, true ) && ! apply_filters( 'visualizer_is_business', false ) ) ||
 			( in_array( $feature, $pro_features, true ) && ! Visualizer_Module::is_pro() )
 		) {
+			// translators: $s - the name of the plan (PRO).
 			$msg = sprintf( __( 'Upgrade to %s to activate this feature!', 'visualizer' ), 'PRO' );
+			// translators: $s - the name of the plan (Plus).
 			$plus_msg = sprintf( __( 'Upgrade to %s plan to activate this feature!', 'visualizer' ), 'Plus' );
 			if ( in_array( $feature, $biz_features, true ) && Visualizer_Module::is_pro() ) {
 				$msg = $plus_msg;

classes/Visualizer/Render/Layout.php

@@ -90,8 +90,26 @@ public static function _renderDbQuery( $args ) {
 			<div class='db-wizard-hints'>
 				<ul>
 					<li><?php echo __( 'Your database prefix is:', 'visualizer' ); ?> <span class="visualizer-emboss"><?php echo $wpdb->prefix; ?></span></li>
-					<li><?php echo sprintf( __( 'For examples of queries and links to resources that you can use with this feature, please click %1$shere%2$s', 'visualizer' ), '<a href="' . VISUALIZER_DB_QUERY_DOC_URL . '" target="_blank">', '</a>' ); ?></li>
-					<li><?php echo sprintf( __( 'Use %1$sShift+Space%2$s for autocompleting keywords or table names.', 'visualizer' ), '<span class="visualizer-emboss">', '</span>' ); ?></li>
+					<li>
+					<?php
+					echo sprintf(
+						// translators: %1$s - HTML link tag, %2$s - HTML closing link tag.
+						__( 'For examples of queries and links to resources that you can use with this feature, please click %1$shere%2$s', 'visualizer' ),
+						'<a href="' . VISUALIZER_DB_QUERY_DOC_URL . '" target="_blank">',
+						'</a>'
+					);
+					?>
+					</li>
+					<li>
+					<?php
+					echo sprintf(
+						// translators: %1$s - HTML link tag, %2$s - HTML closing link tag.
+						__( 'Use %1$sShift+Space%2$s for autocompleting keywords or table names.', 'visualizer' ),
+						'<span class="visualizer-emboss">',
+						'</span>'
+					);
+					?>
+					</li>
 					<?php do_action( 'visualizer_db_query_add_hints', $args ); ?>
 				</ul>
 			</div>
@@ -180,7 +198,16 @@ public static function _renderJsonScreen( $args ) {
 					<form id="json-endpoint-form">
 						<div class="json-wizard-hints">
 							<ul class="info">
-								<li><?php echo sprintf( __( 'If you want to add authentication or headers to the endpoint or change the request in any way, please refer to our document %1$shere%2$s.', 'visualizer' ), '<a href="https://docs.themeisle.com/article/1043-visualizer-how-to-extend-rest-endpoints-with-json-response" target="_blank">', '</a>' ); ?></li>
+								<li>
+								<?php
+								echo sprintf(
+									// translators: %1$s - HTML link tag, %2$s - HTML closing link tag.
+									__( 'If you want to add authentication or headers to the endpoint or change the request in any way, please refer to our document %1$shere%2$s.', 'visualizer' ),
+									'<a href="https://docs.themeisle.com/article/1043-visualizer-how-to-extend-rest-endpoints-with-json-response" target="_blank">',
+									'</a>'
+								);
+								?>
+								</li>
 							</ul>
 						</div>
 
@@ -662,10 +689,20 @@ public static function _renderTabHelp( $args ) {
 				<h4><span class="dashicons dashicons-media-code"></span><a href="<?php echo VISUALIZER_CODE_SNIPPETS_URL; ?>" target="_blank"><?php _e( 'Custom code snippets', 'visualizer' ); ?></a></h4>
 		<?php
 			Visualizer_Render_Sidebar::_renderSectionEnd();
+			// translators: %s - the chart type.
 			Visualizer_Render_Sidebar::_renderSectionStart( sprintf( __( '%s chart', 'visualizer' ), ucwords( $displayType ) ), true );
 		?>
 				<h4><span class="dashicons dashicons-video-alt2"></span>&nbsp;<a href="<?php echo str_replace( '#', "$type-chart", VISUALIZER_DEMO_URL ); ?>" target="_blank"><?php _e( 'View demo', 'visualizer' ); ?></a></h4>
-				<h4><span class="dashicons dashicons-search"></span><a href="<?php echo str_replace( '#', $type, VISUALIZER_DOC_COLLECTION ); ?>" target="_blank"><?php echo sprintf( __( 'Articles containing "%s"', 'visualizer' ), $displayType ); ?></a></h4>
+				<h4><span class="dashicons dashicons-search"></span><a href="<?php echo str_replace( '#', $type, VISUALIZER_DOC_COLLECTION ); ?>" target="_blank">
+					<?php
+					echo sprintf(
+						// translators: %s - the chart type.
+						__( 'Articles containing "%s"', 'visualizer' ),
+						$displayType
+					);
+					?>
+					</a>
+				</h4>
 		<?php
 			Visualizer_Render_Sidebar::_renderSectionEnd();
 		Visualizer_Render_Sidebar::_renderGroupEnd();
@@ -775,7 +812,17 @@ public static function _renderTabBasic( $args ) {
 								<div class="viz-group-content">
 									<div>
 										<p class="viz-group-description"><?php esc_html_e( 'Select and upload your data CSV file here. The first row of the CSV file should contain the column headings. The second one should contain series type (string, number, boolean, date, datetime, timeofday).', 'visualizer' ); ?></p>
-										<p class="viz-group-description viz-info-msg"><b><?php echo sprintf( __( 'If you are unsure about how to format your data CSV then please take a look at this sample: %1$s %2$s%3$s. If you are using non-English characters, please make sure you save the file in UTF-8 encoding.', 'visualizer' ), '<a href="' . VISUALIZER_ABSURL . 'samples/' . $type . '.csv" target="_blank">', $type, '.csv</a>' ); ?></b></p>
+										<p class="viz-group-description viz-info-msg">
+											<b>
+											<?php
+											echo sprintf(
+												// translators: $s - the chart type with the link attached.
+												__( 'If you are unsure about how to format your data CSV then please take a look at this sample: %s. If you are using non-English characters, please make sure you save the file in UTF-8 encoding.', 'visualizer' ),
+												'<a href="' . VISUALIZER_ASURL . 'samples/' . $type . '.csv" target="_blank">' . $type . '.csv</a>'
+											);
+											?>
+											</b>
+										</p>
 										<form id="vz-csv-file-form" action="<?php echo $upload_link; ?>" method="post"
 											target="thehole" enctype="multipart/form-data">
 											<input type="hidden" id="remote-data" name="remote_data">
@@ -798,8 +845,27 @@ public static function _renderTabBasic( $args ) {
 										<span class="viz-section-title"><?php _e( 'Import from CSV', 'visualizer' ); ?></span>
 										<div class="only-pro-anchor">	
 											<div class="viz-section-items section-items">
-												<p class="viz-group-description"><?php echo sprintf( __( 'You can use this to import data from a remote CSV file or %1$sGoogle Spreadsheet%2$s.', 'visualizer' ), '<a href="https://docs.themeisle.com/article/607-how-can-i-populate-data-from-google-spreadsheet" target="_blank" >', '</a>' ); ?> </p>
-												<p class="viz-group-description viz-info-msg"><b><?php echo sprintf( __( 'If you are unsure about how to format your data CSV then please take a look at this sample: %1$s %2$s%3$s. If you are using non-English characters, please make sure you save the file in UTF-8 encoding.', 'visualizer' ), '<a href="' . VISUALIZER_ABSURL . 'samples/' . $type . '.csv" target="_blank">', $type, '.csv</a>' ); ?></b></p>
+												<p class="viz-group-description">
+													<?php
+													echo sprintf(
+														// translators: %1$s - HTML link tag, %2$s - HTML closing link tag.
+														__( 'You can use this to import data from a remote CSV file or %1$sGoogle Spreadsheet%2$s.', 'visualizer' ),
+														'<a href="https://docs.themeisle.com/article/607-how-can-i-populate-data-from-google-spreadsheet" target="_blank" >',
+														'</a>'
+													);
+													?>
+												</p>
+												<p class="viz-group-description viz-info-msg">
+													<b>
+														<?php
+														echo sprintf(
+															// translators: %s - the chart type with the link attached.
+															__( 'If you are unsure about how to format your data CSV then please take a look at this sample: %s. If you are using non-English characters, please make sure you save the file in UTF-8 encoding.', 'visualizer' ),
+															'<a href="' . VISUALIZER_ABSURL . 'samples/' . $type . '.csv" target="_blank">' . $type . '.csv</a>'
+														);
+														?>
+													</b>
+												</p>
 												<form id="vz-one-time-import" action="<?php echo $upload_link; ?>" method="post"
 													target="thehole" enctype="multipart/form-data">
 													<div class="remote-file-section">

classes/Visualizer/Render/Library.php

@@ -61,7 +61,11 @@ private function _renderMessages() {
 		if ( ! filter_var( ini_get( 'allow_url_fopen' ), FILTER_VALIDATE_BOOLEAN ) ) {
 			echo '<div class="updated error">';
 			echo '<p>';
-			printf( esc_html__( '%s option is disabled in your php.ini config. Please, enable it by change its value to 1. This option increases the speed of remote CSV uploading.', 'visualizer' ), '<b>allow_url_fopen</b>' );
+			printf(
+				// translators: %s - the name of the option.
+				esc_html__( '%s option is disabled in your php.ini config. Please, enable it by change its value to 1. This option increases the speed of remote CSV uploading.', 'visualizer' ),
+				'<b>allow_url_fopen</b>'
+			);
 			echo '</p>';
 			echo '</div>';
 		}

classes/Visualizer/Render/Sidebar.php

@@ -125,7 +125,12 @@ protected function _renderChartTitleSettings() {
 			esc_html__( 'Chart Description', 'visualizer' ),
 			'description',
 			$this->description,
-			sprintf( esc_html__( 'Description to display in the structured data schema as explained %1$shere%2$s', 'visualizer' ), '<a href="https://developers.google.com/search/docs/data-types/dataset#dataset" target="_blank">', '</a>' )
+			sprintf(
+				// translators: %1$s - HTML link tag, %2$s - HTML closing link tag.
+				esc_html__( 'Description to display in the structured data schema as explained %1$shere%2$s', 'visualizer' ),
+				'<a href="https://developers.google.com/search/docs/data-types/dataset#dataset" target="_blank">',
+				'</a>'
+			)
 		);
 	}
 
@@ -134,7 +139,15 @@ protected function _renderChartTitleSettings() {
 	 */
 	protected function _renderManualConfigDescription() {
 		self::_renderSectionStart();
-			self::_renderSectionDescription( '<span class="viz-gvlink">' . sprintf( __( 'Configure the graph by providing configuration variables right from the %1$sGoogle Visualization API%2$s. You can refer to to some examples %3$shere%4$s.', 'visualizer' ), '<a href="https://developers.google.com/chart/interactive/docs/gallery/?#configuration-options" target="_blank">', '</a>', '<a href="https://docs.themeisle.com/article/728-manual-configuration" target="_blank">', '</a>' ) . '</span>' );
+			self::_renderSectionDescription(
+				'<span class="viz-gvlink">' . sprintf(
+				// translators: %1$s - HTML link tag, %2$s - HTML closing link tag, %3$s - HTML link tag, %4$s - HTML closing link tag.
+					__( 'Configure the graph by providing configuration variables right from the %1$sGoogle Visualization API%2$s. You can refer to to some examples %3$shere%4$s.', 'visualizer' ), '<a href="https://developers.google.com/chart/interactive/docs/gallery/?#configuration-options" target="_blank">',
+					'</a>',
+					'<a href="https://docs.themeisle.com/article/728-manual-configuration" target="_blank">',
+					'</a>'
+				) . '</span>'
+			);
 	}
 
 	/**
@@ -185,6 +198,7 @@ protected function _renderAdvancedSettings() {
 				'manual',
 				$this->manual,
 				sprintf(
+					// translators: %s - the format.
 					esc_html__( 'One per line in valid JSON (key:value) format e.g. %s', 'visualizer' ),
 					'<br><code>' . $this->_renderManualConfigExample() . '</code>'
 				),
@@ -461,7 +475,12 @@ protected function _renderFormatField( $index = 0 ) {
 					esc_html__( 'Number Format', 'visualizer' ),
 					'series[' . $index . '][format]',
 					isset( $this->series[ $index ]['format'] ) ? $this->series[ $index ]['format'] : '',
-					sprintf( esc_html__( 'Enter custom format pattern to apply to this series value, similar to the %1$sICU pattern set%2$s. Use something like #,### to get 1,234 as output, or $# to add dollar sign before digits. Pay attention that if you use &#37; percentage format then your values will be multiplied by 100.', 'visualizer' ), '<a href="http://icu-project.org/apiref/icu4c/classDecimalFormat.html#_details" target="_blank">', '</a>' ),
+					sprintf(
+						// translators: %1$s - HTML link tag, %2$s - HTML closing link tag.
+						esc_html__( 'Enter custom format pattern to apply to this series value, similar to the %1$sICU pattern set%2$s. Use something like #,### to get 1,234 as output, or $# to add dollar sign before digits. Pay attention that if you use &#37; percentage format then your values will be multiplied by 100.', 'visualizer' ),
+						'<a href="http://icu-project.org/apiref/icu4c/classDecimalFormat.html#_details" target="_blank">',
+						'</a>'
+					),
 					'#,###.##'
 				);
 				break;
@@ -472,7 +491,12 @@ protected function _renderFormatField( $index = 0 ) {
 					esc_html__( 'Date Format', 'visualizer' ),
 					'series[' . $index . '][format]',
 					isset( $this->series[ $index ]['format'] ) ? $this->series[ $index ]['format'] : '',
-					sprintf( esc_html__( 'Enter custom format pattern to apply to this series value, similar to the %1$sICU date and time format%2$s.', 'visualizer' ), '<a href="https://unicode-org.github.io/icu/userguide/format_parse/datetime/#datetime-format-syntax" target="_blank">', '</a>' ),
+					sprintf(
+						// translators: %1$s - HTML link tag, %2$s - HTML closing link tag.
+						esc_html__( 'Enter custom format pattern to apply to this series value, similar to the %1$sICU date and time format%2$s.', 'visualizer' ),
+						'<a href="https://unicode-org.github.io/icu/userguide/format_parse/datetime/#datetime-format-syntax" target="_blank">',
+						'</a>'
+					),
 					'eeee, dd LLLL yyyy'
 				);
 				break;
@@ -588,7 +612,14 @@ protected function _renderChartControlsGroup() {
 			echo '<div style="position: relative">';
 		}
 		self::_renderSectionStart();
-		self::_renderSectionDescription( '<span class="viz-gvlink">' . sprintf( __( 'Configure the data filter controls by providing configuration variables right from the %1$sChart Controls API%2$s. ', 'visualizer' ), '<a href="https://developers.google.com/chart/interactive/docs/gallery/controls#controls-gallery" target="_blank">', '</a>' ) . '</span>' );
+		self::_renderSectionDescription(
+			'<span class="viz-gvlink">' . sprintf(
+			// translators: %1$s - HTML link tag, %2$s - HTML closing link tag.
+				__( 'Configure the data filter controls by providing configuration variables right from the %1$sChart Controls API%2$s. ', 'visualizer' ),
+				'<a href="https://developers.google.com/chart/interactive/docs/gallery/controls#controls-gallery" target="_blank">',
+				'</a>'
+			) . '</span>'
+		);
 		self::_renderSectionEnd();
 		$this->_renderChartControlsSettings();
 		if ( ! Visualizer_Module_Admin::proFeaturesLocked() ) {
@@ -632,7 +663,12 @@ protected function _renderChartControlsSettings() {
 				$column_type            = isset( $column['type'] ) ? $column['type'] : '';
 				$label                  = isset( $column['label'] ) ? $column['label'] : '';
 				$column_label[ $label ] = $label;
-				$column_index[ $key ]   = sprintf( __( '%1$d — Column Type: %2$s ', 'visualizer' ), $key, ucfirst( $column_type ) );
+				$column_index[ $key ]   = sprintf(
+					// translators: %1$d - the column key, %2$s - the column type.
+					__( '%1$d — Column Type: %2$s ', 'visualizer' ),
+					$key,
+					ucfirst( $column_type )
+				);
 			}
 		}
 

classes/Visualizer/Render/Sidebar/ChartJS.php

@@ -180,7 +180,12 @@ protected function _renderChartTitleSettings() {
 			esc_html__( 'Chart Description', 'visualizer' ),
 			'description',
 			$this->description,
-			sprintf( esc_html__( 'Description to display in the structured data schema as explained %1$shere%2$s', 'visualizer' ), '<a href="https://developers.google.com/search/docs/data-types/dataset#dataset" target="_blank">', '</a>' )
+			sprintf(
+				// translators: %1$s - HTML link tag, %2$s - HTML closing link tag.
+				esc_html__( 'Description to display in the structured data schema as explained %1$shere%2$s', 'visualizer' ),
+				'<a href="https://developers.google.com/search/docs/data-types/dataset#dataset" target="_blank">',
+				'</a>'
+			)
 		);
 
 	}
@@ -387,7 +392,16 @@ protected function _renderTooltipSettigns() {
 	 */
 	protected function _renderManualConfigDescription() {
 		self::_renderSectionStart();
-			self::_renderSectionDescription( '<span class="viz-gvlink">' . sprintf( __( 'Configure the graph by providing configuration variables right from the %1$sChartJS API%2$s. You can refer to to some examples %3$shere%4$s.', 'visualizer' ), '<a href="https://www.chartjs.org/docs/latest/configuration/" target="_blank">', '</a>', '<a href="https://docs.themeisle.com/article/728-manual-configuration" target="_blank">', '</a>' ) . '</span>' );
+			self::_renderSectionDescription(
+				'<span class="viz-gvlink">' . sprintf(
+					// translators: %1$s - HTML link tag, %2$s - HTML closing link tag, %3$s - HTML link tag, %4$s - HTML closing link tag.
+					__( 'Configure the graph by providing configuration variables right from the %1$sChartJS API%2$s. You can refer to to some examples %3$shere%4$s.', 'visualizer' ),
+					'<a href="https://www.chartjs.org/docs/latest/configuration/" target="_blank">',
+					'</a>',
+					'<a href="https://docs.themeisle.com/article/728-manual-configuration" target="_blank">',
+					'</a>'
+				) . '</span>'
+			);
 	}
 
 	/**

classes/Visualizer/Render/Sidebar/Google.php

@@ -152,7 +152,14 @@ protected function _renderRoleField( $index ) {
 				'tooltip' => esc_html__( 'Tooltip', 'visualizer' ),
 				'interval' => esc_html__( 'Interval', 'visualizer' ),
 			),
-			sprintf( esc_html__( 'Determines whether the series has to be used for a special role as mentioned in %1$shere%2$s. You can view a few examples %3$shere%4$s.', 'visualizer' ), '<a href="https://developers.google.com/chart/interactive/docs/roles#what-roles-are-available" target="_blank">', '</a>', '<a href="https://docs.themeisle.com/article/1160-roles-for-series-visualizer" target="_blank">', '</a>' )
+			sprintf(
+				// translators: %1$s - HTML link tag, %2$s - HTML closing link tag, %3$s - HTML link tag, %4$s - HTML closing link tag
+				esc_html__( 'Determines whether the series has to be used for a special role as mentioned in %1$shere%2$s. You can view a few examples %3$shere%4$s.', 'visualizer' ),
+				'<a href="https://developers.google.com/chart/interactive/docs/roles#what-roles-are-available" target="_blank">',
+				'</a>',
+				'<a href="https://docs.themeisle.com/article/1160-roles-for-series-visualizer" target="_blank">',
+				'</a>'
+			)
 		);
 	}