Skip to content

Commit

Permalink
Consistent spelling of EZ-Page
Browse files Browse the repository at this point in the history
  • Loading branch information
scottcwilson committed May 13, 2024
1 parent ded5efe commit 8e14df8
Show file tree
Hide file tree
Showing 9 changed files with 23 additions and 17 deletions.
2 changes: 1 addition & 1 deletion content/user/accessibility/concerns/alt_text.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ weight: 10

## Introduction

Alt text, short for alternative text, is a crucial aspect of web accessibility. It is used to provide a text alternative to non-text content such as images, videos, and graphics. Alt text ensures that users with visual impairments or those using assistive technologies, such as screen readers, can understand the content conveyed by these elements. The good news is that most of your alt text needs are met by the Zen Cart software. However, images you add to areas other than categories or products (e.g., define_ or EZpages) will need to have alt text added. In this article, we will explore the importance of alt text in web accessibility and recommend some best practices for creating effective alt text.
Alt text, short for alternative text, is a crucial aspect of web accessibility. It is used to provide a text alternative to non-text content such as images, videos, and graphics. Alt text ensures that users with visual impairments or those using assistive technologies, such as screen readers, can understand the content conveyed by these elements. The good news is that most of your alt text needs are met by the Zen Cart software. However, images you add to areas other than categories or products (e.g., Define Pages or EZ-Pages) will need to have alt text added. In this article, we will explore the importance of alt text in web accessibility and recommend some best practices for creating effective alt text.

## The Importance of Alt Text in Web Accessibility

Expand Down
2 changes: 1 addition & 1 deletion content/user/admin/meta_tags.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ Just follow the pattern as explained:
// NOTE: If HOME_PAGE_TITLE is left blank (default) then TITLE and SITE_TAGLINE will be used instead.
define('HOME_PAGE_TITLE', ''); // usually best left blank
// EZ-Pages meta-tags. Follow this pattern for all ez-pages for which you desire custom metatags. Replace the # with ezpage id.
// EZ-Pages meta-tags. Follow this pattern for all ez-pages for which you desire custom metatags. Replace the # with the EZ-Page id.
// If you wish to use defaults for any of the 3 items for a given page, simply do not define it.
// (ie: the Title tag is best not set, so that site-wide defaults can be used.)
// repeat pattern as necessary
Expand Down
2 changes: 1 addition & 1 deletion content/user/customizing/add_pages.md
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@ The use of PHP in new pages is subject to the following restrictions:

Mechanism | Restrictions
----------|--------------
EZ Pages | not allowed
EZ-Pages | not allowed
Built in extra pages | allowed, no restrictions
Plugins | allowed, no restrictions (assuming plugin creates a custom page)
New Custom Page | allowed, no restrictions
Expand Down
10 changes: 5 additions & 5 deletions content/user/customizing/creating_links.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ But sometimes you won't be able to use PHP. Examples of this situation are:

- Modifying a category description to add a link
- Modifying a product description to add a link
- Modifying an EZ Page to add a link
- Modifying an EZ-Page to add a link

No worries, even though you can't use PHP, you can still create a link to another page using straight HTML.

Expand Down Expand Up @@ -42,8 +42,8 @@ To link to category 9, the Anvils category, you would use
<a href="index.php?main_page=index&cPath=9">Anvils</a>
```

## Linking to an EZ Page from HTML
To link to EZ Page 8, titled "FAQ", you would use
## Linking to an EZ-Page from HTML
To link to EZ-Page 8, titled "FAQ", you would use

```
<a href="index.php?main_page=page&id=8">FAQ</a>
Expand Down Expand Up @@ -97,9 +97,9 @@ $cat_id = 9;
echo '<a href="' . zen_href_link(FILENAME_DEFAULT, "cPath=".$cat_id) . '">' . zen_get_category_name($cat_id) .'</a>';
```

## Linking to an EZ Page from PHP
## Linking to an EZ-Page from PHP

To link to EZ Page 19,
To link to EZ-Page 19,
```
$pages_id = 19;
echo '<a href="' . zen_ez_pages_link($pages_id) . '"></a>';
Expand Down
2 changes: 1 addition & 1 deletion content/user/ezpages/ezpages_display.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ If you're in HTML (say in a list), you would use
or if it's pure HTML (being edited in plain text editor, for example), to do it without PHP would be

```
<li><a href="index.php?main_page=page&id=19">title-of-ezpage-19</a></li>
<li><a href="index.php?main_page=page&id=19">title-of-EZ-Page-19</a></li>
```

