Giter Club home page Giter Club logo

xcart-docs's Introduction

X-Cart 5 Knowledge Base and Developer Documentation

CircleCI

This is the combined repo of all X-Cart 5 documentation sites. Available sites are:

  • Knowledge Base (English): kb_en
  • Knowledge Base (Russian): kb_ru
  • Developer Docs (English): devs_en
  • Developer Docs (Russian): devs_ru

Requirements

  • Ruby 2.3+
  • Jekyll 3.6+

Usage

Run bundle install first to get the all required gems. After that you have two options:

  1. To build the site in production mode, run ./build.sh <SITE_NAME> (the site name key is specified in bold in "Available sites" list).

  2. To run the site via jekyll serve in development mode, run ./start.sh <SITE_NAME>.

Contribution

You can send pull requests to update the articles content (which is placed in _pages folder). Also, there is an editor, available for the approved contributors from the X-Cart - https://xcart.github.io/prose.

xcart-docs's People

Contributors

amxsv avatar dohtur-xcart avatar drdaemos avatar justmdk avatar kde35 avatar morriganne avatar soldatov-xcart avatar svowl avatar tereshina avatar tony-sologubov avatar twinkietolp avatar valerol avatar wanndrueakk avatar xl1me avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar

xcart-docs's Issues

troubleshooting label-editing user error

This issue is about https://kb.x-cart.com/look_and_feel/theme_tweaker/labels_editor.html (source file: https://github.com/xcart/xcart-docs/blob/master/_pages/kb_en/look_and_feel/theme_tweaker/labels_editor.md)

It would be good if the guide could explain how to address / undo the following user behaviour, which i did in error through the labels editor and I imagine is not so uncommon :

In the labels editor I mistakenly added a styled p class to the start / end of the label.
This changed the layout of the label and meant it couldn't be re-edited in the label editor.
It would be good if the guide could explain the correct procedure or the location of the server-side file to edit

thanks for reading

This module doesn't work with X-cart 5.4.0.11

This issue is about https://devs.x-cart.com/changing_store_logic/creating_a_settings_page_for_a_payment_method.html (source file: https://github.com/xcart/xcart-docs/blob/master/_pages/devs_en/changing_store_logic/creating_a_settings_page_for_a_payment_method.md)

First of all, the guide mentions pushing yaml files to database, but the links are dead. But, re-deploying the cache pushes automatically yaml files to database, right? Or am I missing something?

Second, the module shows up in the list, and I can activate, but the demo payment method doesn't show up in store setup-> payment methods page.

Replace @Decorator\Depend with @Decorator\After in the 'Module dependencies' article

This issue is about https://devs.x-cart.com/basics/making_one_module_depend_on_another_one_--_creating_a_menu_in_the_customer_area.html (source file: https://github.com/xcart/xcart-docs/blob/master/_pages/devs_en/basics/making_one_module_depend_on_another_one_--_creating_a_menu_in_the_customer_area.md)

- * @Decorator\Depend ("CDev\SimpleCMS")
+ * @Decorator\After ("CDev\SimpleCMS")

in the classes/XLite/Module/Tony/OverridingTopMenu/View/Menu/Customer/TopAfterSimpleCMS.php code block.

Because
@decorator\Depend directive means that decoration will happen only if such module is enabled.

5.4.0.6 X-Cart version and command line interface

This issue is about https://devs.x-cart.com/misc/command_line_tool.html (source file: https://github.com/xcart/xcart-docs/blob/master/_pages/devs_en/misc/command_line_tool.md)

It seems that the 5.4.0.6 X-Cart version doesn't support the command line interface. I am running a local host with PHP v. 7.2.23 in a Windows 7 platform with WAMPServer 3.1.9.
CLI works fine in this environment, inside an X-Cart 5.3.6 version store, but it doesn't work in a 5.4.0.6 version.
For example, the 'php xc5 list' command gives me a
"Parse error: syntax error, unexpected '?' in E:\wamp64\www\xcart5406\Includes\Utils\URLManager. php on line 276" error. Is there any issue with CLI and x-cart 5.4.x branch?

