Author: jleroux
Date: Fri Jan 7 07:29:15 2011
New Revision: 1056212
URL: http://svn.apache.org/viewvc?rev=1056212&view=rev
Log:
A patch from BJ Freeman "Catalog Help docbook files"
(https://issues.apache.org/jira/browse/OFBIZ-4095) - OFBIZ-4095
First installment of help files for full documents.
Added:
ofbiz/trunk/applications/product/data/helpdata/HELP_PRODUCT_Catalog_Promos.xml
(with props)
ofbiz/trunk/applications/product/data/helpdata/HELP_PRODUCT_Features.xml
(with props)
ofbiz/trunk/applications/product/data/helpdata/HELP_PRODUCT_Product
Stores.xml (with props)
ofbiz/trunk/applications/product/data/helpdata/HELP_PRODUCT_WorkingwithCatalogs.xml
(with props)
Modified:
ofbiz/trunk/applications/product/data/helpdata/HELP_PRODCATALOG_main.xml
ofbiz/trunk/applications/product/data/helpdata/HELP_PRODUCT.xml
ofbiz/trunk/applications/product/documents/Product.xml
Modified:
ofbiz/trunk/applications/product/data/helpdata/HELP_PRODCATALOG_main.xml
URL:
http://svn.apache.org/viewvc/ofbiz/trunk/applications/product/data/helpdata/HELP_PRODCATALOG_main.xml?rev=1056212&r1=1056211&r2=1056212&view=diff
==============================================================================
--- ofbiz/trunk/applications/product/data/helpdata/HELP_PRODCATALOG_main.xml
(original)
+++ ofbiz/trunk/applications/product/data/helpdata/HELP_PRODCATALOG_main.xml
Fri Jan 7 07:29:15 2011
@@ -23,7 +23,31 @@
xsi:schemaLocation="http://docbook.org/ns/docbook
../../../content/dtd/docbook.xsd"
xmlns="http://docbook.org/ns/docbook";>
<title>The Product Catalog overview</title>
- <para>Introduction</para>
+ <para>The Catalog Manager creates or provides access to a variety of
information. Whether Products, Catalogs, or Categories, this screen offers
search tools and links to get you to the type of information you need or are
working with quickly and accurately.
+ </para>
+ <note>Different Visual Themes will represent the links differently the Visual
Themes for this is Flat Grey</note>
+Down the left hand column are 4 sections:
+
+ 1. Search Products,
+ 2. Browse Catalogs,
+ 3. Browse Categories, and
+ 4. Product Categories.
+<tip>
+You can click on the colored '_' to close a section; later, click on the
colored '[]' to reopen the section. Each of those sections are discussed below
before we begin to explore the Catalog Administration Main Page.
+Navigation Panel
+
+The Left-hand Navigation Panel is visible even when working under the other
tabs. The content displayed will vary according to what choices you have made.
This document is arranged to walk you through the Navigation Panel search tools
(Search Products, Browse Catalogs, Browse Categories, and Category Products)
and links first. As you come to the desired Edit or Creation window, jump in
this document to the associated 'Edit' discussion.
+Some symbols used as shortcuts
+Brackets []
+
+Application links as found on the screens are represented in this document
with brackets around them like [this]. When you see a bracketed item, you can
know we are referring to a link or key or 'button' which will initiate the
indicated action.
+Greater than symbols >>
+
+The single (>) or double (>>) greater than symbols can be read as 'takes you
to' or 'leads to' or 'results in.' These are sometimes used in this document to
indicate that from this screen, if you click on the [Bracketed Link], you will
be taken to Next Process. Within the pop-up calendars, however, the (>>) jumps
you ahead one year and the (<<) jumps you back a year.
+The Asterisk
+
+An asterisk * marks those items which must be completed on a screen before the
desired action can occur.
+</tip>
<section>
<title>subsection heading</title>
<para>Subsection content</para>
@@ -32,7 +56,7 @@
<title>Subsection 2 title</title>
<para>
The Main accounting help screen. For more information please
- see the <link xl:href="http://docs.ofbiz.org";>OFBiz documentation
site</link> for more info.
+ see the <link
xl:href="https://cwiki.apache.org/confluence/display/OFBIZ/CATALOG";>OFBiz
documentation site</link> for more info.
</para>
</section>
</section>
Modified: ofbiz/trunk/applications/product/data/helpdata/HELP_PRODUCT.xml
URL:
http://svn.apache.org/viewvc/ofbiz/trunk/applications/product/data/helpdata/HELP_PRODUCT.xml?rev=1056212&r1=1056211&r2=1056212&view=diff
==============================================================================
--- ofbiz/trunk/applications/product/data/helpdata/HELP_PRODUCT.xml (original)
+++ ofbiz/trunk/applications/product/data/helpdata/HELP_PRODUCT.xml Fri Jan 7
07:29:15 2011
@@ -31,7 +31,7 @@
<section>
<title>Subsection 2 title</title>
<para>
- The Main accounting help screen. For more information please
+ The Main catalog help screen. For more information please
see the <link xl:href="http://docs.ofbiz.org";>OFBiz documentation
site</link> for more info.
</para>
</section>
Added:
ofbiz/trunk/applications/product/data/helpdata/HELP_PRODUCT_Catalog_Promos.xml
URL:
http://svn.apache.org/viewvc/ofbiz/trunk/applications/product/data/helpdata/HELP_PRODUCT_Catalog_Promos.xml?rev=1056212&view=auto
==============================================================================
---
ofbiz/trunk/applications/product/data/helpdata/HELP_PRODUCT_Catalog_Promos.xml
(added)
+++
ofbiz/trunk/applications/product/data/helpdata/HELP_PRODUCT_Catalog_Promos.xml
Fri Jan 7 07:29:15 2011
@@ -0,0 +1,64 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+-->
+<section id="Promotions" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance";
version="5.0" xmlns:xl="http://www.w3.org/1999/xlink";
xmlns:xi="http://www.w3.org/2001/XInclude";
xsi:schemaLocation="http://docbook.org/ns/docbook
../../../content/dtd/docbook.xsd" xmlns="http://docbook.org/ns/docbook";>
+
+
+ <title> Promotions </title>
+
+ <section>
+ <title> Similar to Price Rules</title>
+ <para>Promotions are similar to Price Rules (see Price Rules, below)
but are used to record special promotional offers which apply to the entire
order, rather than prices for a particular product. For example, the
promotional manager can be used to set up rules to give customers a percentage
discount if they purchase a minimum quantity, or to create a coupon code.
+</para>
+ </section>
+ <note>
+ <title> Tied to Specific Stores</title>
+ <para>Promotions are tied to specific stores, whereas price rules are
applicable to all products (although you can specify the website, product
catalog, or category for which a price rule is applicable).
+</para>
+ </note>
+ <section>
+ <title> Opening Screen</title>
+ <para>The opening screen lists all promotions which are currently
available and a link for creating additional promotions; click on one to go to
a promotion. You will also see a series of four tabs: [Promo], [Rules],
[Stores] and [Codes].
+</para>
+ </section>
+ <section>
+ <title> Promo tab</title>
+ <para>At the top is general information about this promotion. Each
promotion has an ID, a name and a longer descriptive text, which are shown to
customers. If no text is entered, Open for Business will automatically generate
text for you.
+</para>
+ </section>
+ <note>
+ <title> Rules discussion</title>
+ <para>Rules for promotions are used to determine what actions should
be taken in the promotion. Each promotion can have multiple rules, and each
rule can have multiple conditions and actions. If a promotion had multiple
rules, they would all be checked in sequence, and the rules whose conditions
were true will be activated. This is especially helpful for complicated
promotions that have multiple offers.
+</para>
+ </note>
+ <section>
+ <title>Stores tab</title>
+<para>The stores tab shows a list of product stores in which this promotion is
active.
+ You can add additional stores here or delete them.
+</para>
+ </section>
+ <section>
+ <title> Codes tab</title>
+<para>The codes tab is used to associate codes for a promotion, similar to
coupon codes.
+
+
+</para>
+ </section>
+ </section>
+
Propchange:
ofbiz/trunk/applications/product/data/helpdata/HELP_PRODUCT_Catalog_Promos.xml
------------------------------------------------------------------------------
svn:eol-style = native
Propchange:
ofbiz/trunk/applications/product/data/helpdata/HELP_PRODUCT_Catalog_Promos.xml
------------------------------------------------------------------------------
svn:keywords = Date Rev Author URL Id
Propchange:
ofbiz/trunk/applications/product/data/helpdata/HELP_PRODUCT_Catalog_Promos.xml
------------------------------------------------------------------------------
svn:mime-type = text/xml
Added: ofbiz/trunk/applications/product/data/helpdata/HELP_PRODUCT_Features.xml
URL:
http://svn.apache.org/viewvc/ofbiz/trunk/applications/product/data/helpdata/HELP_PRODUCT_Features.xml?rev=1056212&view=auto
==============================================================================
--- ofbiz/trunk/applications/product/data/helpdata/HELP_PRODUCT_Features.xml
(added)
+++ ofbiz/trunk/applications/product/data/helpdata/HELP_PRODUCT_Features.xml
Fri Jan 7 07:29:15 2011
@@ -0,0 +1,96 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+-->
+<section id="ProductCatalogFeatures"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"; version="5.0"
xmlns:xl="http://www.w3.org/1999/xlink";
xmlns:xi="http://www.w3.org/2001/XInclude";
xsi:schemaLocation="http://docbook.org/ns/docbook
../../../content/dtd/docbook.xsd" xmlns="http://docbook.org/ns/docbook";>
+ <anchor xml:id="ProductCatalogFeatures"/>
+ <title>Catalog Features overview </title>
+ <para>To Sell and to Differentiate Products
+Features are characteristics used to sell and to differentiate products. The
Open for Business catalog manager allows you to define any feature set you wish
for your products. Typical features include size and color. In Open for
Business, features are associated, or applied, to products as Standard
Features, Selectable Features, or Distinguishing Features.
+</para>
+
+
+ <section id="Standardfeatures">
+ <anchor xml:id="Standardfeatures"/>
+ <title> Standard features</title>
+ <para>Standard features are features which are associated with every
instance of a product. An example might be the brand name of a product -- all
instances of the product share the same brand name.
+</para>
+
+ </section>
+ <section>
+ <anchor xml:id="Selectablefeatures"/>
+ <title> Selectable features</title>
+ <para>Selectable features are features which the customer selects one
from many available choices. For example, a shirt may be available in White,
Blue, Green, Yellow, Pink. These colors would be selectable features of the
variant product shirt, and the customer would be prompted to choose a color.
+</para>
+ <para>Each color, though, would be a standard feature of the physical
product. Thus, White would be a selectable feature of the virtual product
'shirt' but a standard feature of 'white shirt.'
+</para>
+
+ </section>
+ <section>
+ <anchor xml:id="Distinguishingfeatures"/>
+ <title> Distinguishing features</title>
+ <para>Distinguishing features are features which distinguish one
product from another and are used to show the customer which item she chose.
+</para>
+
+ </section>
+ <section>
+ <anchor xml:id="WorkingProductFeatures"/>
+ <title> Working with Product Features</title>
+ Click on Features tab
+Defaults to Product Features
+
+
+</section>
+ <section>
+ <anchor xml:id="CreateMaintainProductFeatures"/>
+ <title> Create and Maintain Product Features</title>
+ <para>These screens are for creating and maintaining product features,
which are features or characteristics that are available for products. Here you
will define what features can be available for products. Later, when working
with the products, you will have a chance to define what features a particular
product may have.
+</para>
+
+ </section>
+ <section>
+ <anchor xml:id="FeatureCategoriesandFeatureGroups"/>
+ <title> Feature Categories and Feature Groups</title>
+ <para>Notice the sub-tabs for Feature Categories and Feature Groups.
These are both used to help you organize your product features. Each feature
can only belong to one category but as many groups as you need. For example,
you can have a colors category that has colors White, Blue, Grey, Green,
Yellow, Pink, Red, and Orange and a sizes category that has sizes XXS, XS, S,
M, L, XL, XXL. Then, you can have one group for shirts that would have colors
White, Blue, Grey and sizes S, M, L, XL, XXL, and another group for dresses
that have colors Yellow, Pink, Red, Orange and sizes XXS, XS, S, M, and L.
+
+ </para>
+ </section>
+ <section>
+ <title> Add Features to a Category</title>
+ <para>Once you have created a feature category, you can click on it to
add features to it. There is a link [Create new feature] which takes you to a
screen to create a new product feature. Below this link is a list of product
features already in this category. Important fields for product features are
listed below.
+
+ </para>
+ </section>
+ <section>
+ <title> Feature Categories</title>
+ <para>Click on [Feature Categories] (this is the default screen when
you clicked on 'Features' above), and you will see a menu for editing a
particular feature, if you remember its feature ID. (If not, you can edit it
from the feature categories below.) Next, you will see a list of feature
categories and their parent categories. The categories' ID codes are
highlighted, and you can click on one to go to the feature category. At the
very bottom is a menu for creating a new feature category. Here, you would
enter the new feature category's name and specify a parent category for it (if
it has one.) The category ID is automatically created for you.
+
+ </para>
+ </section>
+ <section>
+ <title> Working with Feature Groups</title>
+ <para>Click on [Feature Groups] and you will see a screen showing a
list of available feature groups, and an option to create a new feature group
at the bottom. Click on the ID of the feature group, and you will be taken to a
screen which shows all the features in this group (if there are any) and a menu
to add more features to this group. Like feature categories, the IDs of feature
groups are automatically created.
+
+ </para>
+ </section>
+ <section>
+ <title>. Implement Feature-based Product Search</title>
+ <para>You can associate feature categories or feature groups to a
Product Category. Buy doing this will provide web store customer feature based
product search ability. If customers choose to search within a given category
and that category has features associated with it then they will be displayed
as selectable filtering options (based on the associated product features) on
the search form.</para>
+ </section>
+</section>
+
Propchange:
ofbiz/trunk/applications/product/data/helpdata/HELP_PRODUCT_Features.xml
------------------------------------------------------------------------------
svn:eol-style = native
Propchange:
ofbiz/trunk/applications/product/data/helpdata/HELP_PRODUCT_Features.xml
------------------------------------------------------------------------------
svn:keywords = Date Rev Author URL Id
Propchange:
ofbiz/trunk/applications/product/data/helpdata/HELP_PRODUCT_Features.xml
------------------------------------------------------------------------------
svn:mime-type = text/xml
Added: ofbiz/trunk/applications/product/data/helpdata/HELP_PRODUCT_Product
Stores.xml
URL:
http://svn.apache.org/viewvc/ofbiz/trunk/applications/product/data/helpdata/HELP_PRODUCT_Product%20Stores.xml?rev=1056212&view=auto
==============================================================================
--- ofbiz/trunk/applications/product/data/helpdata/HELP_PRODUCT_Product
Stores.xml (added)
+++ ofbiz/trunk/applications/product/data/helpdata/HELP_PRODUCT_Product
Stores.xml Fri Jan 7 07:29:15 2011
@@ -0,0 +1,129 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+-->
+<section id="ProductStores"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"; version="5.0"
+ xmlns:xl="http://www.w3.org/1999/xlink";
+ xmlns:xi="http://www.w3.org/2001/XInclude";
+ xsi:schemaLocation="http://docbook.org/ns/docbook
../../../content/dtd/docbook.xsd"
+ xmlns="http://docbook.org/ns/docbook";>
+
+
+ <title> Product Stores</title>
+<para>A product store has all the information needed to sell products. It is
composed of a series of catalogs, which are composed of product categories and
products. Each store can have its own shipping, fulfillment, notification,
promotions, payment processing, and tax calculation policies. A product store
can point to several different websites, allowing the same products to be sold
on multiple hosted sites or domains. Alternatively, multiple stores, each with
their own website, can be set up to allow different pricing and fulfillment
procedures for, say, different countries or different market segments
(wholesale versus retail.)
+
+</para>
+
+<section>
+ <procedure>
+
+ <step performance="required">
+ <para>Go to Catalog Manager
+</para>
+ </step>
+ <step performance="required">
+ <para> Go to Catalog Manager - Stores tab
+Stores tab (with a store selected) brings up Roles, Promos, Catalogs, Web
Sites, Sales Tax, Shipping, Payments, Emails, Surveys, and Override tabs to
perform a host of other store-related functions.
+</para>
+ </step>
+ <step performance="required">
+ <para> Select existing store
+</para>
+ </step>
+ <step performance="required">
+ <para>If none, Create New Product Store
+</para>
+ </step>
+ <step performance="required">
+ <para> Complete fields
+</para>
+ </step>
+ <step performance="required">
+ <para>Click on Update]</para> </step>
+ </procedure>
+
+
+
+</section>
+<section>
+ <title> Working with Product Stores</title>
+<para>When you click on 'Stores,' you will see a list of product stores that
have been defined. Click on one and you will see several tabs for administering
different aspects of that store. Some of those aspects are discussed below.
+</para>
+</section>
+<section>
+ <title> Why use stores?</title>
+ <para>The 'Stores' tab in the catalog manager as used to define all the
properties of a working store, is a group of products sold together under the
same policies. Stores greatly improve the flexibility of Open for business
applications. It is possible for a company to set up multiple stores, each with
its warehouses, fulfillment policies, currencies, languages, promotions, and
look-and-feel. These stores can be web-based b2b or consumer ecommerce stores
or for internal order entry and POS applications. They could even be in
different countries with different shipping and taxation rules.
+</para>
+</section>
+<section>
+ <title> Product Store</title>
+ <para>This very complete screen provides entry for all of the myriad choices
available which define the store and establish parameters.
+</para>
+</section>
+<section>
+ <title> Roles</title>
+ <para>Defines parties with specific roles for this store. For an employee to
be able to take orders using the internal order manager application, he must be
defined as a 'Sales Representative' here. Restrictions are enforced through the
Party Manager - SecurityGroupsList which grants rights according to party roles.
+</para>
+</section>
+<section>
+ <title> Promos</title>
+ <para>Shows a list of active promotions for this store.
+</para>
+</section>
+<section>
+ <title> Catalogs</title>
+ <para>Catalogs which are available for the current store and the sequence in
which they are to be shown to the user in a navigation menu.
+</para>
+</section>
+<section>
+ <title> Web Sites</title>
+ <para>Websites which are related to this store. This is directly used to link
a store to a web application. Each web application has a configuration file
called web.xml, and it is defined to reference a particular web site. The web
site in turn is defined to relate to a product store. Thus, by setting a store
on a web site, it becomes 'live' on that web application.
+NOTE: It is possible for a web application to have more than one store
associated with it, as long as the application knows how to use the correct one.
+
+</para>
+</section>
+<section>
+ <title> Shipping</title>
+ <para>This page shows the shipping options available to store customers. A
list of shipping options and their pricing is shown. Click on View for a
shipping option shows all the settings for this shipping option. At this point,
this tab can only view shipping options available and can not be used to define
them.
+</para>
+</section>
+<section>
+ <title>Payments</title>
+<para>his is used to set up payment processing for the store. The payment
processing interfaces are defined as Open for business services. Each payment
method will have a series of service types available to it, such as for
authorizing, capturing, and refunding payment. This page links the payment
types and the services together by their purpose. Thus, one service would be
used for credit card authorizations, another for credit card capture, and so
forth
+</para>
+</section>
+<section>
+ <title>EMails</title>
+ <para>This defines emails which the store would send to customers. The actual
email services are either mounted in the controller, such as the order
confirmation email, or from scheduled services, such as back order
notifications. This page defines where the template for the email is located on
the file system, the addresses and subject of each email, and a content type
(which can be left blank).
+</para>
+</section>
+<section>
+ <title> Surveys</title>
+ <para>This page is for adding surveys to the store. Surveys can be associated
with certain events or with products and categories.
+</para>
+</section>
+<section>
+ <title>Override</title>
+ <para>Allows certain keywords to be ascendant at this store for a particular
time period.
+</para>
+</section>
+<section>
+ <title>Segments</title>
+ <para>Identifies the Sales or Market Segments targeted for this Store. The
actual assignment is made under the Marketing tab > Segment sub-tab. Here under
the Product Store you will see a summary table of those assignments along with
links to make any additions or changes.
+</para>
+</section></section>
Propchange: ofbiz/trunk/applications/product/data/helpdata/HELP_PRODUCT_Product
Stores.xml
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: ofbiz/trunk/applications/product/data/helpdata/HELP_PRODUCT_Product
Stores.xml
------------------------------------------------------------------------------
svn:keywords = Date Rev Author URL Id
Propchange: ofbiz/trunk/applications/product/data/helpdata/HELP_PRODUCT_Product
Stores.xml
------------------------------------------------------------------------------
svn:mime-type = text/xml
Added:
ofbiz/trunk/applications/product/data/helpdata/HELP_PRODUCT_WorkingwithCatalogs.xml
URL:
http://svn.apache.org/viewvc/ofbiz/trunk/applications/product/data/helpdata/HELP_PRODUCT_WorkingwithCatalogs.xml?rev=1056212&view=auto
==============================================================================
---
ofbiz/trunk/applications/product/data/helpdata/HELP_PRODUCT_WorkingwithCatalogs.xml
(added)
+++
ofbiz/trunk/applications/product/data/helpdata/HELP_PRODUCT_WorkingwithCatalogs.xml
Fri Jan 7 07:29:15 2011
@@ -0,0 +1,111 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+-->
+<section id="WorkingwithCatalogs"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"; version="5.0"
+ xmlns:xl="http://www.w3.org/1999/xlink";
+ xmlns:xi="http://www.w3.org/2001/XInclude";
+ xsi:schemaLocation="http://docbook.org/ns/docbook
../../../content/dtd/docbook.xsd"
+ xmlns="http://docbook.org/ns/docbook";>
+ <title> Working with Catalogs</title>
+
+<section>
+ <title> Working with Catalogs</title>
+ <para>
+To follow this topic, click on the 'Catalog Detail List' in the left-hand
panel under the 'Browse Catalogs' section.
+ Then click on any catalog in the table of current catalogs presented in the
main screen.
+You will see the top-level editing screen for that catalog.
+ Along the top of the working screen are four sub-tabs: Catalog, Stores,
Parties and Catalogs.
+Each of those are discussed as a topic below.
+
+</para>
+</section>
+<section>
+ <title> Catalogs in general</title>
+ <para>
+A product catalog is used to group many product categories together and forms
an intermediate step in the organization between products, categories, and
stores. The product catalog can be used to define a common look and feel for
all categories in this catalog and specify the way different categories will
behave. For example, it is very useful for stores which sell products from
different manufacturer or completely different product types that require
differing presentations to the customer.
+</para>
+</section>
+<note>
+ <title> Sequence from a Store to the Products</title>
+ <para>
+Although the process sequence through the tabs discussed below does not
correspond with the tab layout within the Catalog Manager, the progression of
the steps is intentional. Promotions and Price Rules cannot exist without
Products. Products are usually so numerous that you wish to divide them into
Categories and distinguish them by their Features. Categories are then the
major sections of your Catalogs. And Catalogs must be associated with their
related Stores. Therefore, when setting up your business, you need to start
with the Store. All of these details are handled within the Catalog Manager.
+</para></note>
+<section>
+ <title> Catalog tab</title>
+ <para>
+The main Catalog tab for a product catalog is mostly for establishing the look
and feel. Each catalog can have its own style sheet (CSS), its own logo, and
its own content repository (the content path prefix) and templates prefix
(where its freemarker templates are located).
+</para>
+</section>
+<section>
+ <title> The Stores tab</title>
+ <para>
+The 'Stores' tab shows a list of Stores that this Catalog is currently
featured in. Note that Stores and Catalogs do not have a one-to-one
relationship: the same Store can feature multiple Catalogs, and the same
Catalog could be featured in many Stores.
+
+</para>
+</section>
+<section>
+ <title>The Parties tab</title>
+ <para>
+Here you identify which Party is responsible for or assigned to work with the
specific Catalog selected. The Party's Role is assigned or identified and, if
appropriate, a start and/or finish date for the assignment can be specified.
+
+</para>
+</section>
+<section>
+ <title>Categories tab</title>
+ <para>
+The 'categories' tab shows the different product categories and their roles
for this catalog. Specifically:
+
+ * Each catalog can (should) have a 'Browse Root' category, which is used
as the root category for navigation. For example, the navigation menu would
start at this category and show its child categories.
+ * Each catalog can also have a 'Promotions' category, which is shown first
to the customer when he signs in to the site.
+ * There is also a 'Default Search' category. Products in this category are
used for search results first.
+ * 'Quick add' categories are used to specify categories where products can
be added in bulk to the cart from the same screen.
+
+</para>
+</section>
+<section>
+ <title> Browse Categories links</title>
+ <para>
+In the left-hand panel is a section labeled 'Browse Categories.' You can click
on one of the -indented- categories to begin editing it directly, or click on
the [Choose Top Category] link to view a list of links to all Parent categories.
+
+</para>
+</section>
+<section>
+ <title> Catalog Administration Main Page</title>
+ <para>
+The catalog administration main page has several small menus for finding
catalogs, categories, or products. The first three menus allow you to edit
catalogs, categories, or products by their respective IDs, or create new
catalogs, categories, or products. The last one allows you to look for a
product using an ID other than its product ID, such as upc or isbn number (see
below.) Under these menus are two more links. [Auto create keywords] and [Fast
load catalog into cache].
+
+</para>
+</section>
+<section>
+ <title> Auto create keywords</title>
+ <para>
+[Auto create keywords] will create keywords for all of the products identified
with the current Catalog. The keywords are based on product descriptions and
are used for searching for products.
+
+</para>
+</section>
+<section>
+ <title> Fast load catalog</title>
+ <para>
+[Fast load catalog into cache] will load all products and product categories
into the cache; this is good for improved application performance. Note that
only basic product and category information from the first Product and Category
tabs is loaded, so additional information such as content, associations, and
pricing will still have to be retrieved from the database and cached later by
the applications.
+
+</para>
+</section>
+
+</section>
+
Propchange:
ofbiz/trunk/applications/product/data/helpdata/HELP_PRODUCT_WorkingwithCatalogs.xml
------------------------------------------------------------------------------
svn:eol-style = native
Propchange:
ofbiz/trunk/applications/product/data/helpdata/HELP_PRODUCT_WorkingwithCatalogs.xml
------------------------------------------------------------------------------
svn:keywords = Date Rev Author URL Id
Propchange:
ofbiz/trunk/applications/product/data/helpdata/HELP_PRODUCT_WorkingwithCatalogs.xml
------------------------------------------------------------------------------
svn:mime-type = text/xml
Modified: ofbiz/trunk/applications/product/documents/Product.xml
URL:
http://svn.apache.org/viewvc/ofbiz/trunk/applications/product/documents/Product.xml?rev=1056212&r1=1056211&r2=1056212&view=diff
==============================================================================
--- ofbiz/trunk/applications/product/documents/Product.xml (original)
+++ ofbiz/trunk/applications/product/documents/Product.xml Fri Jan 7 07:29:15
2011
@@ -21,7 +21,7 @@
version="5.0" xmlns:xl="http://www.w3.org/1999/xlink";
xmlns:xi="http://www.w3.org/2001/XInclude";
xsi:schemaLocation="http://docbook.org/ns/docbook
../../content/dtd/docbook.xsd"
xmlns="http://docbook.org/ns/docbook";>
- <title>The Product Catalog Component</title>
+ <anchor xml:id="ProductCatalogComponent"/> <title>The Product Catalog
Component</title>
<section>
<title>Introduction Paragraph</title>
<para>
