Skip to content

Commit

Permalink
code cleanup
Browse files Browse the repository at this point in the history
  • Loading branch information
zsoltoroszlany82 committed Oct 31, 2024
1 parent 76aa338 commit d0e1c83
Show file tree
Hide file tree
Showing 7 changed files with 49 additions and 12 deletions.
10 changes: 3 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Playful Sparkle - Google Sitemap for OpenCart 3

The **Playful Sparkle - Google Sitemap** extension for OpenCart 3 is a user-friendly tool designed to enhance your online store's visibility in search engines. This extension simplifies the creation of XML sitemaps, which are crucial for helping search engines crawl and index your website effectively.
The **Playful Sparkle - Google Sitemap** for OpenCart 3.x is a user-friendly tool designed to enhance your online store's visibility in search engines. This extension simplifies the creation of XML sitemaps, which are crucial for helping search engines crawl and index your website effectively.

The extension streamlines the process of submitting relevant information to Google. It allows users to create focused sitemaps that highlight important pages while optimizing their site for multilingual audiences. With the extension, sitemap updates are automated, saving users time and ensuring that their information remains accurate and current.

Expand All @@ -17,16 +17,12 @@ The extension streamlines the process of submitting relevant information to Goog
- **Multilingual Support**: Generate language-specific XML sitemaps, ensuring URLs, titles, and descriptions are displayed in the chosen language for submission to Google Search Console.
- **Automatic Updates**: Automatically updates the sitemap with any changes to your store’s content.
- **User-Friendly Setup**: Enjoy a seamless setup process through the OpenCart interface, designed for ease of use and efficiency.
- **Full Compatibility**: Fully compatible with OpenCart v4.x, ensuring smooth integration with your existing setup.
- **Full Compatibility**: Fully compatible with OpenCart 3.x, ensuring smooth integration with your existing setup.

---

## Installation Instructions

### Important Note

OpenCart requires all extension package filenames to end in the `.ocmod.zip` format for successful installation. The `ps_google_sitemap` extension adheres to this naming convention to ensure compatibility with OpenCart's installer.

### 1. Download the Extension
Download the latest **Playful Sparkle - Google Sitemap** release from this repository.

Expand All @@ -51,7 +47,7 @@ Download the latest **Playful Sparkle - Google Sitemap** release from this repos

## Support & Feedback

For support or any inquiries regarding the extensions, feel free to open an issue on this repository or reach out via email at `support@playfulsparkle.com`.
For support or any inquiries regarding the extension, feel free to open an issue on this repository or reach out via email at [support@playfulsparkle.com](mailto:support@playfulsparkle.com).

---

Expand Down
41 changes: 41 additions & 0 deletions src/installation.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
Playful Sparkle - Google Sitemap

The Playful Sparkle - Google Sitemap for OpenCart 3.x is a user-friendly tool designed to enhance your online store's visibility in search engines. This extension simplifies the creation of XML sitemaps, which are crucial for helping search engines crawl and index your website effectively.

The extension streamlines the process of submitting relevant information to Google. It allows users to create focused sitemaps that highlight important pages while optimizing their site for multilingual audiences. With the extension, sitemap updates are automated, saving users time and ensuring that their information remains accurate and current.

For more information, visit the extension GitHub page at https://github.com/playfulsparkle/oc3_google_sitemap.git.

Demo frontend - https://opencart3.playfulsparkle.com/
Demo backend - https://opencart3.playfulsparkle.com/admin/

Key Features

* Customizable Sitemap Generation: Choose which content types to include (products, categories, manufacturers, informational pages).
* Multilingual Support: Create language-specific XML sitemaps with URLs, titles, and descriptions in the chosen language.
* Automatic Updates: The sitemap updates automatically with any changes to your store’s content.
* User-Friendly Setup: Simple installation through the OpenCart interface for easy use.
* Full Compatibility: Works seamlessly with OpenCart 3.x.

Installation Guide

1. Download the "Playful Sparkle - Google Sitemap" Extension Package.
2. Download the latest version of the Playful Sparkle - Google Sitemap extension from the link provided on this page.
3. Upload the Extension Files:
1. Log in to your OpenCart admin panel.
2. Navigate to Extensions > Installer.
3. Click the "Upload" button and upload the file ps_google_sitemap.ocmod.zip.
4. Install the Extension:
1. After uploading, click the green "Install" button.
2. Go to Extensions and select Feeds from the dropdown menu.
3. Locate the "Playful Sparkle - Google Sitemap" extension in the list.
4. Click the green "Install" button to activate it.
5. Configure the Extension:
1. Stay on the Extensions page with Feeds selected.
2. Click the "Edit" button next to the installed Playful Sparkle - Google Sitemap extension.
3. Configure your sitemap settings as needed (e.g., frequency, priority).
4. Save your configuration.

