X-Cart:HTML Catalog - Revision history

Dohtur at 09:07, 21 December 2016

2016-12-21T09:07:58Z

Dohtur at 09:07, 21 December 2016

2016-12-21T09:07:36Z

Dohtur: /* Roles in HTML catalog management */

2012-10-09T10:47:34Z

‎Roles in HTML catalog management

Admin: /* Adjusting the Format of Page Filenames for the HTML Catalog */

2010-01-29T06:44:18Z

‎Adjusting the Format of Page Filenames for the HTML Catalog

Admin: /* Adjusting the Format of Page Filenames for the HTML Catalog */

2010-01-29T06:41:12Z

‎Adjusting the Format of Page Filenames for the HTML Catalog

Admin: /* Updating Existing HTML Catalog */

2010-01-29T06:19:52Z

‎Updating Existing HTML Catalog

Admin: /* Updating Existing HTML Catalog */

2010-01-29T06:19:31Z

‎Updating Existing HTML Catalog

Admin: /* HTML catalog in X-Cart */

2010-01-29T06:18:18Z

‎HTML catalog in X-Cart

Admin: /* Generating HTML Catalog */

2010-01-29T06:17:01Z

‎Generating HTML Catalog

Admin: /* Roles in HTML catalog management */

2010-01-29T06:07:28Z

‎Roles in HTML catalog management

@@ Line 172: / Line 172: @@
 If you have a product named "Lord of the Rings /DVD/" whose product ID is defined as 24, the product page filename template for your HTML catalog is defined as <u>{prodname}-p-{productid}.html</u>, and the character for replacing spaces and slashes is defined as hyphen (-), the filename of the respective product page in the HTML catalog will be Lord-of-the-Rings-DVD-p-24.html.
-===Troobleshooting===
+==Troobleshooting==
 If you get the "Empty response" error, and your site is configured to work only using https, check that your SSL certificate is valid.
 [[Category:X-Cart user manual]]

← Older revision		Revision as of 09:07, 21 December 2016
Line 171:		Line 171:

	If you have a product named "Lord of the Rings /DVD/" whose product ID is defined as 24, the product page filename template for your HTML catalog is defined as <u>{prodname}-p-{productid}.html</u>, and the character for replacing spaces and slashes is defined as hyphen (-), the filename of the respective product page in the HTML catalog will be Lord-of-the-Rings-DVD-p-24.html.		If you have a product named "Lord of the Rings /DVD/" whose product ID is defined as 24, the product page filename template for your HTML catalog is defined as <u>{prodname}-p-{productid}.html</u>, and the character for replacing spaces and slashes is defined as hyphen (-), the filename of the respective product page in the HTML catalog will be Lord-of-the-Rings-DVD-p-24.html.
		+
		+	===Troobleshooting===
		+
		+	If you get the "Empty response" error, and your site is configured to work only using https, check that your SSL certificate is valid.

	[[Category:X-Cart user manual]]		[[Category:X-Cart user manual]]

@@ Line 32: / Line 32: @@
 == Roles in HTML catalog management ==
