浏览代码

Docs: Add a glossary

Commonly used terms should be explained there.
master
Maik Hoepfel 12 年前
父节点
当前提交
a05f49159d
共有 2 个文件被更改,包括 33 次插入0 次删除
  1. 1
    0
      docs/source/index.rst
  2. 32
    0
      docs/source/ref/glossary.rst

+ 1
- 0
docs/source/index.rst 查看文件

@@ -78,6 +78,7 @@ First steps
78 78
    internals/getting_started
79 79
    topics/key_questions
80 80
    internals/getting_help
81
+   ref/glossary
81 82
 
82 83
 Using Oscar
83 84
 ===========

+ 32
- 0
docs/source/ref/glossary.rst 查看文件

@@ -0,0 +1,32 @@
1
+========
2
+Glossary
3
+========
4
+
5
+This is a work-in-progress list of commonly used terms when discussing Oscar.
6
+
7
+.. glossary::
8
+    :sorted:
9
+
10
+    Partner
11
+    Fulfillment partner
12
+       An individual or company who can fulfil products. E.g. for physical
13
+       goods, somebody with a warehouse and means of delivery.
14
+
15
+       .. seealso:: Related model: :class:`oscar.apps.partner.abstract_models.AbstractPartner`
16
+
17
+    SKU
18
+    Stock-keeping unit.
19
+       A :term:`partner`'s way of tracking her products. Uniquely identifies a
20
+       product in the partner's warehouse. Can be identical to the products
21
+       :term:`UPC`. It's stored as an attribute of
22
+       :attr:`StockRecord <oscar.apps.partner.abstract_models.AbstractStockRecord.partner_sku>`
23
+
24
+       .. seealso:: `Wikipedia <http://http://en.wikipedia.org/wiki/Stock-keeping_unit>`_
25
+
26
+    UPC
27
+    Universal Product Code
28
+       A code uniquely identifying a product worldwide.
29
+
30
+       .. seealso:: `Wikipedia <http://en.wikipedia.org/wiki/Universal_Product_Code>`
31
+
32
+

正在加载...
取消
保存