Kai Diefenbach avatar Kai Diefenbach committed eff8c63

Cleaned up documentation. Added new how-to: How to use filters.

Comments (0)

Files changed (5)

docs/how_to_filters.rst

+How to use product filters
+==========================
+
+In this how-to you will learn how to use product filters.
+
+First we will add the corresponding filter portlet:
+
+1. Go to the shop's management interface
+2. Go to Shop / Preferences
+
+Go to the "Portlets" tab
+
+3. Select "Filter" portlet and click "Add portlet". Enter "Filter" in the
+   Title field and click "Save portlet". You should now see the filter
+   portlet within the left slot.
+
+Now we will add properties, which are the base for the product filters.
+
+4. Go to Properties / Properties.
+5. Add a new property by clicking "Add property". (If there is no  property
+   at all yet you will see the "Add property" form automatically).
+6. Enter the "Name" of the property, in our case "Size" and click
+   "Add property".
+7. Go to "Field type" and select "Select field". Click "Save property type".
+8. Now go to "Options" and fill in the "Name" field. In our case "Small".
+   Click "Add option".
+9. Repeat Step 8 for "Middle" and "Large". Now you should see three options
+   within property "Size": "Small", "Middle" and "Large".
+
+Now will will add a property group. Please note that every property has to
+belong exactly one property group in order to use it with a product.
+
+10. Got to Properties / Property Groups
+11. Add a new property group by clicking "Add property group". (If there is no
+    property group at all yet you will see the "Add property group" form
+    automatically).
+12. Enter the "Name" of the property, in our case "T-Shirts" and click
+    "Add property group".
+    
+Go to the "Properties" tab
+
+13. Select "Size" and click "Assign properties". You should now see "Size"
+    within "Assigned properties".
+    
+Go to Catalog / Products
+
+14. Add a new product clicking "Add product". (If there is no product at all 
+    yet you will see the "Add product" form automatically).
+15. Fill in "Name" "T-Shirt One" and "Price" "10.00" and click "Add product"
+
+Go to the properties tab
+
+16. Select our "Property group" "T-Shirts" and click "Update property groups"
+17. Select "Size" Small
+18. Repeat Steps 14 - 17 for "T-Shirt Two" and "T-Shirt Three" and assign
+    sizes "Middle" and "Large" and prices 100.00 and 1000.00. Now you should 
+    have three products "T-Shirt One", "T-Shirt Two" and T-Shirt Three" each 
+    with sizes "Small", "Middle" or "Large" and prices "10.00", "100.00", 
+    "1000.00".
+
+Go to Catalog / Products Overview
+
+19. Select "Active" for all products and click "Save"
+20. Click on the logo and select "T-Shirts"
+
+Go to Catalog / Categories
+
+21. Add a new category by clicking "Add category". (If there is no category at
+    all  yet you will see the "Add category" form automatically).
+22. Fill in the "Name": "T-Shirts" and click "Add category"
+
+Go to the products tab
+
+23. Select the products "T-Shirt One", "T-Shirt Two", "T-Shirt Three" and 
+    click "Add to category."
+24. Click on "Preview". You should now see the filter portlet with the ability to select the sizes
+    "Small", "Middle" and "Large" and prices 0 - 500.00 and 501.00 - 1000.00.
+
+What next?
+----------
+
+* Add some more properties to the property group "T-Shirts"
+* Add the property group "T-Shirts" to more products
+* Assign products and values via "Property Groups": 
+    1. Go to Properties / Properties Groups
+    2. Select "T-Shirts"
+    3. Go to "Products" tab
+    4. Go to "Values" tab
+* Check out the other options of the Properties, e.g. the "Field type" or the 
+  "Unit"
+* Check out creating variants on base of properties and see how filters work 
+  with variants too

docs/how_to_variants.rst

-How to add a variant
-====================
+How to add a product with variants
+==================================
 
 In this how-to you will learn how to add a product with variants.
 
 3. Click on *"Add product"* in order to add new product
 4. Enter the *"Name", the "slug", the "SKU" and the "Price"* of the product and 
    click on *"Add product"*
-5. You can now enter further data as you would do for standard products. Please
+5. Now you can enter further data as you would do for standard products. Please
    note that this are in this case just default values, which can be 
    overwritten for every single variant later
 6. Change the product's type from *"Standard"* to *"Product with variants"* 
 Go to the *"Variants"* tab
 
 7. Enter *"Color"* in the *"Local properties"* field and click on
-   *"Add property"*. (Please note: you can also use properties and properties
-   groups to create variants, but this is beyond that how-to.)
+   *"Add property"*. (Please note: you can also use properties and property
+   groups to create variants, but this is beyond that how-to).
 8. Enter *"Red"* into the now provided field and click on 
    *"Add option"* 
 9. Repeat that with *"Green" and "Blue"*. Please note: for convenience you can 
-Welcome to django-lfs's documentation!
+Welcome to LFS's documentation!
 ======================================
 
 
 =======
 
 .. toctree::
-   :maxdepth: 2
+   :maxdepth: 1
     
    how_to_variants
+   how_to_filters
 
 Indices and tables
 ==================

docs/user/getting_started.rst

 Since there are no catgories yet, you will be redirected automatically to the
 add category form.
 
-   * Enter "name" and a ``slug" (you will see, that the slug is filled 
+   * Enter "name" and a "slug" (you will see, that the slug is filled 
      automatically but you can change it of course)
    * Enter a "short description". This will be displayed when the category is
      displayed within a overview, e.g. when a category displays is sub
      cateogories
    * Enter a "description". This will be displayed within the detail view of 
      a category when description as content is selected.
-   * Select the "kind of content", this is ``products" (the assigned 
+   * Select the "kind of content", this is "products" (the assigned 
      products of the category will), "categories" (the sub categories of the 
      category will be dsiplay) or "description" (the description field will 
      be displayed)
 Since there is no product yet, you will redirected automatically to the add
 product form.
 
-   * Enter "name" and a ``slug" (you will see, that the slug is filled 
+   * Enter "name" and a "slug" (you will see, that the slug is filled 
      automatically but you can change it of course)
    * Enter the "SKU" of the product. This is the unique external id of the 
      product - taken from your ERP for instance

docs/user/installation.rst

 
 Make sure you have installed:
 
-   * Python (we recommend 2.6.x)
-   * sqlite
+   * Python 2.6.x http://www.python.org/download/
+   * sqlite http://www.sqlite.org/download.html
+   * mercurial http://mercurial.selenic.com/wiki
+   * git http://git-scm.com/
+   
+Please note:
+
+   * The dependency of mercurial and git will be disappear in near future. 
+   * You can - of course - use another database but we provide a filled sqlite
+     database for convenience.
 
 Installation
 ------------
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.