Support & Feedback

For support or any inquiries regarding the extension, feel free to open an issue on this repository or reach out via email at support@playfulsparkle.com.
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
$_['text_success'] = 'Úspěch: Upravili jste Google Sitemap feed!';
$_['text_edit'] = 'Upravit Google Sitemap';
$_['text_clear'] = 'Vymazat databázi';
$_['text_getting_started'] = '<p><strong>Přehled:</strong> Rozšíření Google Sitemap pro OpenCart 3 pomáhá zvýšit viditelnost vašeho obchodu generováním optimalizovaných XML sitemap. Tyto sitemap pomáhají vyhledávačům, jako je Google, indexovat klíčové stránky vašeho webu, což vede k lepšímu umístění ve vyhledávačích a zvýšené online přítomnosti.</p><p><strong>Požadavky:</strong> OpenCart 3.x, PHP 7.3 nebo vyšší a přístup do <a href="https://search.google.com/search-console/about?hl=cs" target="_blank" rel="external noopener noreferrer">Google Search Console</a> pro odeslání sitemap.</p>';
$_['text_getting_started'] = '<p><strong>Přehled:</strong> Rozšíření Google Sitemap pro OpenCart 3.x pomáhá zvýšit viditelnost vašeho obchodu generováním optimalizovaných XML sitemap. Tyto sitemap pomáhají vyhledávačům, jako je Google, indexovat klíčové stránky vašeho webu, což vede k lepšímu umístění ve vyhledávačích a zvýšené online přítomnosti.</p><p><strong>Požadavky:</strong> OpenCart 3.x, PHP 7.3 nebo vyšší a přístup do <a href="https://search.google.com/search-console/about?hl=cs" target="_blank" rel="external noopener noreferrer">Google Search Console</a> pro odeslání sitemap.</p>';
$_['text_setup'] = '<p><strong>Nastavení Google Sitemap:</strong> Nakonfigurujte svou sitemap tak, aby obsahovala stránky Produktů, Kategorie, Výrobce a Informací podle potřeby. Přepněte možnosti pro povolení nebo zakázání těchto typů stránek ve výstupu sitemap a přizpůsobte obsah sitemap potřebám a publiku vašeho obchodu.</p>';
$_['text_troubleshot'] = '<ul><li><strong>Rozšíření:</strong> Ujistěte se, že je rozšíření Google Sitemap povoleno v nastaveních OpenCart. Pokud je rozšíření zakázáno, výstup sitemap nebude generován.</li><li><strong>Produkt:</strong> Pokud chybí stránky Produktů ve vaší sitemap, ujistěte se, že jsou povoleny v nastaveních rozšíření a že příslušné produkty mají stav nastaven na „Povoleno“.</li><li><strong>Kategorie:</strong> Pokud se stránky Kategorií nezobrazují, zkontrolujte, zda jsou kategorie povoleny v nastaveních rozšíření a že jejich stav je také nastaven na „Povoleno“.</li><li><strong>Výrobce:</strong> Pro stránky Výrobců ověřte, zda jsou povoleny v nastaveních rozšíření a že výrobci mají stav nastaven na „Povoleno“.</li><li><strong>Informace:</strong> Pokud se stránky Informací nezobrazují v sitemap, ujistěte se, že jsou povoleny v nastaveních rozšíření a že jejich stav je nastaven na „Povoleno“.</li></ul>';
$_['text_faq'] = '<details><summary>Jak odeslat svou sitemap do Google Search Console?</summary>V Google Search Console přejděte do <em>Sitemaps</em> v menu, zadejte URL sitemap (typicky /sitemap.xml) a klikněte na <em>Odeslat</em>. Tímto upozorníte Google, aby začal procházet váš web.</details><details><summary>Proč je sitemap důležitá pro SEO?</summary>Sitemap usměrňuje vyhledávače k nejdůležitějším stránkám vašeho webu, což usnadňuje jejich přesné indexování obsahu a může pozitivně ovlivnit umístění ve vyhledávačích.</details><details><summary>Jsou obrázky zahrnuty do sitemap?</summary>Ano, obrázky jsou zahrnuty do generované sitemap tímto rozšířením, což zajišťuje, že vyhledávače mohou indexovat váš vizuální obsah spolu s URL.</details><details><summary>Proč sitemap používá <em>lastmod</em> místo <em>priority</em> a <em>changefreq</em>?</summary>Google nyní ignoruje hodnoty <priority> a <changefreq>, přičemž se zaměřuje na <lastmod> pro čerstvost obsahu. Používání <lastmod> pomáhá prioritizovat nedávné aktualizace.</details>';
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
$_['text_success'] = 'Erfolg: Sie haben den Google Sitemap-Feed geändert!';
$_['text_edit'] = 'Google Sitemap bearbeiten';
$_['text_clear'] = 'Datenbank leeren';
$_['text_getting_started'] = '<p><strong>Überblick:</strong> Die Google Sitemap-Erweiterung für OpenCart 3 hilft dabei, die Sichtbarkeit Ihres Shops zu erhöhen, indem optimierte XML-Sitemaps generiert werden. Diese Sitemaps helfen Suchmaschinen wie Google, die wichtigen Seiten Ihrer Website zu indexieren, was zu besseren Suchmaschinenrankings und einer erhöhten Online-Präsenz führt.</p><p><strong>Voraussetzungen:</strong> OpenCart 3.x, PHP 7.3 oder höher sowie Zugang zu Ihrer <a href="https://search.google.com/search-console/about?hl=de" target="_blank" rel="external noopener noreferrer">Google Search Console</a> für die Einreichung der Sitemap.</p>';
$_['text_getting_started'] = '<p><strong>Überblick:</strong> Die Google Sitemap-Erweiterung für OpenCart 3.x hilft dabei, die Sichtbarkeit Ihres Shops zu erhöhen, indem optimierte XML-Sitemaps generiert werden. Diese Sitemaps helfen Suchmaschinen wie Google, die wichtigen Seiten Ihrer Website zu indexieren, was zu besseren Suchmaschinenrankings und einer erhöhten Online-Präsenz führt.</p><p><strong>Voraussetzungen:</strong> OpenCart 3.x, PHP 7.3 oder höher sowie Zugang zu Ihrer <a href="https://search.google.com/search-console/about?hl=de" target="_blank" rel="external noopener noreferrer">Google Search Console</a> für die Einreichung der Sitemap.</p>';
$_['text_setup'] = '<p><strong>Einrichten der Google Sitemap:</strong> Konfigurieren Sie Ihre Sitemap, um nach Bedarf Produkt-, Kategorie-, Hersteller- und Informationsseiten einzuschließen. Aktivieren oder deaktivieren Sie die Optionen, um diese Seitentypen im Sitemap-Ausgang anzuzeigen, und passen Sie den Inhalt der Sitemap an die Bedürfnisse und das Publikum Ihres Shops an.</p>';
$_['text_troubleshot'] = '<ul><li><strong>Erweiterung:</strong> Stellen Sie sicher, dass die Google Sitemap-Erweiterung in Ihren OpenCart-Einstellungen aktiviert ist. Wenn die Erweiterung deaktiviert ist, wird die Sitemap nicht generiert.</li><li><strong>Produkt:</strong> Wenn Produktseiten in Ihrer Sitemap fehlen, stellen Sie sicher, dass sie in den Erweiterungseinstellungen aktiviert sind und dass der Status der relevanten Produkte auf "Aktiv" gesetzt ist.</li><li><strong>Kategorie:</strong> Wenn Kategorie-Seiten nicht angezeigt werden, überprüfen Sie, ob die Kategorien in den Erweiterungseinstellungen aktiviert sind und ob ihr Status ebenfalls auf "Aktiv" gesetzt ist.</li><li><strong>Hersteller:</strong> Überprüfen Sie für Herstellerseiten, ob sie in den Erweiterungseinstellungen aktiviert sind und ob die Hersteller ihren Status auf "Aktiv" gesetzt haben.</li><li><strong>Information:</strong> Wenn Informationsseiten in der Sitemap nicht angezeigt werden, stellen Sie sicher, dass sie in den Erweiterungseinstellungen aktiviert sind und dass ihr Status auf "Aktiv" gesetzt ist.</li></ul>';
$_['text_faq'] = '<details><summary>Wie reiche ich meine Sitemap bei der Google Search Console ein?</summary>Gehen Sie in der Google Search Console zu <em>Sitemaps</em> im Menü, geben Sie die URL der Sitemap ein (typischerweise /sitemap.xml) und klicken Sie auf <em>Einreichen</em>. Damit benachrichtigen Sie Google, Ihre Website zu crawlen.</details><details><summary>Warum ist eine Sitemap wichtig für SEO?</summary>Eine Sitemap leitet Suchmaschinen zu den wichtigsten Seiten Ihrer Website, was es ihnen erleichtert, Ihre Inhalte genau zu indexieren, was sich positiv auf die Suchrankings auswirken kann.</details><details><summary>Sind Bilder in der Sitemap enthalten?</summary>Ja, Bilder sind in der von dieser Erweiterung generierten Sitemap enthalten, sodass Suchmaschinen Ihren visuellen Inhalt zusammen mit der URL indexieren können.</details><details><summary>Warum verwendet die Sitemap <em>lastmod</em> anstelle von <em>priority</em> und <em>changefreq</em>?</summary>Google ignoriert jetzt die Werte <priority> und <changefreq> und konzentriert sich stattdessen auf <lastmod> für die Frische des Inhalts. Die Verwendung von <lastmod> hilft, kürzliche Aktualisierungen zu priorisieren.</details>';
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
$_['text_success'] = 'Success: You have modified Google Sitemap feed!';
$_['text_edit'] = 'Edit Google Sitemap';
$_['text_clear'] = 'Clear Database';
$_['text_getting_started'] = '<p><strong>Overview:</strong> The Google Sitemap extension for OpenCart 3 helps boost your store’s visibility by generating optimized XML sitemaps. These sitemaps help search engines like Google index your site’s key pages, leading to better search engine rankings and increased online presence.</p><p><strong>Requirements:</strong> OpenCart 3.x, PHP 7.3 or higher, and access to your <a href="https://search.google.com/search-console/about?hl=en" target="_blank" rel="external noopener noreferrer">Google Search Console</a> for sitemap submission.</p>';
$_['text_getting_started'] = '<p><strong>Overview:</strong> The Google Sitemap for OpenCart 3.x helps boost your store’s visibility by generating optimized XML sitemaps. These sitemaps help search engines like Google index your site’s key pages, leading to better search engine rankings and increased online presence.</p><p><strong>Requirements:</strong> OpenCart 3.x, PHP 7.3 or higher, and access to your <a href="https://search.google.com/search-console/about?hl=en" target="_blank" rel="external noopener noreferrer">Google Search Console</a> for sitemap submission.</p>';
$_['text_setup'] = '<p><strong>Setting Up Google Sitemap:</strong> Configure your sitemap to include Product, Category, Manufacturer, and Information pages as needed. Toggle the options to enable or disable these page types in the sitemap output, tailoring the sitemap content to your store’s needs and audience.</p>';
$_['text_troubleshot'] = '<ul><li><strong>Extension:</strong> Ensure that the Google Sitemap extension is enabled in your OpenCart settings. If the extension is disabled, the sitemap output will not be generated.</li><li><strong>Product:</strong> If Product pages are missing from your sitemap, ensure they are enabled in the extension settings and that the relevant products have their status set to “Enabled.”</li><li><strong>Category:</strong> If Category pages are not appearing, check that the categories are enabled in the extension settings and that their status is also set to “Enabled.”</li><li><strong>Manufacturer:</strong> For Manufacturer pages, verify that they are enabled in the extension settings and that the manufacturers have their status set to “Enabled.”</li><li><strong>Information:</strong> If Information pages are not showing in the sitemap, make sure they are enabled in the extension settings and that their status is set to “Enabled.”</li></ul>';
$_['text_faq'] = '<details><summary>How do I submit my sitemap to Google Search Console?</summary>In Google Search Console, go to <em>Sitemaps</em> in the menu, enter the sitemap URL (typically /sitemap.xml), and click <em>Submit</em>. This will notify Google to start crawling your site.</details><details><summary>Why is a sitemap important for SEO?</summary>A sitemap guides search engines to your site’s most important pages, making it easier for them to index your content accurately, which can positively impact search rankings.</details><details><summary>Are images included in the sitemap?</summary>Yes, images are included in the generated sitemap by this extension, ensuring that search engines can index your visual content along with the url.</details><details><summary>Why does the sitemap use <em>lastmod</em> instead of <em>priority</em> and <em>changefreq</em>?</summary>Google now ignores <priority> and <changefreq> values, focusing instead on <lastmod> for content freshness. Using <lastmod> helps prioritize recent updates.</details>';
Expand Down
Loading

0 comments on commit d0e1c83

Please sign in to comment.