Skip to content

E
ecommerce-ui
Commit d3df0e73 authored by Sven Franck's avatar Sven Franck
Browse files
Options

doc: removed old documentation files

parent 0924f134
Hide whitespace changes
Inline Side-by-side
Showing with 0 additions and 407 deletions
documentation/brainstorming_page_json.txt deleted 100644 → 0
View file @ 0924f134
{
"_links": {
"object_view": [
{"href": "http://10.0.109.248:12002/erp5/person_module/20130611-1F796/Person_view?portal_skin=Hal", "name": "View"},
{"href": "http://10.0.109.248:12002/erp5/person_module/20130611-1F796/Person_viewDetails?portal_skin=Hal", "name": "Details"},
{"href": "http://10.0.109.248:12002/erp5/person_module/20130611-1F796/Person_viewAssignment?portal_skin=Hal", "name": "Assignments"},
{"href": "http://10.0.109.248:12002/erp5/person_module/20130611-1F796/Entity_viewAccountingTransactionList?portal_skin=Hal", "name": "Transactions"},
{"href": "http://10.0.109.248:12002/erp5/person_module/20130611-1F796/Person_viewFinancialInformationList?portal_skin=Hal", "name": "Financial Information"},
{"href": "http://10.0.109.248:12002/erp5/person_module/20130611-1F796/Base_viewDocumentList?portal_skin=Hal", "name": "Documents"},
{"href": "http://10.0.109.248:12002/erp5/person_module/20130611-1F796/Base_viewEventList?portal_skin=Hal", "name": "Events"},
{"href": "http://10.0.109.248:12002/erp5/person_module/20130611-1F796/Person_viewCredential?portal_skin=Hal", "name": "Credential"},
{"href": "http://10.0.109.248:12002/erp5/person_module/20130611-1F796/Base_viewContentTranslation?portal_skin=Hal", "name": "Translation"},
{"href": "http://10.0.109.248:12002/erp5/person_module/20130611-1F796/Base_viewConsistency?portal_skin=Hal", "name": "Consistency"},
{"href": "http://10.0.109.248:12002/erp5/person_module/20130611-1F796/Base_viewHistory?portal_skin=Hal", "name": "History"},
{"href": "http://10.0.109.248:12002/erp5/person_module/20130611-1F796/Base_viewMetadata?portal_skin=Hal", "name": "Metadata"}
],
"self": {"href": "http://10.0.109.248:12002/erp5/person_module/20130611-1F796/ERP5Document_getHateoas"},
"type": {"href": "http://10.0.109.248:12002/erp5/portal_types/Person/ERP5Document_getHateoas?portal_skin=Hal", "name": "Person"}
},
"title": "Person 22\u00f6"
}
[
{type: fieldlist, span: 2, gadget: bar},
{type: fieldlist, span: 1, gadget: baz},
{type: fieldlist, span: 1, gadget: bam},
{type: tabs, span: 2, tabs: [
[
{type: fieldlist: span: 1, gadget: piz},
{type: fieldlist: span: 1, gadget: paz},
{type: listbox: span: 2, gadget: puz}
], [
{type: fieldlist: span: 2, gadget: poz},
{type: listbox: span: 2, gadget: pez},
{type: listbox: span: 2, gadget: pyz}
], [
{type: fieldlist: span: 2, gadget: abc},
]
]
},
{type: listbox: span: 2, gadget: zzz}
]
Questions:
> If tabs only include "sub-layouts", we don't need to fetch the tab-gadget
configuration, which would recursively re-run the gadget loop and
fetch all gadgets. Would make syntax coherent, but requires another
HTTP request for getting the gadget configuration.
Page layout action/jumps/tasks...
> new listview API!
"portal_type_source": "Person",
"portal_type_title": "person",
"actions": {
"jump": {
"hash": null,
"items": [
{"type": "", "href":"", "title":"", "title_i18n":""}
]
},
"action": {
"hash":null,
"items": [
{"type": "", "href":"", "title":"", "title_i18n":""}
]
},
"export": {
"hash":null,
"items": [
{"type": "", "href":"", "title":"", "title_i18n":""}
]
},
"favorites": {
"hash": null,
"items": [
{"type": "divider", "texts":[{"type":"h1", "text":"-- Bug Event workflow --", "text_i18n":""}]},
{"type": "item", "count": 46, "texts":[{"type":"h1", "text":"Bug Lines to Send", "text_i18n":""}], "actions":[{"type":"link", "href":"index.html"}]},
{"type": "divider", "texts":[{"type":"h1", "text":"-- Bug Workflow --", "text_i18n":""}]},
{"type": "item", "count": 278, "texts":[{"type":"h1", "text":"Open Bugs", "text_i18n":""}], "actions":[{"type":"link", "href":"index.html"}]},
{"type": "item", "count": 12, "texts":[{"type":"h1", "text":"Bugs to Resolve", "text_i18n":""}], "actions":[{"type":"link", "href":"index.html"}]},
{"type": "item", "count": 617, "texts":[{"type":"h1", "text":"Bugs to Follow", "text_i18n":""}], "actions":[{"type":"link", "href":"index.html"}]},
{"type": "item", "count": 732, "texts":[{"type":"h1", "text":"Bugs Assigned to Follow", "text_i18n":""}], "actions":[{"type":"link", "href":"index.html"}]},
{"type": "divider", "texts":[{"type":"h1", "text":"-- Document Ingestion Workflow --", "text_i18n":""}]},
{"type": "item", "count": 12, "texts":[{"type":"h1", "text":"Ingested Documents", "text_i18n":""}], "actions":[{"type":"link", "href":"index.html"}]},
{"type": "divider", "texts":[{"type":"h1", "text":"-- Document Publication Workflow --", "text_i18n":""}]},
{"type": "item", "count": 5, "texts":[{"type":"h1", "text":"Documents to Submit", "text_i18n":""}], "actions":[{"type":"link", "href":"index.html"}]},
{"type": "item", "count": 29, "texts":[{"type":"h1", "text":"Documents to Review", "text_i18n":""}], "actions":[{"type":"link", "href":"index.html"}]},
{"type": "divider", "texts":[{"type":"h1", "text":"-- Events Workflow --", "text_i18n":""}]},
{"type": "item", "count": 560, "texts":[{"type":"h1", "text":"Planned Events to Confirm", "text_i18n":""}], "actions":[{"type":"link", "href":"index.html"}]},
{"type": "item", "count": 10, "texts":[{"type":"h1", "text":"Confirmed Events to Generate", "text_i18n":""}], "actions":[{"type":"link", "href":"index.html"}]},
{"type": "divider", "texts":[{"type":"h1", "text":"-- Inventory Workflow --", "text_i18n":""}]},
{"type": "item", "count": 7, "texts":[{"type":"h1", "text":"Inventories to validate", "text_i18n":""}], "actions":[{"type":"link", "href":"index.html"}]},
{"type": "divider", "texts":[{"type":"h1", "text":"-- Order Workflow --", "text_i18n":""}]},
{"type": "item", "count": 6, "texts":[{"type":"h1", "text":"Purchase Orders to Plan", "text_i18n":""}], "actions":[{"type":"link", "href":"index.html"}]},
{"type": "item", "count": 1, "texts":[{"type":"h1", "text":"Purchase Orders to Confirm", "text_i18n":""}], "actions":[{"type":"link", "href":"index.html"}]},
{"type": "item", "count": 174, "texts":[{"type":"h1", "text":"Sale Orders to Plan", "text_i18n":""}], "actions":[{"type":"link", "href":"index.html"}]},
{"type": "item", "count": 7, "texts":[{"type":"h1", "text":"Sale Orders to Order", "text_i18n":""}], "actions":[{"type":"link", "href":"index.html"}]},
{"type": "item", "count": 9, "texts":[{"type":"h1", "text":"Sale Orders to Confirm", "text_i18n":""}], "actions":[{"type":"link", "href":"index.html"}]},
{"type": "item", "count": 143, "texts":[{"type":"h1", "text":"Offered Sale Orders to Follow", "text_i18n":""}], "actions":[{"type":"link", "href":"index.html"}]},
{"type": "divider", "texts":[{"type":"h1", "text":"-- Packing List Workflow --", "text_i18n":""}]},
{"type": "item", "count": 112, "texts":[{"type":"h1", "text":"Sale Packing List to Prepare", "text_i18n":""}], "actions":[{"type":"link", "href":"index.html"}]},
{"type": "item", "count": 12, "texts":[{"type":"h1", "text":"Sale Packing List to Validate", "text_i18n":""}], "actions":[{"type":"link", "href":"index.html"}]},
{"type": "item", "count": 102, "texts":[{"type":"h1", "text":"Sale Packing List to Solve", "text_i18n":""}], "actions":[{"type":"link", "href":"index.html"}]},
{"type": "divider", "texts":[{"type":"h1", "text":"-- Project Workflow --", "text_i18n":""}]},
{"type": "item", "count": 1, "texts":[{"type":"h1", "text":"Project to Open", "text_i18n":""}], "actions":[{"type":"link", "href":"index.html"}]},
{"type": "divider", "texts":[{"type":"h1", "text":"-- Task Report Workflow --", "text_i18n":""}]},
{"type": "item", "count": 4, "texts":[{"type":"h1", "text":"Task Reports to Follow", "text_i18n":""}], "actions":[{"type":"link", "href":"index.html"}]},
{"type": "divider", "texts":[{"type":"h1", "text":"-- Task Workflow --", "text_i18n":""}]},
{"type": "item", "count": 2, "texts":[{"type":"h1", "text":"Tasks to Validate", "text_i18n":""}], "actions":[{"type":"link", "href":"index.html"}]},
{"type": "item", "count": 1, "texts":[{"type":"h1", "text":"Tasks to Order", "text_i18n":""}], "actions":[{"type":"link", "href":"index.html"}]},
{"type": "divider", "texts":[{"type":"h1", "text":"-- Validation Workflow --", "text_i18n":""}]},
{"type": "item", "count": 3689, "texts":[{"type":"h1", "text":"Persons to Validate", "text_i18n":""}], "actions":[{"type":"link", "href":"index.html"}]},
{"type": "item", "count": 1759, "texts":[{"type":"h1", "text":"Organisations to Validate", "text_i18n":""}], "actions":[{"type":"link", "href":"index.html"}]},
{"type": "item", "count": 123, "texts":[{"type":"h1", "text":"Products to Validate", "text_i18n":""}], "actions":[{"type":"link", "href":"index.html"}]},
{"type": "item", "count": 106, "texts":[{"type":"h1", "text":"Services to Validate", "text_i18n":""}], "actions":[{"type":"link", "href":"index.html"}]},
{"type": "item", "count": 5, "texts":[{"type":"h1", "text":"Sale Trade Conditions to Validate", "text_i18n":""}], "actions":[{"type":"link", "href":"index.html"}]},
{"type": "item", "count": 5, "texts":[{"type":"h1", "text":"Transformations to Validate", "text_i18n":""}], "actions":[{"type":"link", "href":"index.html"}]},
{"type": "item", "count": 2, "texts":[{"type":"h1", "text":"Sale Supplies to Validate", "text_i18n":""}], "actions":[{"type":"link", "href":"index.html"}]},
{"type": "item", "count": 1, "texts":[{"type":"h1", "text":"Purchase Supplies to Validate", "text_i18n":""}], "actions":[{"type":"link", "href":"index.html"}]},
{"type": "divider", "texts":[{"type":"h1", "text":"-- Other --", "text_i18n":""}]},
{"type": "item", "texts":[{"type":"h1", "text":"Update Credentials", "text_i18n":""}], "actions":[{"type":"link", "href":"index.html"}]},
{"type": "item", "texts":[{"type":"h1", "text":"Undo", "text_i18n":""}], "actions":[{"type":"link", "href":"index.html"}]},
{"type": "divider", "texts":[{"type":"h1", "text":"-- User --", "text_i18n":""}]},
{"type": "item", "texts":[{"type":"h1", "text":"Preferences", "text_i18n":""}], "actions":[{"type":"link", "href":"index.html"}]},
{"type": "item", "texts":[{"type":"h1", "text":"Log out", "text_i18n":""}], "actions":[{"type":"link", "href":"index.html"}]}
]
}
},
"controls": {
"header": [
[
{"action":"navigate","active":"true"},
{"action":"tasks", "active": "true"}
],[
{"action":"login", "active":"true"},
{"action":"home","active":"true"}
]
],
"footer": [
{"action":"jump", "active":"true"},
{"action":"add", "active":"false"},
{"action":"remove","active":"false"},
{"action":"action","active":"true"},
{"action":"export", "active":"true"}
]
},
"status": {},
"breadcrumbs": {}
}
\ No newline at end of file
documentation/documentation.txt deleted 100644 → 0
View file @ 0924f134
==============================================================================
Draft API
==============================================================================
------------------------------------------------------------------------------
sections:
------------------------------------------------------------------------------
> Info:
> A section defines a section of content
> Syntax:
=============================================================
type Type of element (fieldlist, tabs, listbox, ...)
span "Columns" to span - 1/2/more
gadget Id of gadget to load
=============================================================
> Notes:
> Types must have a construct[Type] method to build the type of element
> The gadget configuration defines the "instance" of the type
> To add own types add construct[Type] method
> Example JSON:
[
{"type": "fieldlist", "span": 2, "gadget": "bar"},
{"type": "fieldlist", "span": 1, "gadget": "baz"},
{"type": "fieldlist", "span": 1, "gadget": "bam"},
{"type": "tabs", "span": 2, "gadget": "foo"},
{"type": "listbox": "span": 2, "gadget": "zzz"}
]
> Example HTML:
<div class="span_2">
<div class="gadget" data-gadget-type="fieldlist" data-gadget-id="bar"></div>
</div>
<div class="span_1">
<div class="gadget" data-gadget-type="fieldlist" data-gadget-id="baz"></div>
</div>
<div class="span_1">
<div class="gadget" data-gadget-type="fieldlist" data-gadget-id="bam"></div>
</div>
<div class="span_2">
<div class="gadget" data-gadget-type="tabs" data-gadget-id="foo"></div>
</div>
<div class="span_2">
<div class="gadget" data-gadget-type="listbox" data-gadget-id="zzz"></div>
</div>
------------------------------------------------------------------------------
Pages:
------------------------------------------------------------------------------
> Info:
> A module can have one ore more layouts corresponding to pages
> Every hierarchy level needs a layout (one for Persons, on for Person, etc)
> A page must have at least one "default" section
>
> Syntax:
=============================================================
[page_name] link parameter(s) to determine page (?container=a&palette=x)
title Page title to set
title_i18n Client-side translation lookup value
theme Page theme (handles all JQM CSS)
fixed Fix header/footer for this page (default to true)
sections See "sections"
=============================================================
> Example JSON (container > palette > box > items > item = 5 hierarchies)
{
"default": {
"title": "Container",
"theme": "erp5_blue",
"fixed": true,
"title_i18n": null,
"sections": [{"type": "listbox", "span": 2, "gadget": "container_a"}]
},
"palettes": {
"title": "Palette",
"title_i18n": null,
"sections": [{"type": "listbox", "span": 2, "gadget": "palette_content_x"}]
},
"boxes": {
"title": "Box",
"title_i18n": null,
"sections": [{"type": "listbox", "span": 2, "gadget": "box_content_x"}]
},
"items": {
"title": "Items",
"title_i18n": null,
"sections": [{"type": "listbox", "span": 2, "gadget": "box_items_x"}]
},
"item": {
"title": "Item",
"title_i18n": null,
"sections": [
{"type": "fieldlist", "span": 1, "gadget": "item_foo"},
{"type": "fieldlist", "span": 1, "gadget": "item_foo_seller"},
{"type": "listbox", "span": 2, "gadget": "item_ingredients"}
]
}
}
LIST:
"generate": "gadget",
"type": "listview",
"class_list": "",
"theme": "slapos-black",
"property_dict": {
"inset": true,
"filter": true,
"reveal": true,
"input": "#bar",
"divider-theme": "slapos-white",
"autodividers": true,
"count-theme": "slapos-white",
},
"id": null,
"children": [
// sample item with all options
{
"type": "item",
"external": true,
"href": "index.html",
"left": {
"icon": "foo",
"img": "http://www.xyz.com/img/foo.png"
},
"center": {
"count": 3689,
"aside": [
{"type":"p", "text":"foo", "text_i18n":null}
],
"text": [
{"type":"h1", "text":"Persons to Validate", "text_i18n":""}
]
},
"right": {
"icon": "foo/false",
"radio": true,
"checkbox": true,
"action": "foo",
"href": "http://www.foo.com",
"external": true
}
]
POPUP:
{
"generate": "widget",
"type":"Popup",
"class_list": "",
"theme": "",
"id": null,
"property_dict": {
"overlay-theme": null,
"transition": "fade",
"position-to": "window",
"tolerance": "30,30,30,30",
"shadow": true
},
"element": null,
"children": []
}
HEADER:
{
"generate": "widget",
"type": "Header",
"class_list": "",
"theme": "",
"id": null,
"property_dict": {
"title": "",
"title_i18n":"",
"fixed": true
},
"children": [
<<examples>>
{
"type":"img",
"direct": {
"src": "http://www.foo.com/bar.jpg",
"alt": "foo",
"alt_i18n": "bar"
}
}, {
"generate": "widget",
"type": "controlgroup",
"class_list": null,
"id": null,
"form": null,
"theme": null,
"children": [
{"type": "a", "direct": {}, "attributes": {}, "logic": {}}
]
}
]
}
CONTROLGROUP:
{
"generate": "controlgroup",
"id": null,
"class_list": null,
"theme": null,
"property_dict": {
"direction": "horizontal"
},
"children": [
{"type":a, "direct": {}, "attributes": {}, "logic": {}}
]
}
FOOTER:
{
"generate":"widget",
"type": "footer",
"class_list": null,
"id": "null",
"theme": "slapos-white",
"property_dict": {
"fixed": true
},
"children": []
}
NAVBAR:
{
"generate": "widget",
"type": "navbar",
"class_list": null,
"id": null,
"theme": "slapos-white",
"property_dict": {},
"children":[]
}
PANEL:
{
"generate": "widget",
"type": "panel",
"class_list": "",
"id": "global_panel",
"theme": "slapos-black",
"property_dict": {
"close": true
},
"children": []
}
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment
GitLab Nexedi Edition | About GitLab | About Nexedi | 沪ICP备2021021310号-2 | 沪ICP备2021021310号-7