-If you are an X-Cart GOLD administrator/provider or an X-Cart PRO administrator:
+If you are an X-Cart GOLD or GOLD PLUS administrator/provider or an X-Cart PLATINUM or PRO administrator:
 * You can generate HTML catalogs (See [[#Generating HTML Catalog]]).
 * You can update existing HTML catalogs (See [[#Updating Existing HTML Catalog]]).
-If you are an X-Cart PRO provider:
+If you are an X-Cart PLATINUM or PRO provider:
 * You cannot generate or update HTML catalogs.

@@ Line 116: / Line 116: @@
 Adjusting the format of page filenames includes two tasks:
-# Adjusting a [http://www.x-cart.com/xcart_manual/online/adjusting_the_format_of_page_filenames.htm#pagefilenametemplate page filename template] for each type of pages in your HTML catalog.
+# Adjusting a page filename template for each type of pages in your HTML catalog.
-# Adjusting the [http://www.x-cart.com/xcart_manual/online/adjusting_the_format_of_page_filenames.htm#character4spacesslashes character for replacing spaces and slashes] in page filenames.
+# Adjusting the character for replacing spaces and slashes in page filenames.
 Both the tasks can be performed in the 'HTML catalog' section of your store's Admin area.
@@ Line 151: / Line 151: @@
 To readjust the page filename template value for a specific type of pages, do the following:
-# In the '<u>HTML catalog</u>' section, click on the [+] icon next to the template value you wish to edit. This opens the template value in edit mode:
+# In the '<u>HTML catalog</u>' section, click on the [+] icon next to the template value you wish to edit. This opens the template value in edit mode:<br><br>[[Image:page_filename_template.gif|595px]]<br><br>Now the template value is displayed inside an editable field.
+# Edit the template value.<br><br>To find out the format requirements, use the link '<u>Need help?</u>' displayed in edit mode next to the template value. When the mouse hovers over this link, a tooltip is displayed with a list of characters and special tags which can be used in the template. The set of allowed characters is the same for all the templates: alphanumeric characters (A-Z, a-z, 0-9), dot (.), hyphen (-) and underscore (_). The set of allowed special tags depends on the type of pages for which the template is intended. Note that, for each page type, there is a set of required parameters, which must be included into the page name. You will be required to include the special tags that stand for these parameters. The maximum length of a page filename template value is 200 characters (This includes the characters in the names of special tags).<br><br>Below the editable field containing the template value, you can see a set of links named after special tags. These links represent the special tags which can be used in the template. The links are provided for your convenience so you do not have to type out the names of special tags: clicking on a special tag link inserts the special tag into the template at the current cursor position; clicking the same link again removes the special tag from the template.<br><br>As you edit the template value, X-Cart dynamically checks its format for correctness. As long as the format requirements are met, the frame of the field containing the template value being edited is displayed as green. If the frame of the template field becomes red, and an error message is displayed, it means that the format of the template value is invalid and must be changed.<br><br>
 # At any moment, you can use the Reset link to undo any changes you made to the template value during the current editing session. Clicking on this link resets the template value to its pre-editing state.
 # After you are done editing, click the '''Apply''' button to save the changes.
@@ Line 172: / Line 160: @@
 {{Note1|Note: At this point, the changes made to the template are not yet saved. The saving is done when you click the Generate catalog button at the bottom of the 'HTML catalog' dialog box to start catalog generation.}}
-# To exit template edit mode, click the [ - ] icon next to the template you are editing.
+To exit template edit mode, click the [ - ] icon next to the template you are editing.
 === Adjusting the character for replacing spaces and slashes  in page filenames ===

← Older revision		Revision as of 06:41, 29 January 2010
Line 111:		Line 111:

	==Adjusting the Format of Page Filenames for the HTML Catalog==		==Adjusting the Format of Page Filenames for the HTML Catalog==
		+
		+	Before telling X-Cart to generate an HTML catalog, you can adjust the format according to which X-Cart will generate the page filenames for this catalog.
		+
		+	Adjusting the format of page filenames includes two tasks:
		+
		+	# Adjusting a [http://www.x-cart.com/xcart_manual/online/adjusting_the_format_of_page_filenames.htm#pagefilenametemplate page filename template] for each type of pages in your HTML catalog.
		+	# Adjusting the [http://www.x-cart.com/xcart_manual/online/adjusting_the_format_of_page_filenames.htm#character4spacesslashes character for replacing spaces and slashes] in page filenames.
		+
		+	Both the tasks can be performed in the 'HTML catalog' section of your store's Admin area.
		+
		+	=== Adjusting page filename templates ===
		+
		+	Typically, an HTML catalog includes pages of products, categories, manufacturers and embedded static pages. For each of the said types of pages, X-Cart provides an editable template defining the format of the page filename. This template specifies the components that must be included into the page filename and the order in which they must be included.
		+
		+	The default template values are the following:
		+
		+	* Category page filename template: <u>{catname}-{order}-p-{page}-c-{catid}.html</u>
		+	* Product page filename template: <u>{prodname}-p-{productid}.html</u>
		+	* Manufacturer page filename template: <u>{manufname}-{order}-p-{page}-mf-{manufid}.html</u>
		+	* Static page filename template: <u>{pagename}-sp-{pageid}.html</u>
		+
		+	In the templates, everything that goes outside the curly brackets is the invariable part of the page filename. The portions surrounded by curly brackets are special tags that hold a place for variable parameters. When X-Cart generates an HTML catalog, these special tags are replaced by the actual parameter values as follows:
		+
		+	* <u>{catname}</u> - Category name.
		+	* <u>{prodname}</u> - Product name.
		+	* <u>{manufname}</u> - Manufacturer name.
		+	* <u>{pagename}</u> - Embedded static page name.
		+	* <u>{catid}</u> - Category ID.
		+	* <u>{productid}</u> - Product ID.
		+	* <u>{manufid}</u> - Manufacturer ID.
		+	* <u>{pageid}</u> - Embedded static page ID.
		+	* <u>{order}</u> - Product sort order; includes an indication of the method by which the sorting is done (orderby, sku, title, price) and the sorting direction (0 - ascending, 1 - descending).
		+	* <u>{page}</u> - Page number.
		+
		+	To understand how page filename templates work, consider the following example:
		+
		+	If you have a product named "Lightbulb" whose product ID is defined as 42, and the product page filename template for your HTML catalog is defined as <u>{prodname}-p-{productid}.html</u>, the filename of the respective product page in the HTML catalog will be <u>Lightbulb-p-42.html</u>.
		+
		+	To readjust the page filename template value for a specific type of pages, do the following:
		+
		+	# In the '<u>HTML catalog</u>' section, click on the [+] icon next to the template value you wish to edit. This opens the template value in edit mode:
		+
		+	[[Image:page_filename_template.gif\|595px]]
		+
		+	Now the template value is displayed inside an editable field.
		+
		+	# Edit the template value.
		+
		+	To find out the format requirements, use the link '<u>Need help?</u>' displayed in edit mode next to the template value. When the mouse hovers over this link, a tooltip is displayed with a list of characters and special tags which can be used in the template. The set of allowed characters is the same for all the templates: alphanumeric characters (A-Z, a-z, 0-9), dot (.), hyphen (-) and underscore (_). The set of allowed special tags depends on the type of pages for which the template is intended. Note that, for each page type, there is a set of required parameters, which must be included into the page name. You will be required to include the special tags that stand for these parameters. The maximum length of a page filename template value is 200 characters (This includes the characters in the names of special tags).
		+
		+	Below the editable field containing the template value, you can see a set of links named after special tags. These links represent the special tags which can be used in the template. The links are provided for your convenience so you do not have to type out the names of special tags: clicking on a special tag link inserts the special tag into the template at the current cursor position; clicking the same link again removes the special tag from the template.
		+
		+	As you edit the template value, X-Cart dynamically checks its format for correctness. As long as the format requirements are met, the frame of the field containing the template value being edited is displayed as green. If the frame of the template field becomes red, and an error message is displayed, it means that the format of the template value is invalid and must be changed.
		+
		+	# At any moment, you can use the Reset link to undo any changes you made to the template value during the current editing session. Clicking on this link resets the template value to its pre-editing state.
		+	# After you are done editing, click the '''Apply''' button to save the changes.
		+
		+	When you click on '''Apply''', the template is updated.
		+
		+	{{Note1\|Note: At this point, the changes made to the template are not yet saved. The saving is done when you click the Generate catalog button at the bottom of the 'HTML catalog' dialog box to start catalog generation.}}
		+
		+	# To exit template edit mode, click the [ - ] icon next to the template you are editing.
		+
		+	=== Adjusting the character for replacing spaces and slashes in page filenames ===
		+
		+	Filenames of the pages of products, categories, manufacturers and embedded static pages in HTML catalog include names of products, categories, manufacturers and embedded static pages, respectively, as variable parameters. The names of the said objects (products, categories, manufacturers and embedded static pages) may contain spaces and slashes. Using spaces and slashes in filenames and URLs is not considered good practice, so X-Cart provides a mechanism that replaces space and slash characters in filenames by another character at the time of HTML catalog generation.
		+
		+	You can specify which character must be used to replace spaces and slashed in the HTML catalog page filenames. This can be done by adjusting the option '<u>Replace spaces and slashes in page filenames by this character</u>' in the '<u>HTML catalog</u>' section of your store's Admin area. This option appears as a drop-down box with two values: Hyphen (-) and Underscore (_). Before you tell X-Cart to generate an HTML catalog, you must select one of these values, and it will be used to replace any space and slash characters in the page filenames of this HTML catalog.
		+
		+	Consider the following example:
		+
		+	If you have a product named "Lord of the Rings /DVD/" whose product ID is defined as 24, the product page filename template for your HTML catalog is defined as <u>{prodname}-p-{productid}.html</u>, and the character for replacing spaces and slashes is defined as hyphen (-), the filename of the respective product page in the HTML catalog will be Lord-of-the-Rings-DVD-p-24.html.

	[[Category:X-Cart user manual]]		[[Category:X-Cart user manual]]

@@ Line 98: / Line 98: @@
 # Go to the '<u>HTML catalog</u>' section (<u>Administration menu->HTML catalog</u>). A dialog box titled '<u>HTML catalog</u>' opens.
-# In the subsection '<u>Generate catalogs for the following languages</u>', locate the name of the language for which you would like to update the HTML catalog. Make sure the '<u>Catalog path</u>' field for this language contains the correct path to the directory where the HTML catalog that needs to be updated is stored.<br><br>You can choose to update the HTML catalogs for multiple languages in one run. In this case, check the catalog paths for all the languages for which the catalog will be updated.<br><br>Clear the 'Catalog path' field for all the languages for which you do not wish to update the catalog this time.
+# In the subsection '<u>Generate catalogs for the following languages</u>', locate the name of the language for which you would like to update the HTML catalog. Make sure the '<u>Catalog path</u>' field for this language contains the correct path to the directory where the HTML catalog that needs to be updated is stored.<br>You can choose to update the HTML catalogs for multiple languages in one run. In this case, check the catalog paths for all the languages for which the catalog will be updated.<br>Clear the 'Catalog path' field for all the languages for which you do not wish to update the catalog this time.
 # Adjust the check box '<u>Delete all HTML files in target folder</u>'. If the purpose of updating is just to add new pages to the catalog, leave this check box unselected; this ensures that X-Cart will not waste time deleting and re-generating the pages that did not change. If, however, the purpose of updating is not just to add new pages, but to replace/remove some existing pages, select this check box; this ensures that X-Cart will remove all HTML files from the HTML catalog directory before re-generating the catalog.
 # Specify the portion of the HTML catalog that you wish to be updated:

@@ Line 92: / Line 92: @@
 ==Updating Existing HTML Catalog==
 ==Adjusting the Format of Page Filenames for the HTML Catalog==
 [[Category:X-Cart user manual]]

@@ Line 10: / Line 10: @@
 An HTML catalog consists of static HTML pages and includes the following:
 * <u>index.html</u> (the main index page; the content of this page corresponds to the content of the dynamic page <u>home.php</u> at the time of catalog generation);
 {{Note1|Note: If home.php contains a list of bestsellers and featured products, the pages of these products are also included during HTML catalog generation. }}
 * category pages;

← Older revision		Revision as of 06:17, 29 January 2010
Line 46:		Line 46:

	==Generating HTML Catalog==		==Generating HTML Catalog==
		+
		+	X-Cart allows you to create a separate HTML catalog for each of the languages supported by your store. Before telling X-Cart to generate an HTML catalog for a specific language, you must create a directory to which X-Cart will be able to write the files of this HTML catalog. This directory must be located within your X-Cart installation directory. To enable X-Cart to write files to this directory, you must ensure that the user under which PHP runs on your server has full access to this directory (write and execute permissions to the directory on Unix systems, or "Full Control" over the directory on Windows systems).
		+
		+	To generate an HTML catalog for a specific language, do the following:
		+
		+	1. Go to the '<u>HTML catalog</u>' section of your store's Admin area (<u>Administration menu->HTML catalog</u>). A dialog box titled '<u>HTML catalog</u>' opens:
		+
		+	: [[Image:html_catalog.gif\|573px]]
		+
		+	2. Choose the language for which you would like X-Cart to generate an HTML catalog and specify the directory to which you wish this HTML catalog to be generated:
		+
		+	: At the top of the '<u>HTML catalog</u>' dialog box, you can see a subsection titled '<u>Generate catalogs for the following languages</u>'. This subsection provides a table listing all the languages currently supported by your store. Locate the language for which you wish the HTML catalog to be generated and use the '<u>Catalog path</u>' field opposite the name of this language to specify the directory in which the HTML catalog must be created. The directory path must be specified relative to your X-Cart installation directory.
		+
		+	{{Note1\|For example, if your store is located in /home/user/public_html/xcart (which, for example, corresponds to the URL http://www.example.com/xcart), and you wish the HTML catalog to be accessible at the URL http://www.example.com/xcart/catalog/ (which corresponds to the directory /home/user/public_html/xcart/catalog), specify the directory path as "/catalog".}}
		+
		+	: You can choose to generate HTML catalogs for multiple languages in one run. In this case, complete the '<u>Catalog path</u>' field for each of the languages that need an HTML catalog.
		+
		+	: It is recommended that you use separate directories for the HTML catalogs generated for different languages. Creating HTML catalogs for multiple languages in the same directory will result in that the files of these catalogs will get mixed up. When, in the future, you need to update one of the HTML catalogs stored in this directory, you will not be able to use the option '<u>Delete all HTML files in target folder</u>' (see below) without deleting the files of all the other HTML catalogs in this directory.
		+
		+	: For similar reasons, it is recommended that you do not create HTML catalogs directly in your X-Cart installation directory if you use this directory to store any HTML files.
		+
		+	3. Use the check box '<u>Delete all HTML files in target folder</u>' to specify whether you wish to delete all HTML files from the directory to which the HTML catalog will be generated before the generation process begins. Generating the HTML catalog with this check box selected will cause the removal from the directory of all the files with the .html or .htm extension, except for the file shop_closed.html, should this file be located in the said directory.
		+
		+	4. Specify the pages that you wish to include into your HTML catalog. Please note that the index.html page of your HTML catalog will provide links to all of your store's root categories and embedded static pages, and the pages of categories will provide links to the pages of subcategories and products contained in them. For this reason, if you choose not to include specific pages into your HTML catalog, your HTML catalog will have broken links.
		+
		+	: To specify the pages that you wish to include into your HTML catalog, do the following:
		+
		+	:* In the subsection '<u>Generate HTML pages for</u>', specify the types of objects whose pages need to be included into the HTML catalog. You can select some or all of the following: Categories, Products, Manufacturers and Static pages. For the creation of a complete HTML catalog, select all the types.
		+	:* From the '<u>Include contents of categories</u>' drop-down box, select the category/categories to be included. For the creation of a complete HTML catalog, select the option Root categories.
		+	:* Use the check box '<u>Include contents of subcategories</u>' to specify whether the subcategories of the selected category/categories must be included. For the creation of a complete HTML catalog, select this option.
		+
		+	5. For now, leave the option '<u>Number of pages per one pass</u>' set to All (This option needs to be readjusted only if you get timeouts in the process of generation; see further for an explanation).
		+
		+	6. Adjust the page filename format for the HTML catalog. For instructions, see the section [[#Adjusting the Format of Page Filenames for the HTML Catalog]]).
		+
		+	7. Click the '''Generate catalog''' button.
		+
		+	When you click on '''Generate catalog''', X-Cart begins generating the HTML catalog to the specified directory. While X-Cart is generating the catalog, you will be able to see the progress on the screen. Please be patient and allow sufficient time for the procedure to be completed.
		+
		+	At the end, a message should appear indicating the successful completion of the process: 'HTML catalog was created successfully. Time elapsed: XX.XX second(s)'. Shortly after the success message is displayed, you should be redirected back to the '<u>HTML catalog</u>' page. If you are not redirected automatically in 30 seconds, use the link 'continue >>' at the bottom of the page.
		+
		+	For your convenience, after the generation process is completed, X-Cart displays the location of the generated HTML catalog opposite the name of the language for which it was generated (See the table column 'Catalog is stored here').
		+
		+	Normally, X-Cart generates all the pages of an HTML catalog in one run. However, if your store's product catalog is very large, you might not be able to complete the process of generating your HTML catalog in one run without getting timeouts. If you get timeouts, try readjusting the option '<u>Number of pages per one pass</u>'. By default, this option is set to All. You can select a different value to tell X-Cart to generate the HTML catalog in portions. The values available for selection from the '<u>Number of pages per one pass</u>' drop-down box correspond to the number of HTML catalog pages that X-Cart will generate per one pass. You will probably have to experiment with this option to find the number of pages that will be appropriate for your database size and server performance.
		+
		+	After the process of generating the HTML catalog is completed, be sure to change the permissions on the directory to which the catalog was generated back to normal.
		+
		+	Once generated, the catalog can be left in the directory to which it was generated or moved to any other directory on the same domain.

	==Updating Existing HTML Catalog==		==Updating Existing HTML Catalog==