You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@royale.apache.org by ha...@apache.org on 2020/08/17 09:28:32 UTC
[royale-docs] branch master updated (705365c -> b46b12b)
This is an automated email from the ASF dual-hosted git repository.
harbs pushed a change to branch master
in repository https://gitbox.apache.org/repos/asf/royale-docs.git.
from 705365c start docs for List and ButtonBar
new 3e334eb {:target='_blank'} doesn't work in non-generated pages
new f9e04e4 typos
new c950465 Updated readme for more info on local builds
new b46b12b Filled in routing page.
The 4 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails. The revisions
listed as "add" were already present in the repository and have only
been added to this reference.
Summary of changes:
README.md | 27 ++++++++++++++++-----------
component-sets/jewel/jewel-alert.md | 8 ++++----
features/routing.md | 28 ++++++++++++++++++++++++----
3 files changed, 44 insertions(+), 19 deletions(-)
[royale-docs] 02/04: typos
Posted by ha...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
harbs pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/royale-docs.git
commit f9e04e4462e66e6ddd0e5e6c18c549781296be80
Author: Harbs <ha...@in-tools.com>
AuthorDate: Mon Aug 17 11:45:05 2020 +0300
typos
---
component-sets/jewel/jewel-alert.md | 8 ++++----
1 file changed, 4 insertions(+), 4 deletions(-)
diff --git a/component-sets/jewel/jewel-alert.md b/component-sets/jewel/jewel-alert.md
index fa8e86b..507a071 100644
--- a/component-sets/jewel/jewel-alert.md
+++ b/component-sets/jewel/jewel-alert.md
@@ -31,7 +31,7 @@ Available since version __0.9.4__
|------------------------------ |---------------------------------- |--------------------------------- |
| [org.apache.royale.jewel.Alert](https://royale.apache.org/asdoc/index.html#!org.apache.royale.jewel/Alert){:target='_blank'} | [org.apache.royale.jewel.Group](https://royale.apache.org/asdoc/index.html#!org.apache.royale.jewel/Group){:target='_blank'} | [org.apache.royale.core.IPopUp](https://royale.apache.org/asdoc/index.html#!org.apache.royale.core/IPopUp){:target='_blank'} |
-<sup>_Note: This component is currently only available in JavaScript_</sup>.
+<sup>_Note: This component is currently only available in JavaScript._</sup>
## Overview
@@ -56,7 +56,7 @@ Click the following button to see an example of `Alert`:
width="100%" height="300"
src="assets/BE0002_Using_Jewel_Alert_Control/index.html"></iframe>
-To close the window, click one of the buttons on the bottom `ControlBar`, or programatically call the `Alert.close()` method on the instance.
+To close the window, click one of the buttons on the bottom `ControlBar`, or programmatically call the `Alert.close()` method on the instance.
## Relevant Properties and Methods
@@ -74,7 +74,7 @@ To close the window, click one of the buttons on the bottom `ControlBar`, or pro
| Method | Parameters | Description |
|----------- |--------------------------------------------------------------- |---------------------------------------------------------------------------------------------------------------------------------- |
-| __show__ | _message(String), title(String), flags(uint), parent(Object)_ | Shows the Alert non modal anchored to the given parent object, which is usally a root component such as *, as a UIView or body if null. |
+| __show__ | _message(String), title(String), flags(uint), parent(Object)_ | Shows the Alert non modal anchored to the given parent object, which is usually a root component such as *, as a UIView or body if null. |
| __close__ | buttonFlag:uint = 0x000004 | Closes the dialog element. |
## Relevant Events
@@ -107,7 +107,7 @@ The `Alert` component uses the following beads:
| [IBeadModel](https://royale.apache.org/asdoc/index.html#!org.apache.royale.core/IBeadModel){:target='_blank'} | [org.apache.royale.jewel.beads.models.AlertModel](https://royale.apache.org/asdoc/index.html#!org.apache.royale.jewel.beads.models/AlertModel){:target='_blank'} | The data model for the Alert. |
| [IBeadView](https://royale.apache.org/asdoc/index.html#!org.apache.royale.core/IBeadView){:target='_blank'} | [org.apache.royale.jewel.beads.views.AlertView](https://royale.apache.org/asdoc/index.html#!org.apache.royale.jewel.beads.views/AlertView){:target='_blank'} | The bead used to create the elements of the Alert. |
| [IBeadController](https://royale.apache.org/asdoc/index.html#!org.apache.royale.core/IBeadController){:target='_blank'} | [org.apache.royale.jewel.beads.controllers.AlertController](https://royale.apache.org/asdoc/index.html#!org.apache.royale.jewel.beads.controllers/AlertController){:target='_blank'} | The bead used to handle input events. |
-| [IBeadLayout](https://royale.apache.org/asdoc/index.html#!org.apache.royale.core/IBeadLayout){:target='_blank'} | [org.apache.royale.jewel.beads.layouts.NullLayout](){:target='_blank'}<sup>_(*)_</sup> | The bead used to postion the elements of the Alert. |
+| [IBeadLayout](https://royale.apache.org/asdoc/index.html#!org.apache.royale.core/IBeadLayout){:target='_blank'} | [org.apache.royale.jewel.beads.layouts.NullLayout](){:target='_blank'}<sup>_(*)_</sup> | The bead used to position the elements of the Alert. |
<sup>_(*) NullLayout is used temporarily_.</sup>
[royale-docs] 01/04: {:target='_blank'} doesn't work in
non-generated pages
Posted by ha...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
harbs pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/royale-docs.git
commit 3e334ebbe7270e707721c161ed1ebe3082678140
Author: Harbs <ha...@in-tools.com>
AuthorDate: Mon Aug 17 11:44:53 2020 +0300
{:target='_blank'} doesn't work in non-generated pages
---
README.md | 18 +++++++++---------
1 file changed, 9 insertions(+), 9 deletions(-)
diff --git a/README.md b/README.md
index a20ad89..7eab2b5 100644
--- a/README.md
+++ b/README.md
@@ -5,7 +5,7 @@
We have three main audiences:
-1. Folks who have previously developed applications using [Apache Flex](https://flex.apache.org){:target='_blank'}, and who want to learn whether and how to migrate their apps to Apache Royale.
+1. Folks who have previously developed applications using [Apache Flex](https://flex.apache.org), and who want to learn whether and how to migrate their apps to Apache Royale.
2. People who are new to AS3 and MXML, and possibly new to developing applications altogether, and want to know how to get started.
3. Experienced developers who want to see if Royale will give a better experience both in code development and through the application's lifecycle than what they have been using.
@@ -17,8 +17,8 @@ We produce four flavors of documentation:
1. *Tutorials* to show how to do a complete thing, with source code a reader can copy and learn from. These generally appear on the website blog at the moment.
2. *How-to guides* that explain how to achieve something in Royale that is either of a general nature ("How to find the bead you need") or does not merit a full tutorial ("How to disable an input field"). This material should be in the user documentation.
-3. *Explanations* that explain the "why" of Royale features--why we do it this way, or avoid doing it that way. This appears in the [High Level View](welcome/high-level-view){:target='_blank'} pages of the user documentation.
-4. *Technical references* are all the gritty details of what each Royale component, bead, and feature requires, produces, and can do. This material would normally be in the [ASDoc reference](https://royale.apache.org/asdoc/){:target='_blank'}, the [framework wiki](https://github.com/apache/royale-asjs/wiki){:target='_blank'}, or the [compiler wiki](https://github.com/apache/royale-compiler/wiki){:target='_blank'}.
+3. *Explanations* that explain the "why" of Royale features--why we do it this way, or avoid doing it that way. This appears in the [High Level View](welcome/high-level-view) pages of the user documentation.
+4. *Technical references* are all the gritty details of what each Royale component, bead, and feature requires, produces, and can do. This material would normally be in the [ASDoc reference](https://royale.apache.org/asdoc/), the [framework wiki](https://github.com/apache/royale-asjs/wiki), or the [compiler wiki](https://github.com/apache/royale-compiler/wiki).
No one flavor is better in all circumstances than the others. All contributions strengthen Royale by expanding the number of people who can find the answers they need to create applications.
@@ -35,7 +35,7 @@ Each `.md` page starts with "front matter" structured like this:
# 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: README
-description: short description of the page that will help social networks to show appropiate info
+description: short description of the page that will help social networks to show appropriate info
permalink: /friendly-url
---
@@ -70,18 +70,18 @@ without the leading "/". Links are case-sensitive, and you need to insert `%20`
When linking to locations not in the help-docs stack, including other pages in the Royale website, clicking the link should open a new browser window or tab so the reader does not lose their place in the help docs:
-`[Apache Flex](https://flex.apache.org){:target='_blank'}`
+`[Apache Flex](https://flex.apache.org)`
## About Search
-Search is done thanks to [Algolia DocSearch](https://community.algolia.com/docsearch/){:target='_blank'}.
+Search is done thanks to [Algolia DocSearch](https://community.algolia.com/docsearch/).
- * [Algolia DocSearch Docs](https://community.algolia.com/docsearch/what-is-docsearch.html){:target='_blank'}
+ * [Algolia DocSearch Docs](https://community.algolia.com/docsearch/what-is-docsearch.html)
## Build Locally
-1. Install [Ruby+Devkit](https://rubyinstaller.org/downloads/){:target='_blank'}. Ruby is required to run Jekyll.
-2. Install [Jekyll](https://jekyllrb.com/){:target='_blank'}.
+1. Install [Ruby+Devkit](https://rubyinstaller.org/downloads/). Ruby is required to run Jekyll.
+2. Install [Jekyll](https://jekyllrb.com/).
3. If you want to provide a local configuration, copy `_config.yml` to `local_config.yml`.
4. To build the docs, run the following command:
[royale-docs] 03/04: Updated readme for more info on local builds
Posted by ha...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
harbs pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/royale-docs.git
commit c950465e6066a34de6e18f8427fa132f9095bc95
Author: Harbs <ha...@in-tools.com>
AuthorDate: Mon Aug 17 11:48:20 2020 +0300
Updated readme for more info on local builds
---
README.md | 9 +++++++--
1 file changed, 7 insertions(+), 2 deletions(-)
diff --git a/README.md b/README.md
index 7eab2b5..00cc5e4 100644
--- a/README.md
+++ b/README.md
@@ -86,7 +86,7 @@ Search is done thanks to [Algolia DocSearch](https://community.algolia.com/docse
4. To build the docs, run the following command:
```sh
- jekyll build --config local_config.yml
+ jekyll build --watch --config _config.yml
```
The website will be rendered inside the `_site` folder.
@@ -95,5 +95,10 @@ Search is done thanks to [Algolia DocSearch](https://community.algolia.com/docse
```sh
jekyll serve
```
-
+ You might need the following for automatic regeneration:
+
+ ```sh
+ jekyll serve --force_polling
+ ```
+
The website will be available at `http://127.0.0.1:4000/royale-docs/`.
[royale-docs] 04/04: Filled in routing page.
Posted by ha...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
harbs pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/royale-docs.git
commit b46b12b801556b163575596084aa8717f6d259d6
Author: Harbs <ha...@in-tools.com>
AuthorDate: Mon Aug 17 12:28:18 2020 +0300
Filled in routing page.
---
features/routing.md | 28 ++++++++++++++++++++++++----
1 file changed, 24 insertions(+), 4 deletions(-)
diff --git a/features/routing.md b/features/routing.md
index 1d808c3..dc002f2 100644
--- a/features/routing.md
+++ b/features/routing.md
@@ -26,10 +26,23 @@ Map URL parameters to different initial values in the app, and vice versa
_this page is not complete_
## Basic Router
+
+There are two types of routing. Routing can be completely within the browser and in that case, the routing is handled in the portion of the URL after the hash (`#`). This is called "hash routing" or `HashRouter`. A more complex form of routing can be used which is indistinguishable from separate path-based web pages. This (for lack of a better term) is called browser routing `BrowserRouter`. To use browser routing, your server must be setup to support this.
+
+`HashRouter` can be used with, or without "hash-bangs" A hash-bang (`#!`) is a special notation to search engines that the hash should be treated as a page to be indexed by the search engine. Regular hashes will work the same, but will generally not be searchable. Hash-bangs can be enabled or disabled using the `useHashBang` property.
+
+`BrowserRouter` requires a `basePath` to function correctly. This is the path relative to the domain where the application is loaded. Anything below that path will be considered a "routing" path. The base path needs to match the settings on the server. There are many guides on the web on how to setup your server [here's one](https://www.digitalocean.com/community/tutorials/react-react-router-ssr). Any instructions for setting up a particular server to work with Angular or React (or most [...]
+
+On the most basic level, routers (whether hash based or path browser based) can be used by manually reacting to router state changes.
````
-<js:Router id="router" stateChange="hashChanged()"/>
+<js:HashRouter id="router" stateChange="hashChanged()"/>
````
-In the above example, any time the route changes, the `stateChanged` function will be called.
+
+````
+<js:BrowserRouter id="router" stateChange="hashChanged()"/>
+````
+
+In the above examples, any time the route changes, the `stateChanged` function will be called.
The state of the router can likewise be changed directly by modifying the `router.routeState` and calling `router.setState()` `router.renderState()` is a similar method, but it will dispatch the `stateChanged` event as well and cause any attached beads to react to the state change.
@@ -44,9 +57,9 @@ The full power of the Router becomes apparent when you use beads. Router can aut
In this example, the router syncs the state of the footer with the route path. The RouteTitleLookup allows changing the window title based on the state. The `lookup` property is an object whose keys are the state names and the values are the corresponding titles.
-Routers and RouteTotState can be declared on and for more than one component, so state can be changed and synced across multiple components with ease.
+`Router`s and `RouteToState` can be declared on and for more than one component, so state can be changed and synced across multiple components with ease.
-Another example which routes to components: (in progress)
+Another example which routes to components:
````
<js:Router localId="router">
<js:RouteToComponent component="{footer}"/>
@@ -54,4 +67,11 @@ Another example which routes to components: (in progress)
</js:Router>
````
+The currently supported beads are the following:
+### `RouteToComponent`
+### `RouteToParameters`
+### `RouteToState`
+### `SetRouteTitle`
+### `PathRouteBead`
+
*Instructions and sample code will appear here soon to show how you can map URL parameters to different initial values in the application, and vice versa.*