'View classes' link redirects to different page

This issue is about https://devs.x-cart.com/basics/ (source file: https://github.com/xcart/xcart-docs/blob/master/_pages/devs_en/basics/index.md)

The left-side menu has a 'View Classes' link with URL = https://devs.x-cart.com/basics/working_with_viewer_classes.html
which when clicked, redirects to a different page with URL = https://devs.x-cart.com/getting_started/how-to-apply-design-changes.html#registering-viewer-class-in-view-list.
Also, is the chapter about view classes anywhere available???

Change admin URL docs incomplete

Hello,

The docs located here for changing the default url of the admin login are incomplete.

New xcart 5.3.6 install.

I followed the steps and everything seemed to work perfectly until i noticed that all the links in the admin panel still pointed towards the old location. So right now, unless i change everything back to less secure default, i have to manually type all the URLs when navigating the backend.

What i tried:

  • logging out and back in
  • clearing browser session
  • different browser
  • reboot server

None of that worked. As soon as page loaded, all links in backend still pointed to /admin.

After a little while of me updating contact info and other store info (maybe 30min?) all the links started showing the correct url in the back-end. I'm guessing maybe this was a caching issue?

It would be good to know what command to run in terminal so all links work perfectly immediately instead of fumbling around until they magically start pointing to the correct place.

missing/wrong words

This issue is about https://devs.x-cart.com/basics/creating_new_page.html (source file: https://github.com/xcart/xcart-docs/blob/master/_pages/devs_en/basics/creating_new_page.md)
1.

Create new viewer class that will manage the data output. This viewer class should sit in the classes/XLite/Module/Tony/PageDemo/View/Page/Admin/ directory and have the same as controller class
.
After the "have the same" phrase in the above sentence, a word is missing ('name' ?).

  1. In the sentence "If there is any other target, than this viewer class will not be even run." further down, the "than" word, I guess, is "then".

Historical order data - explanation required

This issue is about https://kb.x-cart.com/modules/order_reports.html (source file: https://github.com/xcart/xcart-docs/blob/master/_pages/kb_en/modules/order_reports.md)

The information presented on the page needs more detail about how historical orders are presented.
For example, if a product within a historical order has been deleted, or has changed category, then how is this product presented in the Grouped by Categories report? What of products that have no category assignment?

link with wrong destination

This issue is about https://devs.x-cart.com/misc/x-cart_classes_structure_and_namespaces.html (source file: https://github.com/xcart/xcart-docs/blob/master/_pages/devs_en/misc/x-cart_classes_structure_and_namespaces.md)

Quoting a paragraph from the page:

/classes/Controller/ directory contains definitions of classes that handle requests to X-Cart (controllers). Check general X-Cart workflow article in order to learn more about controller classes;

In the above paragraph, the link "general X-Cart workflow" links to wrong destination ("Applying changes to business logic" page). It seems that the "general X-Cart workflow" article is missing (such an article may contain very useful and important developer information).

Tutorial "Adding new property to a product": abstract VS non-abstract class declarations

This issue is about https://devs.x-cart.com/basics/adding_new_property_to_a_product/ (source file: https://github.com/xcart/xcart-docs/blob/master/_pages/devs_en/basics/adding_new_property_to_a_product/index.md)

Concerning the tutorial "Adding new property to a product":

Why are the classes "Product" and "Info" abstract?

I cannot see any point or reason why these classes should be declared as "abstract". If they are abstract they cannot be instantiated. But why shouldn´t we want to instantiate them? (Maybe I don´t see the full picture.)

5.4.0.9 version not showing setting button

This issue is about https://devs.x-cart.com/basics/working-with-settings.html (source file: https://github.com/xcart/xcart-docs/blob/master/_pages/devs_en/basics/working-with-settings.md)
5.4.0.9 version not showing setting button
this is my Main.php
`<?php
namespace XLite\Module\JinBer\AliPay;

abstract class Main extends \XLite\Module\AModule
{
public static function getAuthorName()
{
return 'langziyang';
}

public static function getModuleName()
{
    return 'AliPay';
}

public static function getDescription()
{
    return 'AliPay payment';
}

public static function getMajorVersion()
{
    return '5.4';
}

public static function getMinorVersion()
{
    return 0;
}

public static function showSettingsForm()
{
    return true;
}

}`

