This is an automated email from the ASF dual-hosted git repository.
carlosrovira pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/royale-docs.git
The following commit(s) were added to refs/heads/master by this push:
new 1bd6674 adding UI Sets main menu entry, since nesting in Frameworks
was left us without more nesting leves. Also we shoudn't nest more than 2-3
levels for usability
1bd6674 is described below
commit 1bd6674e79ed8e1aa779590cbb1748d71ac0fa63
Author: Carlos Rovira <[email protected]>
AuthorDate: Sun May 19 13:27:48 2019 +0200
adding UI Sets main menu entry, since nesting in Frameworks was left us
without more nesting leves. Also we shoudn't nest more than 2-3 levels for
usability
---
Get_Started/Frameworks.md | 14 +++-
Get_Started/Frameworks/Jewel.md | 79 ----------------------
Get_Started/Frameworks/Basic.md => UI_Sets.md | 13 ++--
UI_Sets/Basic.md | 34 ++++++++++
.../Basic.md => UI_Sets/Basic/Basic-Button.md | 4 +-
UI_Sets/Jewel.md | 78 +++++++++++++++++++++
.../Basic.md => UI_Sets/Jewel/Jewel-Alert.md | 4 +-
.../Basic.md => UI_Sets/Jewel/Jewel-Button.md | 4 +-
.../Basic.md => UI_Sets/Jewel/Jewel-TextInput.md | 4 +-
_data/toc.json | 14 ++--
10 files changed, 150 insertions(+), 98 deletions(-)
diff --git a/Get_Started/Frameworks.md b/Get_Started/Frameworks.md
index a03f01d..222ed8d 100644
--- a/Get_Started/Frameworks.md
+++ b/Get_Started/Frameworks.md
@@ -20,15 +20,23 @@ title: Frameworks
# Frameworks
+Sets of code libraries availables in Royale
+
A framework is a set of code that provides support for application development
by offering templates, components and examples. Royale provides its own
framework for making simple, small and fast applications, but also offers
support for using other popular JavaScript frameworks.
-- [Basic](Get_Started/Frameworks/Basic.html) is the most smallest, fastest and
PAYG set of components possible in Royale, and is used by other sets like Jewel
as its base.
+## Apache Royale UI Sets
+
+Apache Royale support its own [UI Sets](UI_Sets.html) designed to get the most
of the technology
-- [Jewel](Get_Started/Frameworks/Jewel.html) is focused in look and feel and
new practices present in modern development like responsivness and
multiplatform. Jewel support Themes and diferent kind of desktop and mobile
devices.
+- [Basic](UI_Sets/Basic.html) is the most smallest, fastest and PAYG set of
components possible in Royale, and is used by other sets like Jewel as its base.
+
+- [Jewel](UI_Sets/Jewel.html) is focused in look and feel and new practices
present in modern development like responsivness and multiplatform. Jewel
support Themes and diferent kind of desktop and mobile devices.
Why would you use a third-party framework with Royale? Because you like the
look and feel of that framework's user interface components but want to use
ActionScript to handle the business logic and/or use MXML to set up the UI.
-Royale supports (to varying degrees):
+## Other UI Sets
+
+These UI Sets are created under Royale umbrella, but uses or wraps existing
external libraries or frameworks. Royale supports (to varying degrees):
- [Material Design Lite](https://getmdl.io){:target='_blank'} Most, if not
all, components are available.
diff --git a/Get_Started/Frameworks/Jewel.md b/Get_Started/Frameworks/Jewel.md
deleted file mode 100644
index f4e30c8..0000000
--- a/Get_Started/Frameworks/Jewel.md
+++ /dev/null
@@ -1,79 +0,0 @@
----
-# 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.
-
-layout: docpage
-title: Jewel Introduction
----
-
-# Jewel
-
-A set of modern UI components
-
-Jewel is a themeizable and responsive set of user interface components for
Apache Royale to quickly build Front-end Applications with
[ActionScript](Welcome/Features/AS3.html) & [MXML](Welcome/Features/MXML.html).
-
-It's based by design on [Basic](Get_Started/Frameworks/Basic.html) components
but while Basic is very strict with concepts like
[PAYG](Welcome/Features/PAYG.html), in Jewel they are important but when it is
necessary, we prioritize other things like responsiveness, themes and look and
feel.
-
-## Browser Support
-
-Jewel works on the following table of devices, browsers and versions
-
-| | Browser | Minimun Version |
-|----------- |------------------- |----------------- |
-| __Desktop__ | Google Chrome | 44+ |
-| | Mozilla Firefox | 34+ |
-| | Apple Safari | 11.1+ |
-| | Microsfot Edge | 15+ |
-| | Microsfot IE | 11+ |
-| | Opera | |
-| __Mobile__ | iOS SafariMobile | 11.0+ |
-| | Android | 5.0 |
-| | Windows Mobile | |
-
-## Generated Javascript Output
-
-In the browsers, Apache Royale generates [ECMAScript version 5
(ES5)](https://en.wikipedia.org/wiki/ECMAScript) standard Javascript to ensure
applications are compatible with a great set of available browsers, including
Microssoft Internet Explorer 11 (IE11).
-
-## Components
-
-| Type | Name | Description
| Available SDK
| State |
-|------------ |----------------
|------------------------------------------------------------------------------------------------------
|--------------- |---------- |
-| Container | Card | Container that surronds other
components |
| |
-| | Grid | Container that uses Grid Layout and
need other immediate children to work as cells and host content. |
| |
-| | SimpleTable | An Basic HTML Table that can be
declared in MXML |
| |
-| | Table | An Complex HTML Table element filled
with a data source. Cells are ItemRenderers. |
| |
-| | TabBarContent | A Container to use with TabBar and
capable of parenting organized content |
| |
-| | Wizard | 11.0+
|
| |
-| Components | Alert | Displays a message and one or more
buttons in a view that pops up over all other controls and views. | 0.9.4
| Finished |
-| | Button |
|
| |
-| | CheckBox |
|
| |
-| | ComboBox |
|
| |
-| | DateChooser |
|
| |
-| | DateField |
|
| |
-| | DropDownList |
|
| |
-| | Form |
|
| |
-| | FormItem |
|
| |
-| | Icon |
|
| |
-| | Image |
|
| |
-| | Label |
|
| |
-| | List |
|
| |
-| | NumericStepper |
|
| |
-| | PopUp |
|
| |
-| | RadioButton |
|
| |
-| | Slider |
|
| |
-| | SnackBar |
|
| |
-| | TabBar |
|
| |
-| | TextInput |
|
| |
-| | |
|
| |
\ No newline at end of file
diff --git a/Get_Started/Frameworks/Basic.md b/UI_Sets.md
similarity index 59%
copy from Get_Started/Frameworks/Basic.md
copy to UI_Sets.md
index 6f07dc4..44faa09 100644
--- a/Get_Started/Frameworks/Basic.md
+++ b/UI_Sets.md
@@ -15,11 +15,16 @@
# limitations under the License.
layout: docpage
-title: Basic Introduction
+title: UI Sets
---
-# Basic
+# UI Sets
-subtitle
+Sets of components and containers designed in Apache Royale
+
+Royale provides its own UI Sets for making simple, small and fast applications:
+
+- [Basic](UI_Sets/Basic.html) is the most smallest, fastest and PAYG set of
components possible in Royale, and is used by other sets like Jewel as its base.
+
+- [Jewel](UI_Sets/Jewel.html) is focused in look and feel and new practices
present in modern development like responsivness and multiplatform. Jewel
support Themes and diferent kind of desktop and mobile devices.
-text
\ No newline at end of file
diff --git a/UI_Sets/Basic.md b/UI_Sets/Basic.md
new file mode 100644
index 0000000..c922401
--- /dev/null
+++ b/UI_Sets/Basic.md
@@ -0,0 +1,34 @@
+---
+# 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.
+
+layout: docpage
+title: Basic
+---
+
+# Basic
+
+The most smallest, fastest and PAYG set
+
+Basic is ...
+
+## Components
+
+| Type | Name | Description
| Available SDK
| State |
+|------------ |----------------
|------------------------------------------------------------------------------------------------------
|--------------- |---------- |
+| Container | |
|
| |
+| Components | Alert | Displays a message and one or more
buttons in a view that pops up over all other controls and views. | 0.0
| Finished |
+| | Button |
|
| |
+| | CheckBox |
|
| |
\ No newline at end of file
diff --git a/Get_Started/Frameworks/Basic.md b/UI_Sets/Basic/Basic-Button.md
similarity index 95%
copy from Get_Started/Frameworks/Basic.md
copy to UI_Sets/Basic/Basic-Button.md
index 6f07dc4..d183d5b 100644
--- a/Get_Started/Frameworks/Basic.md
+++ b/UI_Sets/Basic/Basic-Button.md
@@ -15,10 +15,10 @@
# limitations under the License.
layout: docpage
-title: Basic Introduction
+title: Basic Button
---
-# Basic
+# Basic Button
subtitle
diff --git a/UI_Sets/Jewel.md b/UI_Sets/Jewel.md
new file mode 100644
index 0000000..b76f3eb
--- /dev/null
+++ b/UI_Sets/Jewel.md
@@ -0,0 +1,78 @@
+---
+# 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.
+
+layout: docpage
+title: Jewel
+---
+
+# Jewel
+
+A set of modern UI components
+
+Jewel is a themeizable and responsive set of user interface components for
Apache Royale to quickly build Front-end Applications with
[ActionScript](Welcome/Features/AS3.html) & [MXML](Welcome/Features/MXML.html).
+
+It's based by design on [Basic](UI_Sets/Basic.html) components but while Basic
is very strict with concepts like [PAYG](Welcome/Features/PAYG.html), in Jewel
they are important but when it is necessary, we prioritize other things like
responsiveness, themes and look and feel.
+
+## Browser Support
+
+Jewel works on the following table of devices, browsers and versions
+
+| | Browser | Minimun Version |
+|----------- |------------------- |----------------- |
+| __Desktop__ | Google Chrome | 44+ |
+| | Mozilla Firefox | 34+ |
+| | Apple Safari | 11.1+ |
+| | Microsfot Edge | 15+ |
+| | Microsfot IE | 11+ |
+| | Opera | |
+| __Mobile__ | iOS SafariMobile | 11.0+ |
+| | Android | 5.0 |
+| | Windows Mobile | |
+
+## Generated Javascript Output
+
+In the browsers, Apache Royale generates [ECMAScript version 5
(ES5)](https://en.wikipedia.org/wiki/ECMAScript) standard Javascript to ensure
applications are compatible with a great set of available browsers, including
Microssoft Internet Explorer 11 (IE11).
+
+## Components
+
+| Type | Name | Description
|
Available SDK | State |
+|------------------ |------------------
|------------------------------------------------------------------------------------------------------
|--------------- |-------------- |
+| __Containers__ | Card | Container that surronds other
components |
| |
+| | Grid | Container that uses Grid
Layout and need other immediate children to work as cells and host content. |
| |
+| | SimpleTable | An Basic HTML Table that can
be declared in MXML |
| Finished |
+| | Table | An Complex HTML Table element
filled with a data source. Cells are ItemRenderers. |
| In Progress |
+| | TabBarContent | A Container to use with
TabBar and capable of parenting organized content |
| |
+| | Wizard | 11.0+
|
| |
+| __Components__ | [Alert](UI_Sets/Jewel/Jewel-Alert.html)
|
| Displays a message and one or more buttons in
a view that pops up over all other controls and views. | 0.9.4
| Finished |
+| | [Button](UI_Sets/Jewel/Jewel-Button.html)
|
| | |
+| | CheckBox |
|
| |
+| | ComboBox |
|
| |
+| | DateChooser |
|
| |
+| | DateField |
|
| |
+| | DropDownList |
|
| |
+| | Form |
|
| |
+| | FormItem |
|
| |
+| | Icon |
|
| |
+| | Image |
|
| |
+| | Label |
|
| |
+| | List |
|
| |
+| | NumericStepper |
|
| |
+| | PopUp |
|
| |
+| | RadioButton |
|
| |
+| | Slider |
|
| |
+| | SnackBar |
|
| |
+| | TabBar |
|
| |
+| | [TextInput](UI_Sets/Jewel/Jewel-TextInput.html)
|
| | |
diff --git a/Get_Started/Frameworks/Basic.md b/UI_Sets/Jewel/Jewel-Alert.md
similarity index 95%
copy from Get_Started/Frameworks/Basic.md
copy to UI_Sets/Jewel/Jewel-Alert.md
index 6f07dc4..95d89d1 100644
--- a/Get_Started/Frameworks/Basic.md
+++ b/UI_Sets/Jewel/Jewel-Alert.md
@@ -15,10 +15,10 @@
# limitations under the License.
layout: docpage
-title: Basic Introduction
+title: Jewel Alert
---
-# Basic
+# Jewel Alert
subtitle
diff --git a/Get_Started/Frameworks/Basic.md b/UI_Sets/Jewel/Jewel-Button.md
similarity index 95%
copy from Get_Started/Frameworks/Basic.md
copy to UI_Sets/Jewel/Jewel-Button.md
index 6f07dc4..39fd0d1 100644
--- a/Get_Started/Frameworks/Basic.md
+++ b/UI_Sets/Jewel/Jewel-Button.md
@@ -15,10 +15,10 @@
# limitations under the License.
layout: docpage
-title: Basic Introduction
+title: Jewel Button
---
-# Basic
+# Jewel Button
subtitle
diff --git a/Get_Started/Frameworks/Basic.md b/UI_Sets/Jewel/Jewel-TextInput.md
similarity index 94%
rename from Get_Started/Frameworks/Basic.md
rename to UI_Sets/Jewel/Jewel-TextInput.md
index 6f07dc4..bacb68f 100644
--- a/Get_Started/Frameworks/Basic.md
+++ b/UI_Sets/Jewel/Jewel-TextInput.md
@@ -15,10 +15,10 @@
# limitations under the License.
layout: docpage
-title: Basic Introduction
+title: Jewel TextInput
---
-# Basic
+# Jewel TextInput
subtitle
diff --git a/_data/toc.json b/_data/toc.json
index 470d6da..c5c47b3 100644
--- a/_data/toc.json
+++ b/_data/toc.json
@@ -21,14 +21,20 @@
{"path" : "Get Started.md",
"children" : [{"path" : "Get_Started/System-Requirements.md" },
{"path" : "Get_Started/Development-tools.md" },
- {"path" : "Get_Started/Frameworks.md",
- "children" : [{"path" :
"Get_Started/Frameworks/Basic.md" },
- {"path" :
"Get_Started/Frameworks/Jewel.md" }
- ]},
+ {"path" : "Get_Started/Frameworks.md"},
{"path" : "Get_Started/Download-Royale.md" },
{"path" : "Get_Started/Hello-World.md" }
]
},
+ {"path" : "UI_Sets.md",
+ "children" : [{"path" : "UI_Sets/Basic.md" },
+ {"path" : "UI_Sets/Jewel.md",
+ "children" : [{"path" :
"UI_Sets/Jewel/Jewel-Alert.md" },
+ {"path" :
"UI_Sets/Jewel/Jewel-Button.md" },
+ {"path" :
"UI_Sets/Jewel/Jewel-TextInput.md" }
+ ]
+ }
+ ]},
{"path" : "Create An Application.md",
"children" : [{"path" :
"create-an-application/application-structure.md"},
{"path" :
"create-an-application/application-tutorial.md",