You would define `NEW_PAGE_TITLE` in a file like, `includes/languages/english/extra_definitions/my_ezpages.php` as follows:
Expand Down
12 changes: 9 additions & 3 deletions content/user/search/xml_site_map.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,16 @@
---
title: XML Site Map Page
description: A sitemap for search engines
title: XML Site Map
description: Building a sitemap for search engines
category: search
weight: 10
---

## Building your Site Map

Search engines like Google prefer to consume site maps in XML, which is more efficient than a site map created in HTML, with markup to make it attractive to humans. Sitemaps produced for search engines are designed using the format defined by [sitemaps.org](https://www.sitemaps.org/index.html).

A plugin is available to produce an [XML sitemap for your store](https://www.zen-cart.com/downloads.php?do=file&id=367). After installing and running this plugin, you can submit the resultant files to Google for indexing.


The XML sitemap is a series of text files that follow a specific format. Here's what one entry from the product sitemap might look like:

```
Expand Down Expand Up @@ -40,3 +41,8 @@ Submitting a non-canonical URL like this will yield the following from Google:
![URL inspection error](/images/URL_inspection.png)

When you switch to a sitemap that uses canonical URLs, the page will be indexed.

## Submitting your Site Map

The instructions for submitting your sitemap to various crawlers change all the time. The best way to figure out how to do this is to do a web search for "submit sitemap to `name-of-search-engine`" and look for a page from the search engine provider (Google, Microsoft, etc.).

4 changes: 2 additions & 2 deletions content/user/seo/optimizing_seo.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ For EVERY INDIVIDUAL page, category, product on your site, look at these parts:

Parts To Look At |
-----------------|
Page Title (Product/Category Name, or EZ Page Title) |
Page Title (Product/Category Name, or EZ-Page Title) |
Page Content (eg: Product/Category description, or Article text) |
Metatags Title (This will be shown in search results) |
Metatags Description (This is the sub-text shown in search results) |
Expand Down Expand Up @@ -101,7 +101,7 @@ And, if you have products that are related to other products, where it feels lik


### Articles and other content
EZ Pages can be a place to write articles that can educate customers, celebrate creative uses of your products, and highlight success stories.
EZ-Pages can be a place to write articles that can educate customers, celebrate creative uses of your products, and highlight success stories.

Articles should contain keywords (phrases) that your customers are searching for. And these articles should contain links to the products that your articles are referring to.

Expand Down
4 changes: 2 additions & 2 deletions content/user/sideboxes/add_link_information_sidebox.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ weight: 10

This page continues the FAQ on [customizing the Information Sidebox](/user/sideboxes/information_sidebox/). It is such a common question is has been pulled out to its own page.

The same technique can be used to add a link to the [More Information sidebox](/user/sideboxes/more_information_sidebox/) or the [EZ Page sidebox](/user/sideboxes/ezpages_sidebox/) just by changing the file being edited.
The same technique can be used to add a link to the [More Information sidebox](/user/sideboxes/more_information_sidebox/) or the [EZ-Page sidebox](/user/sideboxes/ezpages_sidebox/) just by changing the file being edited.

To add a link to the Information Sidebox, we create the [override file](/user/first_steps/overrides/) `includes/templates/YOURTEMPLATE/sideboxes/tpl_information.php`.

Expand Down Expand Up @@ -54,7 +54,7 @@ $information[] = '<a href="https://www.zen-cart.com/" target="_blank" rel="noref

The same process could be used to add a link to the More Information sidebox, using the `$more_information` array in place of `$information`.

However, adding a link to the EZ Pages sidebox using this technique would be more involved, since the entries in `$var_linksList` are arrays, not simple strings.
However, adding a link to the EZ-Pages sidebox using this technique would be more involved, since the entries in `$var_linksList` are arrays, not simple strings.

### Specification of URLs
It's a good practice not to hardcode non-relative URLs, in case your site moves or you want to reconstruct a test instance of it. So don't do this:
Expand Down
2 changes: 1 addition & 1 deletion content/user/troubleshooting/missing_ezpage.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ weight: 10

**Issue:** When I visit my page, I get the error message, "Sorry, the page you were attempting to access cannot be found."

This means you have not configured the EZPage correctly. You need to set
This means you have not configured the EZ-Page correctly. You need to set
the radio button to *Yes* and the sort order to a value > 0 for either the
Header, the Sidebox or the Footer. Alternately, in Zen Cart 1.5.6 and above,
you can set the *Page is Visible* radio button to *Yes*. See the help for [Tools > EZ-Pages](/user/admin_pages/tools/ezpages/) for more details.
Expand Down

0 comments on commit 8e14df8

Please sign in to comment.