Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Improvements to help pages #78

Merged
merged 1 commit into from
May 18, 2020
Merged

Improvements to help pages #78

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
4 changes: 3 additions & 1 deletion assets/admin/css/common.css
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
.cpseo-wrap h2{font-size:2.7em;font-weight:300;line-height:1.3;margin:40px 0 .6em;text-align:center}
.cpseo-wrap .page-title{font-size:2em;font-weight:400;line-height:1;margin:35px 0 20px}
.cpseo-wrap h3{font-size:1.2em;line-height:1.5;margin:1.2em 0 .6em;color:#057f99}
.cpseo-wrap h4{color:#23282d}
.cpseo-wrap h4{color:#057f99}
.cpseo-wrap ol li p{font-size:14px;font-weight:400}
.cpseo-wrap .cpseo-text{font-size:19px;font-weight:400;line-height:1.6em;min-height:40px;margin:1em 200px 1em 0;margin-top:1.4em;color:#555d66}
.cpseo-wrap .nav-tab{font-size:18px;padding-right:15px;padding-left:15px}
Expand Down Expand Up @@ -46,6 +46,8 @@
.cpseo-tabs-navigation:not(.cpseo-custom){float:left;width:200px;margin-right:-1px}
.cpseo-tabs-navigation:not(.cpseo-custom) a{font-size:16px;display:block;box-sizing:border-box;padding:11px 15px;text-decoration:none;color:#6c6c6c;border:solid #e5e5e5;border-width:0 1px 1px;outline:none;background:#f6f6f6;box-shadow:none}
.cpseo-tabs-navigation:not(.cpseo-custom) a .dashicons,.cpseo-tabs-navigation:not(.cpseo-custom) a .fa,.cpseo-tabs-navigation:not(.cpseo-custom) a .image-icon{font-size:18px;min-width:20px;margin-right:10px;text-align:center;color:#6c6c6c}
.cpseo-tabs-navigation:not(.cpseo-custom) a [class*=" dashicons-visual-"], .cpseo-tabs-navigation:not(.cpseo-custom) a [class*=" dashicons-visual-"] {opacity:1;filter: brightness(0.4);}
.cpseo-tabs-navigation:not(.cpseo-custom) a:hover [class*=" dashicons-visual-"], .cpseo-tabs-navigation:not(.cpseo-custom) a:hover [class*=" dashicons-visual-"] {opacity:1;filter: brightness(1);}
.cpseo-tabs-navigation:not(.cpseo-custom) a .image-icon img {width:20px;height:20px;max-width:20px;max-height:20px;}
.cpseo-tabs-navigation:not(.cpseo-custom) a.active,.cpseo-tabs-navigation:not(.cpseo-custom) a:focus,.cpseo-tabs-navigation:not(.cpseo-custom) a:hover{color:#fff;background:#361946}
.cpseo-tabs-navigation:not(.cpseo-custom) a.active .dashicons,.cpseo-tabs-navigation:not(.cpseo-custom) a.active .fa,.cpseo-tabs-navigation:not(.cpseo-custom) a:focus .dashicons,.cpseo-tabs-navigation:not(.cpseo-custom) a:focus .fa,.cpseo-tabs-navigation:not(.cpseo-custom) a:hover .dashicons,.cpseo-tabs-navigation:not(.cpseo-custom) a:hover .fa{color:#fff}
Expand Down
4 changes: 0 additions & 4 deletions includes/admin/views/help-manager.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,10 +20,6 @@
'title' => esc_html__( 'Local SEO', 'cpseo' ),
'view' => 'help/local-seo.php',
),
'variables' => array(
'title' => esc_html__( 'Variables', 'cpseo' ),
'view' => 'help/variables.php',
),
'developers' => array(
'title' => esc_html__( 'Developers', 'cpseo' ),
'view' => 'help/developers.php',
Expand Down
49 changes: 48 additions & 1 deletion includes/admin/views/help/developers.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,4 +9,51 @@

?>

<h3><?php esc_html_e( 'Coming Soon', 'cpseo' ); ?></h3>
<h3><?php esc_html_e( 'Filters and Hooks', 'cpseo' ); ?></h3>


<p><?php esc_html_e( 'There are a number of hooks and filters in Classic SEO that developers can use to interact with data output by Classic SEO. Here\'s a few of them.', 'cpseo' ); ?></p>

<h4><?php esc_html_e( 'Filter to show/hide SEO Metabox', 'cpseo' ); ?></h4>
<p><?php esc_html_e( 'To hide the SEO metabox, return false.', 'cpseo' ); ?></p>
<?php
$code1 = 'add_filter( \'cpseo/metabox/add_seo_metabox\', function( $default ) {
return $default;
});';
?>
<p><pre><code><?php esc_html_e($code1); ?></code></pre></p>

<hr>

<h4><?php esc_html_e( 'Filter to change the position of the SEO metabox', 'cpseo' ); ?></h4>
<p><?php esc_html_e( 'Options for $priority are: \'low\', \'default\', \'core\', \'high\'.', 'cpseo' ); ?></p>
<?php
$code2 = 'add_filter( \'cpseo/metabox/priority\', function( $priority ) {
return $priority;
});';
?>
<p><pre><code><?php esc_html_e($code2); ?></code></pre></p>

<hr>

<h4><?php esc_html_e( 'Filter to change taxonomy icons in the options panel', 'cpseo' ); ?></h4>
<p><?php esc_html_e( 'This example sets the icon for the custom \'event_cat\' taxonomy to \'dashicons dashicons-category\'.', 'cpseo' ); ?></p>
<?php
$code3 = 'add_filter( \'cpseo/taxonomy_icons\', function( $icons ) {
$icons[\'event_cat\'] = \'dashicons dashicons-category\';
return $icons;
});';
?>
<p><pre><code><?php esc_html_e($code3); ?></code></pre></p>

<hr>

<h4><?php esc_html_e( 'Filter to change taxonomy icons in the options panel', 'cpseo' ); ?></h4>
<p><?php esc_html_e( 'This example sets the icon for the custom \'event\' post type to \'dashicons dashicons-calendar\'.', 'cpseo' ); ?></p>
<?php
$code4 = 'add_filter( \'cpseo/post_type_icons\', function( $icons ) {
$icons[\'event\'] = \'dashicons dashicons-calendar\';
return $icons;
});';
?>
<p><pre><code><?php esc_html_e($code4); ?></code></pre></p>
11 changes: 7 additions & 4 deletions includes/admin/views/help/getting-started.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,24 +10,24 @@
?>
<h3><?php esc_html_e( 'Getting started with Classic SEO', 'cpseo' ); ?></h3>
<p>
<?php esc_html_e( 'Classic SEO is a Search Engine Optimization plugin built specifically for ClassicPress. It is based on Rank Math but there some differences both in the way it works and "behind the scenes".', 'cpseo' ); ?>
<?php esc_html_e( 'Classic SEO is a Search Engine Optimization plugin built specifically for ClassicPress. It is based on Rank Math but there are some key differences both in the way it works and "behind the scenes".', 'cpseo' ); ?>
</p>
<p>
<?php esc_html_e( 'While Rank Math provides support for bbPress, BuddyPress and AMP, Classic SEO does not and probably never will. Likewise, it is unlikely that Classic SEO will ever feature the ability to edit .htaccess and robots.txt.', 'cpseo' ); ?>
</p>
<p>
<?php esc_html_e( 'Another difference is that Classic SEO does not have the SEO Analysis tool.', 'cpseo' ); ?>
<?php esc_html_e( 'A couple of other differences are that Classic SEO does not have the SEO Analysis tool and it does not support the Gutenberg block editor.', 'cpseo' ); ?>
</p>
<h3><?php esc_html_e( 'Found a bug?', 'cpseo' ); ?></h3>
<p>
<?php esc_html_e( 'It should be noted that Classic SEO is still in the early stages of development and bugs are likely.', 'cpseo' ); ?>
<?php esc_html_e( 'It should be noted that Classic SEO is still in the early stages of development and bugs are likely.', 'cpseo' ); ?>
</p>
<p>
<?php
printf(
/* translators: 1: Link to ClassicPress Forums 2: Link to GitHub */
__('If you do find what looks like a bug, please either report it on the <a rel="nofollow noopener noreferrer" href="%1$s" target="_blank">ClassicPress forums</a> or <a rel="nofollow noopener noreferrer" href="%2$s" target="_blank">open an issue on GitHub</a>.', 'cpseo' ),
'https://forums.classicpress.net/tags/classic-seo', 'https://github.com/ClassicPress-research/classicpress-seo/issues'); ?>
'https://forums.classicpress.net/tags/classic-seo', 'https://github.com/ClassicPress-plugins/classicpress-seo/issues'); ?>
</p>
<h3><?php esc_html_e( 'Plans for future releases', 'cpseo' ); ?></h3>
<p>
Expand All @@ -37,6 +37,9 @@
__('A key future addition to Classic SEO will be support for <a rel="nofollow noopener noreferrer" href="%1$s" target="_blank">Classic Commerce</a>.', 'cpseo' ),
'https://github.com/ClassicPress-research/classic-commerce'); ?>
</p>
<p>
<?php esc_html_e( 'It is also planned to improve support for the most popular page builders such as Beaver Builder, Divi and Elementor.', 'cpseo' ); ?>
</p>
<p>
<?php
printf(
Expand Down
6 changes: 3 additions & 3 deletions includes/admin/views/help/local-seo.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,10 @@
?>
<h3><?php esc_html_e( 'Local SEO', 'cpseo' ); ?></h3>
<p>
<?php esc_html_e( 'Local SEO is a way for you to rank better for searches made by your people in the area where you operate. It is the best way for you to get your products and services in front of the local customers.', 'cpseo' ); ?>
<?php esc_html_e( 'Local SEO is a way for you to rank better for searches made by people local to the area in which you operate. It is the best way for you to get your products and services in front of the local customers.', 'cpseo' ); ?>
</p>
<p>
<?php esc_html_e( 'There are various methods for optimizing your website for local SEO but the easiest method is built right inside the Classic SEO plugin.', 'cpseo' ); ?>
<?php esc_html_e( 'There are various methods for optimizing your website for local SEO but Classic SEO has many tools to help.', 'cpseo' ); ?>
</p>

<p>
Expand All @@ -23,7 +23,7 @@
<?php
printf(
/* translators: link to local seo settings */
__( 'Then, head over to <a href="%1$s">Classic SEO > Titles and Meta > Local SEO</a> and add more information about your Local Business like your Company Name, Logo, Email ID, Phone number, Address, And Contact/About pages.', 'cpseo' ),
__( 'Then, head over to <a href="%1$s">Classic SEO > Titles and Meta > Local SEO</a> and add more information about your Local Business like your Company Name, Logo, Email ID, Phone number, Address and Contact/About pages.', 'cpseo' ),
Helper::get_admin_url( 'options-titles#setting-panel-local' )
);
?>
Expand Down