You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@royale.apache.org by ca...@apache.org on 2019/09/03 11:12:01 UTC
[royale-docs] branch master updated: - permalinks for create app
zone (first level) - move tutorial example to assets folder and show
running in the page - move code conventions to as3 zone - remove view
states page that is now obsolete
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 8a63f69 - permalinks for create app zone (first level) - move tutorial example to assets folder and show running in the page - move code conventions to as3 zone - remove view states page that is now obsolete
8a63f69 is described below
commit 8a63f69303ab4ca764a64fc82bb07fabd349ae45
Author: Carlos Rovira <ca...@apache.org>
AuthorDate: Tue Sep 3 13:11:55 2019 +0200
- permalinks for create app zone (first level)
- move tutorial example to assets folder and show running in the page
- move code conventions to as3 zone
- remove view states page that is now obsolete
---
_data/toc.json | 8 +++++++-
.../GitHubCommitLogViewer.css | 0
.../application-tutorial}/GitHubCommitLogViewer.js | 0
.../application-tutorial}/index.html | 0
.../application-tutorial}/project.json | 0
create-an-Application.md | 13 ++++++------
create-an-application/application-structure.md | 1 +
create-an-application/application-tutorial.md | 13 +++++++++++-
create-an-application/application-tutorial/main.md | 3 +--
.../application-tutorial/value-objects.md | 6 +++++-
create-an-application/migrate-an-existing-app.md | 4 ++++
.../migrate-an-existing-app/migrate-from-js.md | 2 +-
create-an-application/optimizations.md | 6 +++++-
create-an-application/security.md | 4 ++++
create-an-application/view-states.md | 23 ----------------------
features-and-concepts.md | 2 +-
.../actionscript}/code-conventions.md | 18 ++++++++++-------
features/as3.md | 7 +++++++
.../itemrenderers.md => features/item-renderers.md | 4 ++++
get-started/hello-world.md | 4 ++--
welcome/get-involved.md | 2 +-
21 files changed, 72 insertions(+), 48 deletions(-)
diff --git a/_data/toc.json b/_data/toc.json
index 2796691..5744c49 100644
--- a/_data/toc.json
+++ b/_data/toc.json
@@ -53,6 +53,9 @@
"path": "features/as3.md",
"children": [
{
+ "path": "features/actionscript/code-conventions.md"
+ },
+ {
"path": "features/actionscript/metadata.md"
},
{
@@ -85,6 +88,9 @@
"path": "features/view-states.md"
},
{
+ "path": "features/item-renderers.md"
+ },
+ {
"path": "features/modules.md"
},
{
@@ -204,7 +210,7 @@
]
},
{
- "path": "create-an-Application.md",
+ "path": "create-an-application.md",
"children": [
{
"path": "create-an-application/application-structure.md"
diff --git a/create-an-application/application-tutorial/example/GitHubCommitLogViewer.css b/assets/application-tutorial/GitHubCommitLogViewer.css
similarity index 100%
rename from create-an-application/application-tutorial/example/GitHubCommitLogViewer.css
rename to assets/application-tutorial/GitHubCommitLogViewer.css
diff --git a/create-an-application/application-tutorial/example/GitHubCommitLogViewer.js b/assets/application-tutorial/GitHubCommitLogViewer.js
similarity index 100%
rename from create-an-application/application-tutorial/example/GitHubCommitLogViewer.js
rename to assets/application-tutorial/GitHubCommitLogViewer.js
diff --git a/create-an-application/application-tutorial/example/index.html b/assets/application-tutorial/index.html
similarity index 100%
rename from create-an-application/application-tutorial/example/index.html
rename to assets/application-tutorial/index.html
diff --git a/create-an-application/application-tutorial/example/project.json b/assets/application-tutorial/project.json
similarity index 100%
rename from create-an-application/application-tutorial/example/project.json
rename to assets/application-tutorial/project.json
diff --git a/create-an-Application.md b/create-an-Application.md
index 804a907..51acd74 100644
--- a/create-an-Application.md
+++ b/create-an-Application.md
@@ -19,6 +19,7 @@ title: Create an Application
description: Building your first Apache Royale application
permalink: /create-an-application
---
+
# Create an Application
Building your first Apache Royale application
@@ -27,17 +28,15 @@ The easiest way to create a Royale application is to start with an existing one
This document is divided into several sections:
-[Application Structure](create-an-application/application-structure.html) explains the important files that typically comprise an application and what they do.
+[Application Structure](create-an-application/application-structure) explains the important files that typically comprise an application and what they do.
-[Application Tutorial](create-an-application/application-tutorial.html) is a step-by-step example of building an application.
+[Application Tutorial](create-an-application/application-tutorial) is a step-by-step example of building an application.
-[Migrate an Existing App](create-an-application/migrate-an-existing-app.html) provides strategies and techniques when migrating existing Flex apps to Royale, and how to switch to Royale if you already have a Javascript application.
+[Migrate an Existing App](create-an-application/migrate-an-existing-app) provides strategies and techniques when migrating existing Flex apps to Royale, and how to switch to Royale if you already have a Javascript application.
-[Security](create-an-application/security.html) provides more information about making sure hackers can't use your app to be malicous and about dealing with common security restrictions when your app wants to access external resources.
+[Security](create-an-application/security) provides more information about making sure hackers can't use your app to be malicous and about dealing with common security restrictions when your app wants to access external resources.
[Modules](features/modules) discusses how to break your application into pieces so it doesn't have to all get downloaded at once. Or have the whole thing compiled at once.
-[Royale code conventions](create-an-application/code-conventions.html) explains the typical ways Royale developers name files, classes, function, variables and more.
-
-[Optimizations](create-an-application/optimizations.html) explains some of the compiler settings and in-code doc comment directives that can be used to tune the output of javascript that Royale generates.
+[Optimizations](create-an-application/optimizations) explains some of the compiler settings and in-code doc comment directives that can be used to tune the output of javascript that Royale generates.
diff --git a/create-an-application/application-structure.md b/create-an-application/application-structure.md
index 6aeb0c7..5806497 100644
--- a/create-an-application/application-structure.md
+++ b/create-an-application/application-structure.md
@@ -17,6 +17,7 @@
layout: docpage
title: Application structure
description: All about the organization of your project files and folders
+permalink: /create-an-application/application-structure
---
# Application structure
diff --git a/create-an-application/application-tutorial.md b/create-an-application/application-tutorial.md
index 16745f6..c7a7044 100644
--- a/create-an-application/application-tutorial.md
+++ b/create-an-application/application-tutorial.md
@@ -15,12 +15,23 @@
# limitations under the License.
layout: docpage
-title: Tutorial - GitHub Commit Log Application
+title: Application tutorial
+description: A complete tutorial on how to build a simple Royale application
+permalink: /create-an-application/application-tutorial
---
+
# Tutorial - GitHub Commit Log Application
+A complete tutorial on how to build a simple Royale application
+
This tutorial will take you through building an app that displays the commit logs for the Royale project by connecting to the [GitHub](https://github.com){:target='_blank'} servers.
+See the running example:
+
+<iframe frameborder="no" border="0" marginwidth="0" marginheight="0"
+width="100%" height="350"
+src="assets/application-tutorial/index.html"></iframe>
+
The steps in this tutorial start with a blank file and walk you through what to add and why. Or you can get the complete source [here](https://github.com/apache/royale-asjs/blob/develop/examples/express/GitHubCommitLogViewer){:target='_blank'}. Note that Royale examples are set up to build with [Apache Maven](https://maven.apache.org){:target='_blank'} so the folder structure reflects that. There are other ways to organize your code.
The first six segments will result in a functional application.
diff --git a/create-an-application/application-tutorial/main.md b/create-an-application/application-tutorial/main.md
index 1bfe2ad..fcdc056 100644
--- a/create-an-application/application-tutorial/main.md
+++ b/create-an-application/application-tutorial/main.md
@@ -39,8 +39,7 @@ The line:
means that the "js" prefix is mapped to the Express set of [components](user-interface/components.html). The Express set is designed for rapid prototyping and proofs-of-concepts and is not optimized for size and performance. Applications built with the Express components can still be deployed in production environments if the size and performance is acceptable, which it often is.
-As mentioned in [Application structure](create-an-application/application-structure.html), there is more than one pattern for creating applications. This example will use the MVC pattern. So, the next step is to create the Model.
-
+As mentioned in [Application structure](create-an-application/application-structure), there is more than one pattern for creating applications. This example will use the MVC pattern. So, the next step is to create the Model.
{:align="center"}
\| [Next Page](create-an-application/application-tutorial/data.html)
diff --git a/create-an-application/application-tutorial/value-objects.md b/create-an-application/application-tutorial/value-objects.md
index 98444d2..d18e83e 100644
--- a/create-an-application/application-tutorial/value-objects.md
+++ b/create-an-application/application-tutorial/value-objects.md
@@ -94,7 +94,11 @@ Another way to prevent the Google Closure Compiler from renaming variables is to
This should now work. If you look in the js-release folder, you now have a single .js file to deploy (along with the .css, .json and .html files). The .js.map file is there in case you have to debug this optimized .js file. If you don't deploy it, anyone trying to reverse-engineer your application is in for quite a challenge!
-If you weren't really following the steps and just skimming, the file in its final form is available [here](create-an-application/application-tutorial/example/index.html){:target='_blank'}.
+If you weren't really following the steps and just skimming, the file in its final form is available [here](assets/application-tutorial/index.html){:target='_blank'}.
+
+<iframe frameborder="no" border="0" marginwidth="0" marginheight="0"
+width="100%" height="350"
+src="assets/application-tutorial/index.html"></iframe>
This concludes the set of steps required to create a not-so-simple application and put it into production. The next steps, which are not yet complete, add additional features to the application.
diff --git a/create-an-application/migrate-an-existing-app.md b/create-an-application/migrate-an-existing-app.md
index a996fc9..b69a172 100644
--- a/create-an-application/migrate-an-existing-app.md
+++ b/create-an-application/migrate-an-existing-app.md
@@ -16,10 +16,14 @@
layout: docpage
title: Migrate an existing application
+description: Coming from other technologies to Royale
+permalink: /create-an-application/migrate-an-existing-app
---
# Migrate an existing application
+Coming from other technologies to Royale
+
If you have an existing application and want to start using Royale, the following documents may help you.
[Migrate From Flex](create-an-application/migrate-an-existing-app/migrate-from-flex.html)
diff --git a/create-an-application/migrate-an-existing-app/migrate-from-js.md b/create-an-application/migrate-an-existing-app/migrate-from-js.md
index 573f9d6..37e9691 100644
--- a/create-an-application/migrate-an-existing-app/migrate-from-js.md
+++ b/create-an-application/migrate-an-existing-app/migrate-from-js.md
@@ -39,4 +39,4 @@ If you are thinking of moving to an easier way of writing applications, compilin
Take Royale out for a spin!
- [Hello, world!](get-started/hello-world)
-- [Create an applicaton](create-an-Application)
+- [Create an applicaton](create-an-application)
diff --git a/create-an-application/optimizations.md b/create-an-application/optimizations.md
index 5f28067..554be0a 100644
--- a/create-an-application/optimizations.md
+++ b/create-an-application/optimizations.md
@@ -16,10 +16,14 @@
layout: docpage
title: Optimizations
+description: Compiler settings and doc comments directives that can be used to improve generated output
+permalink: /create-an-application/optimizations
---
# Optimizations
-Warning: This document is a work-in-progress/undergoing review.
+Compiler settings and doc comments directives that can be used to improve generated output
+
+*Warning: This document is a work-in-progress/undergoing review.*
## Optimization options
diff --git a/create-an-application/security.md b/create-an-application/security.md
index ebaf2c0..e95d5f3 100644
--- a/create-an-application/security.md
+++ b/create-an-application/security.md
@@ -16,10 +16,14 @@
layout: docpage
title: Security
+description: Target environment security rules
+permalink: /create-an-application/security
---
# Security
+Target environment security rules
+
Royale can output a SWF that runs on the Adobe Flash/AIR runtimes or HTML/JS/CSS that run in browsers and other environments that support JavaScript, such as Node.
Each runtime environment has its own security rules. Here are links to security documentation for these runtimes:
diff --git a/create-an-application/view-states.md b/create-an-application/view-states.md
deleted file mode 100644
index 0bf1f09..0000000
--- a/create-an-application/view-states.md
+++ /dev/null
@@ -1,23 +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: View States
----
-
-# View States
-
-*information coming soon.*
\ No newline at end of file
diff --git a/features-and-concepts.md b/features-and-concepts.md
index 35c70ea..a73f513 100644
--- a/features-and-concepts.md
+++ b/features-and-concepts.md
@@ -24,7 +24,7 @@ permalink: /features-and-concepts
Key points to learn Apache Royale
-Here are some things you may need to know to help you be more productive with Royale, although some folks get pretty far by just following the tutorial in [Create an Application](create-an-Application) and extending it.
+Here are some things you may need to know to help you be more productive with Royale, although some folks get pretty far by just following the tutorial in [Create an Application](create-an-application) and extending it.
## AS3 and MXML Languages
diff --git a/create-an-application/code-conventions.md b/features/actionscript/code-conventions.md
similarity index 91%
rename from create-an-application/code-conventions.md
rename to features/actionscript/code-conventions.md
index b297200..2530ca7 100644
--- a/create-an-application/code-conventions.md
+++ b/features/actionscript/code-conventions.md
@@ -15,12 +15,16 @@
# limitations under the License.
layout: docpage
-title: Royale code conventions
+title: Code Conventions
+description: Coding standards for writing code in ActionScript 3
+permalink: /features/as3/code-conventions
---
-# Royale code conventions
+# Code Conventions
-Warning: This document is not complete.
+Coding standards for writing code in ActionScript 3
+
+*Warning: This document is not complete.*
## Packages
@@ -54,7 +58,7 @@ To compare:
### Flex
-```actionscript
+```as3
public class TimerEvent {
public const TIMER:String = "timer";
}
@@ -66,7 +70,7 @@ public class Timer {
Usage:
-```actionscript
+```as3
import TimerEvent;
import Timer;
@@ -80,7 +84,7 @@ function timerHandler(event:TimerEvent):void
### Royale
-```actionscript
+```as3
public class Timer {
public const TIMER:String = "timer";
dispatchEvent(new Event(TIMER));
@@ -89,7 +93,7 @@ public class Timer {
Usage:
-```actionscript
+```as3
import Timer;
var timer:Timer = new Timer();
diff --git a/features/as3.md b/features/as3.md
index fe8364b..16fccc9 100644
--- a/features/as3.md
+++ b/features/as3.md
@@ -51,6 +51,13 @@ package org.apache.royale
}
```
+## Sections
+
+This document is divided into several sections:
+
+[Metadata](features/as3/metadata) describe the Metadata decorations that can be used for variables and functions.
+[Code Conventions](features/as3/code-conventions) explains the typical ways Royale developers name files, classes, function, variables and more.
+
## New ActionScript language features in Royale
The Royale compiler extends the ActionScript language with useful, new features. These language extensions are considered optional, and to use the new syntax, you must enable certain compiler flags.
diff --git a/create-an-application/itemrenderers.md b/features/item-renderers.md
similarity index 78%
rename from create-an-application/itemrenderers.md
rename to features/item-renderers.md
index a96d1ee..9eeb3d2 100644
--- a/create-an-application/itemrenderers.md
+++ b/features/item-renderers.md
@@ -16,8 +16,12 @@
layout: docpage
title: ItemRenderers
+description: Visual representation of data items in lists and other collection components
+permalink: /features/item-renderers
---
# ItemRenderers
+Visual representation of data items in lists and other collection components
+
*information coming soon.*
\ No newline at end of file
diff --git a/get-started/hello-world.md b/get-started/hello-world.md
index 9dd74b4..525caa3 100644
--- a/get-started/hello-world.md
+++ b/get-started/hello-world.md
@@ -24,7 +24,7 @@ permalink: /get-started/hello-world
Try the simplest piece of code possible
-To verify that the Royale SDK is set up correctly, we recommend you create and build a ["Hello World"](https://en.wikipedia.org/wiki/%22Hello,_World!%22_program){:target='_blank'} example. If that works, you can move on to [Create an Application](create-an-Application) and work through the tutorial on building a more substantial application.
+To verify that the Royale SDK is set up correctly, we recommend you create and build a ["Hello World"](https://en.wikipedia.org/wiki/%22Hello,_World!%22_program){:target='_blank'} example. If that works, you can move on to [Create an Application](create-an-application) and work through the tutorial on building a more substantial application.
These instructions presume you are not using an [IDE](https://en.wikipedia.org/wiki/Integrated_development_environment){:target='_blank'}, but are creating files in a text editor and compiling using command-line scripts or similar controls. [Development tools](get-started/development-tools) that fully support Royale provide their own instructions for building your first Royale applications.
@@ -87,4 +87,4 @@ Projects/HelloWorld/bin/js-release
In that folder should be an `index.html` file you can open in your browser to see your "Hello World" application. If you see that, congratulations! You have installed Royale successfully and are ready to build Royale applications.
-[Create an Application](create-an-Application) contains a tutorial for building a more substantial application. The Royale SDK includes an **Examples** directory that provides practical demonstrations of how to achieve many features and effects using Royale.
+[Create an Application](create-an-application) contains a tutorial for building a more substantial application. The Royale SDK includes an **Examples** directory that provides practical demonstrations of how to achieve many features and effects using Royale.
diff --git a/welcome/get-involved.md b/welcome/get-involved.md
index 9eeaebc..1b73e4f 100644
--- a/welcome/get-involved.md
+++ b/welcome/get-involved.md
@@ -19,7 +19,7 @@ Apache Royale is a non-profit, open-source project. It grows and thrives on cont
## The Royale team
-Becoming active with Royale usually starts with becoming connected with the developers who are working on the code and the users who are building or adapting applications with it. Check out [the details](https://royale.apache.org/get-involved){:target='_blank'} here, or meet our [most active contributors](https://royale.apache.org/team/){:target='_blank'}. We hope you can join us!
+Becoming active with Royale usually starts with becoming connected with the developers who are working on the code and the users who are building or adapting applications with it. Check out [the details](https://royale.apache.org/get-involved){:target='_blank'} here, or meet our [most active contributors](https://royale.apache.org/team){:target='_blank'}. We hope you can join us!
## Apache Software Foundation