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.

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

updated readme file for tax, taxGraphQl, taxImportExport, theme, themeGraphQl, Tinymce3, and translation #31491

Open
wants to merge 22 commits into
base: 2.4-develop
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
196 changes: 164 additions & 32 deletions app/code/Magento/Tax/README.md
Original file line number Diff line number Diff line change
@@ -1,32 +1,164 @@
# Overview
## Purpose of module
The Magento_Tax module provides the calculations needed to compute the consumption tax on goods and services.

The Magento_Tax module includes the following:
* configuration of the tax rates and rules to apply
* configuration of tax classes that apply to:
** taxation on products
** taxation on shipping charges
** taxation on gift options (example: gift wrapping)
* specification whether the consumption tax is "sales & use" (typically product prices are loaded without any tax) or "VAT" (typically product prices are loaded including tax)
* specification of whether the tax total line can be toggled to display the tax details/subtotals
* display of prices (presented with tax, without tax, or both with and without)

The Magento_Tax module also handles special cases when computing tax, such as:
* determining the tax on an individual item (for example, one that is being returned) when the original tax has been computed on the entire shopping cart
** example country: United States
* being able to handle 2 or more tax rates that are applied separately (examples include a "luxury tax" on exclusive items)
* being able to handle a subsequent tax rate that is applied after a previous one is applied (a "tax on tax" situation, which recently was a part of Canadian tax law)

# Deployment
## System requirements
The Magento_Tax module does not have any specific system requirements.

Depending on how many tax rates and tax rules are being used, there might be consideration for the database size
Depending on the frequency of updating tax rates and tax rules, there might be consideration for the scheduling of these updates

## Install
The Magento_Tax module is installed automatically (using the native Magento install mechanism) without any additional actions.

## Uninstall
The Magento_Tax module should not be uninstalled; it is a required module.
# Magento_Tax module

The **Magento_Tax** module provides the calculations needed to compute the consumption tax on goods and services.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As I have said in other reviews, remove bolding and all instances of "please".


The **Magento_Tax** module includes the following:
- Configuration of the tax rates and rules to apply.
- Configuration of tax classes that apply to:
- Taxation on products.
- Taxation on shipping charges.
- Taxation on gift options (example: gift wrapping).
- Specification whether the consumption tax is "sales & use" (typically product prices are loaded without any tax) or "VAT" (typically product prices are loaded including tax).
- Specification of whether the tax total line can be toggled to display the tax details/subtotals.
- Display of prices (presented with tax, without tax, or both with and without).

The **Magento_Tax** module also handles special cases when computing tax, such as:
- Determining the tax on an individual item (for example, one that is being returned) when the original tax has been computed on the entire shopping cart.
- Example country: United States.
- Being able to handle 2 or more tax rates that are applied separately (examples include a "luxury tax" on exclusive items).
- Being able to handle a subsequent tax rate that is applied after a previous one is applied (a "tax on tax" situation, which recently was a part of Canadian tax law).

## Installation details

Before installing this module, note that the **Magento_Tax** is dependent on the following modules:

- Magento_Catalog
- Magento_Checkout
- Magento_Config
- Magento_Customer
- Magento_Directory
- Magento_PageCache
- Magento_Quote
- Magento_Reports
- Magento_Sales
- Magento_Shipping
- Magento_Store
- Magento_User

Before disabling or uninstalling this module, please consider the following dependencies:

- Magento_TaxImportExport
- Magento_Weee