and my install.yaml
`XLite\Model\Config:

  • name: html_code
    category: JinBer\AliPay
    type: textarea
    orderby: 100
    value: ''
    widgetParameters: { trusted: 1 }
    translations:
    • code: en
      option_name: Put your HTML code here
      option_comment: I am comment to the option and I am here just for show that you can put some text into me
      `

Column "customerEmail" is required

This issue is about https://kb.x-cart.com/import-export/csv_format_by_x-cart_data_type/csv_import_orders.html (source file: https://github.com/xcart/xcart-docs/blob/master/_pages/kb_en/import-export/csv_format_by_x-cart_data_type/csv_import_orders.md)

When running an import with a CSV containing all fields marked as required, the import returns the following critical error:
Column "customerEmail" is required

"customerEmail" does not even appear in the list of columns. Perhaps it ought be added?

Add description of files like these ./classes/XLite/Module/*/*/View/Config.php

getSettingsWidget() method supports
widget or template

https://devs.x-cart.com/changing_store_logic/creating_a_payment_method/creating_settings_page_for_payment_method.html

./classes/XLite/Module/XC/WorldpayHPP/View/Config.php
./classes/XLite/Module/XC/EWAYStoredShared/View/Config.php
./classes/XLite/Module/XC/Heartland/View/Config.php
./classes/XLite/Module/XC/SimplifyCommerce/View/Config.php
./classes/XLite/Module/XC/BitPay/View/Config.php
./classes/XLite/Module/XC/Pilibaba/View/Config.php
./classes/XLite/Module/XC/YandexMoney/View/Config.php
./classes/XLite/Module/XC/ESelectHPP/View/Config.php
./classes/XLite/Module/XC/Stripe/View/Config.php
./classes/XLite/Module/XC/YandexCheckout/View/Config.php
./classes/XLite/Module/XC/YandexCheckout/View/StickyPanel/Config.php
./classes/XLite/Module/QSL/Dwolla/View/Config.php

Module pack mistake

This issue is about https://devs.x-cart.com/basics/new_form/model_editing.html (source file: https://github.com/xcart/xcart-docs/blob/master/_pages/devs_en/basics/new_form/model_editing.md)

string 54:
return new \XLite\Module\XCExample\ModelEditing\Model\DTO\ProductEdit($this->getProduct());
should be
return new \XLite\Module\XCExample\ModelEditing\Model\DTO\ExampleProductEdit($this->getProduct());

string 62:
$formModel = new \XLite\Module\XCExample\ModelEditing\View\FormModel\ProductEdit(['object' => $dto]);
should be
$formModel = new \XLite\Module\XCExample\ModelEditing\View\FormModel\ExampleProductEdit(['object' => $dto]);

Too many requests Sorry, this link has been automatically turned off for now. Learn more about traffic limits.

Trying to download the first example tar file leads to the error "Too many requests

Sorry, this link has been automatically turned off for now. Learn more about traffic limits. "

This issue is about https://devs.x-cart.com/getting_started/how-to-apply-design-changes.html (source file: https://github.com/xcart/xcart-docs/blob/master/_pages/devs_en/getting_started/how-to-apply-design-changes.md)

This document doesn't tell how we decorate Model classes other than Product.

This issue is about https://devs.x-cart.com/what_is_new/what_is_new_in_5_3.html (source file: https://github.com/xcart/xcart-docs/blob/master/_pages/devs_en/what_is_new/what_is_new_in_5_3.md)

The document says that classes are no longer MappedSuperclass. Which somehow make it difficult to decorate them. When I try to decorate Model\Category or Model\Order, it doesn't work. https://forum.x-cart.com/showthread.php?t=76603 And this document provides no solution.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.