Please find here [how to enable or disable modules in Magento 2](https://devdocs.magento.com/guides/v2.4/install-gde/install/cli/install-cli-subcommands-enable.html).

## Structure

`CustomerData/` - Checkout totals js layout data provider
`Pricing/` - directory that contain tax adjustment.

For information about a typical file structure of a module in Magento 2, see [Module file structure](https://devdocs.magento.com/guides/v2.4/extension-dev-guide/build/module-file-structure.html#module-file-structure).

## Extensibility

Extension developers can interact with the **Magento_Tax** module. For more information about the Magento extension mechanism, see [Magento plug-ins](https://devdocs.magento.com/guides/v2.4/extension-dev-guide/plugins.html).

[The Magento dependency injection mechanism](https://devdocs.magento.com/guides/v2.4/extension-dev-guide/depend-inj.html) enables you to override the functionality of the **Magento_Tax** module.

### Events

The module dispatches the following events:

- `adminhtml_cache_refresh_type` event in the `\Magento\Tax\Controller\Adminhtml\Tax\IgnoreTaxNotification::execute()` method. Parameters:
- `type` config is a cache refresh type.
- `tax_rate_data_fetch` event in the `\Magento\Tax\Model\Calculation::getRate()` method. Parameters:
- `request` is a Data object (`\Magento\Framework\DataObject` class).
- `sender` is a Calculation object (`\Magento\Tax\Model\Calculation` class).
- `tax_settings_change_after` event in the `\Magento\Tax\Model\Calculation\Rule::afterSave()` method.
- `tax_settings_change_after` event in the `\Magento\Tax\Model\Calculation\Rule::afterDelete()` method.
- `tax_settings_change_after` event in the `\Magento\Tax\Model\Calculation\Rate::afterSave()` method.
- `tax_settings_change_after` event in the `\Magento\Tax\Model\Calculation\Rate::afterDelete()` method.
- `tax_settings_change_after` event in the `\Magento\Tax\Model\Calculation\Rate::deleteAllRates()` method.

For information about the event system in Magento 2, see [Events and observers](https://devdocs.magento.com/guides/v2.4/extension-dev-guide/events-and-observers.html#events).

### Layouts

This module introduces the following layouts and layout handles in the directories:

- `view/adminhtml/layout`:
- `sales_creditmemo_item_price`
- `sales_invoice_item_price`
- `sales_order_create_item_price`
- `sales_order_item_price`
- `tax_rate_block`
- `tax_rate_exportcsv`
- `tax_rate_exportxml`
- `tax_rate_index`
- `tax_rule_block`
- `tax_rule_edit`
- `tax_rule_index`
- `view/base/layout`:
- `catalog_product_prices`
- `view/frantend/layout`:
- `checkout_cart_index`
- `checkout_cart_sidebar_total_renderers`
- `checkout_index_index`
- `checkout_item_price_renderers`
- `sales_email_item_price`
- `sales_order_item_price`

For more information about a layout in Magento 2, see the [Layout documentation](https://devdocs.magento.com/guides/v2.4/frontend-dev-guide/layouts/layout-overview.html).

### UI components

You can extend a customer form and widgets using the configuration files located in the directories

- `view/frontend/ui_component`:
- `widget_recently_compared`
- `widget_recently_viewed`

For information about a UI component in Magento 2, see [Overview of UI components](https://devdocs.magento.com/guides/v2.4/ui_comp_guide/bk-ui_comps.html).

### Public APIs

`\Magento\Tax\Api\OrderTaxManagementInterface`:

- Get taxes applied to an order.

`\Magento\Tax\Api\TaxAddressManagerInterface`:

- Set default Tax Billing and Shipping address into customer session after address save.
- Set default Tax Shipping and Billing addresses into customer session after login.

`\Magento\Tax\Api\TaxCalculationInterface`:

- Calculate Tax.
- Get default rate request.
- Get rate request.

`\Magento\Tax\Api\TaxClassManagementInterface`:

- Get tax class id.

`\Magento\Tax\Api\TaxClassRepositoryInterface`:

- Get a tax class with the given tax class id.
- Retrieve tax classes which match a specific criterion.
- Create or update a Tax Class.
- Delete a tax class.
- Delete a tax class with the given tax class id.

`\Magento\Tax\Api\TaxRateManagementInterface`:

- Get rates by customerTaxClassId and productTaxClassId.

`\Magento\Tax\Api\TaxRateRepositoryInterface`:

- Create or update tax rate.
- Get a tax rate with the given tax rate id.
- Delete a tax rate with the given tax rate id.
- Retrieve tax rates which match a specific criterion.
- Delete a tax rate.

`\Magento\Tax\Api\TaxRuleRepositoryInterface`:

- Get TaxRule.
- Save TaxRule.
- Delete TaxRule.
- Delete a tax rule with the given rule id.
- Retrieve tax rules which match a specific criterion.

[Learn detailed description of the Magento_Sales API.](https://devdocs.magento.com/guides/v2.4/mrg/ce/Sales/services.html)

For information about a public API in Magento 2, see [Public interfaces & APIs](https://devdocs.magento.com/guides/v2.4/extension-dev-guide/api-concepts.html).
14 changes: 11 additions & 3 deletions app/code/Magento/TaxGraphQl/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,12 @@
# TaxGraphQl
# Magento_TaxGraphQl module

**TaxGraphQl** provides type information for the GraphQl module
to generate tax fields for catalog and product information endpoints.
The **Magento_TaxGraphQl** module provides type information for the GraphQl module to generate tax fields for catalog and product information endpoints.

## Installation details

Before installing this module, note that the **Magento_TaxGraphQl** is dependent on the following modules:

- Magento_CatalogGraphQl
- Magento_Tax

Please find here [how to enable or disable modules in Magento 2](https://devdocs.magento.com/guides/v2.4/install-gde/install/cli/install-cli-subcommands-enable.html).
22 changes: 22 additions & 0 deletions app/code/Magento/TaxImportExport/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# Magento_TaxImportExport module

The **Magento_TaxImportExport** module enables magento to export and import tax.

## Installation details

Before installing this module, note that the **Magento_TaxImportExport** is dependent on the following modules:

- Magento_Store
- Magento_Tax

Please find here [how to enable or disable modules in Magento 2](https://devdocs.magento.com/guides/v2.4/install-gde/install/cli/install-cli-subcommands-enable.html).

### Layouts

This module introduces the following layouts and layout handles in the directories:

- `view/adminhtml/layout`:
- `tax_rate_block`
- `tax_rule_edit`

For more information about a layout in Magento 2, see the [Layout documentation](https://devdocs.magento.com/guides/v2.4/frontend-dev-guide/layouts/layout-overview.html).
111 changes: 110 additions & 1 deletion app/code/Magento/Theme/README.md
Original file line number Diff line number Diff line change
@@ -1 +1,110 @@
The Theme module contains common infrastructure that provides an ability to apply and use themes in Magento application.
# Magento_Theme module

The **Magento_Theme** module contains common infrastructure that provides an ability to apply and use themes in Magento application.

## Installation details

Before installing this module, note that the **Magento_Theme** is dependent on the following modules:

- Magento_Cms
- Magento_Config
- Magento_Customer
- Magento_Directory
- Magento_Eav
- Magento_MediaStorage
- Magento_Store
- Magento_Widget

Before disabling or uninstalling this module, please consider the following dependencies:

- Magento_Backend
- Magento_Cms
- Magento_Eav
- Magento_MediaStorage
- Magento_Robots
- Magento_Swatches
- Magento_Vault

Please find here [how to enable or disable modules in Magento 2](https://devdocs.magento.com/guides/v2.4/install-gde/install/cli/install-cli-subcommands-enable.html).

## Structure

`CustomerData/` - directory contains messages section.

For information about a typical file structure of a module in Magento 2, see [Module file structure](https://devdocs.magento.com/guides/v2.4/extension-dev-guide/build/module-file-structure.html#module-file-structure).

## Extensibility

Extension developers can interact with the **Magento_Theme** module. For more information about the Magento extension mechanism, see [Magento plug-ins](https://devdocs.magento.com/guides/v2.4/extension-dev-guide/plugins.html).

[The Magento dependency injection mechanism](https://devdocs.magento.com/guides/v2.4/extension-dev-guide/depend-inj.html) enables you to override the functionality of the **Magento_Theme** module.

### Events

The module dispatches the following events:

- `page_block_html_topmenu_gethtml_before` event in the `\Magento\Theme\Block\Html\Topmenu::getHtml()` method. Parameters:
- `menu` is a menu object (`\Magento\Framework\Data\Tree\Node` class).
- `block` is a Topmenu object (`\Magento\Theme\Block\Html\Topmenu` class).
- `request` is a request object (`\Magento\Framework\App\RequestInterface` class).
- `page_block_html_topmenu_gethtml_after` event in the `\Magento\Theme\Block\Html\Topmenu::getHtml()` method. Parameters:
- `menu` is a menu object (`\Magento\Framework\Data\Tree\Node` class).
- `transportObject` is a Transport object (`\Magento\Framework\DataObject` class).
- `admin_system_config_changed_section_design` event in the `\Magento\Theme\Model\Design\Config\Plugin::afterSave()` method. Parameters:
- `website` is a website object (`\Magento\Store\Api\Data\WebsiteInterface` class).
- `store` is a store object (`\Magento\Store\Api\Data\StoreInterface` class).
- `admin_system_config_changed_section_design` event in the `\Magento\Theme\Model\Design\Config\Plugin::afterDelete()` method. Parameters:
- `website` is a website object (`\Magento\Store\Api\Data\WebsiteInterface` class).
- `store` is a store object (`\Magento\Store\Api\Data\StoreInterface` class).
- `admin_system_config_changed_section_design` event in the `\Magento\Theme\Model\Config::assignToStore()` method. Parameters:
- `store` is a store object (`\Magento\Store\Api\Data\StoreInterface` class).
- `scope` is a store scope.
- `theme` is a theme object (`\Magento\Framework\View\Design\ThemeInterface` class).
- `assigned_theme_changed` event in the `\Magento\Theme\Observer\CheckThemeIsAssignedObserver::execute()` method. Parameters:
- `theme` is a theme object (`\Magento\Framework\View\Design\ThemeInterface` class).

For information about the event system in Magento 2, see [Events and observers](https://devdocs.magento.com/guides/v2.4/extension-dev-guide/events-and-observers.html#events).

### Layouts

This module introduces the following layouts and layout handles in the directories:

- `view/adminhtml/layout`:
- `adminhtml_system_design_theme_block`
- `adminhtml_system_design_theme_edit`
- `adminhtml_system_design_theme_grid`
- `adminhtml_system_design_theme_index`
- `adminhtml_system_design_wysiwyg_files_contents`
- `adminhtml_system_design_wysiwyg_files_index`
- `theme_design_config_edit`
- `theme_design_config_index`
- `view/frantend/layout`:
- `default`
- `default_head_blocks`
- `page_calendar`
- `print`

For more information about a layout in Magento 2, see the [Layout documentation](https://devdocs.magento.com/guides/v2.4/frontend-dev-guide/layouts/layout-overview.html).

### UI components

You can extend a customer form and widgets using the configuration files located in the directories

- `view/adminhtml/ui_component`:
- `design_config_form`
- `design_config_listing`
- `design_theme_listing`

For information about a UI component in Magento 2, see [Overview of UI components](https://devdocs.magento.com/guides/v2.4/ui_comp_guide/bk-ui_comps.html).

### Public APIs

`\Magento\Theme\Api\DesignConfigRepositoryInterface`:

- Get design settings by scope.
- Save design settings.
- Delete design settings.

[Learn detailed description of the Magento_Sales API.](https://devdocs.magento.com/guides/v2.4/mrg/ce/Sales/services.html)

For information about a public API in Magento 2, see [Public interfaces & APIs](https://devdocs.magento.com/guides/v2.4/extension-dev-guide/api-concepts.html).
13 changes: 10 additions & 3 deletions app/code/Magento/ThemeGraphQl/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,11 @@
# ThemeGraphQl
# Magento_ThemeGraphQl module

**ThemeGraphQl** provides type information for the GraphQl module
to generate theme fields information endpoints.
The **Magento_ThemeGraphQl** module provides type information for the GraphQl module to generate theme fields information endpoints.

## Installation details

Before installing this module, note that the **Magento_ThemeGraphQl** is dependent on the following modules:

- Magento_StoreGraphQl

Please find here [how to enable or disable modules in Magento 2](https://devdocs.magento.com/guides/v2.4/install-gde/install/cli/install-cli-subcommands-enable.html).
14 changes: 13 additions & 1 deletion app/code/Magento/Tinymce3/README.md
Original file line number Diff line number Diff line change
@@ -1 +1,13 @@
We have updated the TinyMCE module to the latest available version, 4.6.4. TinyMCE v4.6.4 provides backwards-compatibility for modified editor modules to prevent the loss of functionality. The TinyMCE3 module is now deprecated and will be removed in a future release.
# Magento_Tinymce3 module

The **Magento_Tinymce3** module provides backwards-compatibility for modified editor modules to prevent the loss of functionality.

## Installation details

Before installing this module, note that the **Magento_Tinymce3** is dependent on the following modules:

- Magento_Ui
- Magento_Variable
- Magento_Widget

Please find here [how to enable or disable modules in Magento 2](https://devdocs.magento.com/guides/v2.4/install-gde/install/cli/install-cli-subcommands-enable.html).
Loading