You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@royale.apache.org by ah...@apache.org on 2018/01/25 20:55:37 UTC
[royale-docs] branch develop updated (1b3a7cc -> 75db4e9)
This is an automated email from the ASF dual-hosted git repository.
aharui pushed a change to branch develop
in repository https://gitbox.apache.org/repos/asf/royale-docs.git.
from 1b3a7cc Update High Level View.md
new f0903ad ant script so I don't have to remember the options
new 442fbaf move to top level
new 2ccdbe5 fill in Create An Application
new 8bc59f7 Application Structure tweaks
new d8f928e another tweak for new path name
new 75db4e9 more pieces for Create An Application
The 6 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:
Create An Application.md | 36 +++++++++++
_layouts/docpage.html | 70 ++++++++++++++++++++--
build.xml | 37 ++++++++++++
.../application-structure.md | 0
.../code-conventions.md | 4 +-
create-an-application/migrate-an-existing-app.md | 13 ++++
.../migrate-an-existing-app/migrate-from-flex.md | 0
.../migrate-an-existing-app/migrate-from-js.md | 0
.../modules.md | 4 +-
.../security.md | 4 +-
10 files changed, 156 insertions(+), 12 deletions(-)
create mode 100644 Create An Application.md
create mode 100644 build.xml
copy {Welcome/create-an-application => create-an-application}/application-structure.md (100%)
copy Welcome/create-an-application/application-structure.md => create-an-application/code-conventions.md (54%)
create mode 100644 create-an-application/migrate-an-existing-app.md
rename {Welcome/create-an-application => create-an-application}/migrate-an-existing-app/migrate-from-flex.md (100%)
rename {Welcome/create-an-application => create-an-application}/migrate-an-existing-app/migrate-from-js.md (100%)
copy Welcome/create-an-application/application-structure.md => create-an-application/modules.md (56%)
rename Welcome/create-an-application/application-structure.md => create-an-application/security.md (56%)
--
To stop receiving notification emails like this one, please contact
aharui@apache.org.
[royale-docs] 03/06: fill in Create An Application
Posted by ah...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
aharui pushed a commit to branch develop
in repository https://gitbox.apache.org/repos/asf/royale-docs.git
commit 2ccdbe5ac1064a75cf5e902ed1dd92e090cc5737
Author: Alex Harui <ah...@apache.org>
AuthorDate: Thu Jan 25 10:26:02 2018 -0800
fill in Create An Application
---
Create An Application.md | 22 ++++++++++++++++++++++
1 file changed, 22 insertions(+)
diff --git a/Create An Application.md b/Create An Application.md
new file mode 100644
index 0000000..5e3dd61
--- /dev/null
+++ b/Create An Application.md
@@ -0,0 +1,22 @@
+---
+layout: docpage
+title: Create an Application
+---
+
+# Create an Application
+
+The easiest way to create a Royale application is to start with an existing one and modify it. In the examples folder are several examples you can use as a starting point. But if you want to know more about the underlying principles, read on.
+
+This document is divided into several sections:
+
+[Application Lifecycle](create-an-application/application-lifecycle.html) explains how a Royale application starts up and presents the initial UI.
+
+[Structure](create-an-application/application-structure.html) explains the important files that typically comprise and application and what they do.
+
+[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.
+
+[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.
+
+[Modules](create-an-application/modules.html) 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/royale-code-conventions.html) explains the typical ways Royale developers name files, classes, function, variables and more.
--
To stop receiving notification emails like this one, please contact
aharui@apache.org.
[royale-docs] 06/06: more pieces for Create An Application
Posted by ah...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
aharui pushed a commit to branch develop
in repository https://gitbox.apache.org/repos/asf/royale-docs.git
commit 75db4e9cacdacefc44e4a4407afcce0e5bff5c17
Author: Alex Harui <ah...@apache.org>
AuthorDate: Thu Jan 25 12:55:20 2018 -0800
more pieces for Create An Application
---
Create An Application.md | 16 +++++-
_layouts/docpage.html | 62 +++++++++++++++++++++++-
create-an-application/code-conventions.md | 8 +++
create-an-application/migrate-an-existing-app.md | 13 +++++
create-an-application/modules.md | 8 +++
create-an-application/security.md | 8 +++
6 files changed, 112 insertions(+), 3 deletions(-)
diff --git a/Create An Application.md b/Create An Application.md
index 5e3dd61..edb3cdb 100644
--- a/Create An Application.md
+++ b/Create An Application.md
@@ -1,8 +1,22 @@
---
+# 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: Create an Application
---
-
# Create an Application
The easiest way to create a Royale application is to start with an existing one and modify it. In the examples folder are several examples you can use as a starting point. But if you want to know more about the underlying principles, read on.
diff --git a/_layouts/docpage.html b/_layouts/docpage.html
index 3b60560..4aa3ccc 100644
--- a/_layouts/docpage.html
+++ b/_layouts/docpage.html
@@ -1,5 +1,5 @@
<!DOCTYPE HTML>
-<!--
+{% comment %}
Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file distributed with
@@ -16,7 +16,7 @@ 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.
--->
+{% endcomment %}
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/font-awesome/4.7.0/css/font-awesome.min.css" />
@@ -47,6 +47,8 @@ limitations under the License.
{% assign app_menu_open = "block" %}
{% elsif part == "ApplicationLifecycle" %}
{% assign lifecycle_menu_open = "block" %}
+{% elsif part == "migrate-an-existing-app" %}
+ {% assign migration_menu_open = "block" %}
{% endif %}
{% endfor %}
@@ -78,6 +80,12 @@ limitations under the License.
{% assign secure = "inline" %}
{% assign maintain = "inline" %}
{% assign structure = "inline" %}
+{% assign migrate = "inline" %}
+{% assign migrate_flex = "inline" %}
+{% assign migrate_js = "inline" %}
+{% assign security = "inline" %}
+{% assign modules = "inline" %}
+{% assign code_conventions = "inline" %}
{% assign label_welcome = "none" %}
{% assign label_high_level_view = "none" %}
{% assign label_features_and_concepts = "none" %}
@@ -106,6 +114,12 @@ limitations under the License.
{% assign label_secure = "none" %}
{% assign label_maintain = "none" %}
{% assign label_structure = "none" %}
+{% assign label_migrate = "none" %}
+{% assign label_migrate_flex = "none" %}
+{% assign label_migrate_js = "none" %}
+{% assign label_security = "none" %}
+{% assign label_modules = "none" %}
+{% assign label_code_conventions = "none" %}
{% case page.title %}
{% when "Welcome to Apache Royale" %}
{% assign welcome = "none" %}
@@ -191,6 +205,24 @@ limitations under the License.
{% when "Application structure" %}
{% assign structure = "none" %}
{% assign label_structure = "inline" %}
+ {% when "Migrate an existing application" %}
+ {% assign migrate = "none" %}
+ {% assign label_migrate = "inline" %}
+ {% when "Migrate from Flex" %}
+ {% assign migrate_flex = "none" %}
+ {% assign label_migrate_flex = "inline" %}
+ {% when "Migrate from JavaScript" %}
+ {% assign migrate_js = "none" %}
+ {% assign label_migrate_js = "inline" %}
+ {% when "Security" %}
+ {% assign security = "none" %}
+ {% assign label_security = "inline" %}
+ {% when "Modules" %}
+ {% assign modules = "none" %}
+ {% assign label_modules = "inline" %}
+ {% when "Royale Code Conventions" %}
+ {% assign code_conventions = "none" %}
+ {% assign label_code_conventions = "inline" %}
{% endcase %}
<div class="topbar">
<img src="http://royale.codeoscopic.com/wp-content/uploads/2018/01/apache-royale-tm-logo-dark.svg" style="margin-top:15px; margin-bottom: 5px; width: 190px; height: 40px;"/>
@@ -352,6 +384,32 @@ limitations under the License.
<a class="toc_link" href="create-an-application/application-structure.html" style="display: {{ structure }}">Application structure</a>
<span class="toc_label" style="display: {{ label_structure }}">Application structure</span>
</div>
+ <div class="toc_entry" >
+ <a class="toc_link" href="create-an-application/migrate-an-existing-app.html" style="display: {{ migrate }}">Migrate an existing application</a>
+ <span class="toc_label" style="display: {{ label_migrate }}">Migrate an existing application</span>
+ </div>
+ <div id="application_migration_menu" class="menu_div2" style="display: {{ migration_menu_open}}">
+ <div class="toc_entry" >
+ <a class="toc_link" href="create-an-application/migrate-an-existing-app/migrate-from-flex.html" style="display: {{ migrate_flex }}">Migrate from flex</a>
+ <span class="toc_label" style="display: {{ label_migrate_flex }}">Migrate from flex</span>
+ </div>
+ <div class="toc_entry" >
+ <a class="toc_link" href="create-an-application/migrate-an-existing-app/migrate-from-js.html" style="display: {{ migrate_js }}">Migrate from JavaScript</a>
+ <span class="toc_label" style="display: {{ label_migrate_js }}">Migrate from JavaScript</span>
+ </div>
+ </div>
+ <div class="toc_entry" >
+ <a class="toc_link" href="create-an-application/security.html" style="display: {{ security }}">Security</a>
+ <span class="toc_label" style="display: {{ label_security }}">Security</span>
+ </div>
+ <div class="toc_entry" >
+ <a class="toc_link" href="create-an-application/modules.html" style="display: {{ modules }}">Modules</a>
+ <span class="toc_label" style="display: {{ label_modules }}">Modules</span>
+ </div>
+ <div class="toc_entry" >
+ <a class="toc_link" href="create-an-application/code-conventions.html" style="display: {{ code_conventions }}">Royale code conventions</a>
+ <span class="toc_label" style="display: {{ label_code_conventions }}">Royale code conventions</span>
+ </div>
</div>
</div>
<div class="content" id="content">
diff --git a/create-an-application/code-conventions.md b/create-an-application/code-conventions.md
new file mode 100644
index 0000000..8749e00
--- /dev/null
+++ b/create-an-application/code-conventions.md
@@ -0,0 +1,8 @@
+---
+layout: docpage
+title: Royale code conventions
+---
+
+# Royale code conventions
+
+*This information will be available soon.*
diff --git a/create-an-application/migrate-an-existing-app.md b/create-an-application/migrate-an-existing-app.md
new file mode 100644
index 0000000..32afcb8
--- /dev/null
+++ b/create-an-application/migrate-an-existing-app.md
@@ -0,0 +1,13 @@
+---
+layout: docpage
+title: Migrate an existing application
+---
+
+# Migrate an existing application
+
+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)
+
+[Migrate from JavaScript](create-an-application/migrate-an-existing-app/migrate-from-js.html)
+
diff --git a/create-an-application/modules.md b/create-an-application/modules.md
new file mode 100644
index 0000000..5d0b976
--- /dev/null
+++ b/create-an-application/modules.md
@@ -0,0 +1,8 @@
+---
+layout: docpage
+title: Modules
+---
+
+# Modules
+
+*This information will be available soon.*
diff --git a/create-an-application/security.md b/create-an-application/security.md
new file mode 100644
index 0000000..246c84d
--- /dev/null
+++ b/create-an-application/security.md
@@ -0,0 +1,8 @@
+---
+layout: docpage
+title: Security
+---
+
+# Security
+
+*This information will be available soon.*
--
To stop receiving notification emails like this one, please contact
aharui@apache.org.
[royale-docs] 04/06: Application Structure tweaks
Posted by ah...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
aharui pushed a commit to branch develop
in repository https://gitbox.apache.org/repos/asf/royale-docs.git
commit 8bc59f7f376c665150bd1d5e9e4782206787b8e7
Author: Alex Harui <ah...@apache.org>
AuthorDate: Thu Jan 25 11:09:19 2018 -0800
Application Structure tweaks
---
_layouts/docpage.html | 6 +++---
1 file changed, 3 insertions(+), 3 deletions(-)
diff --git a/_layouts/docpage.html b/_layouts/docpage.html
index a9d1201..73e06b5 100644
--- a/_layouts/docpage.html
+++ b/_layouts/docpage.html
@@ -188,7 +188,7 @@ limitations under the License.
{% when "Maintain" %}
{% assign maintain = "none" %}
{% assign label_maintain = "inline" %}
- {% when "Structure" %}
+ {% when "Application structure" %}
{% assign structure = "none" %}
{% assign label_structure = "inline" %}
{% endcase %}
@@ -349,8 +349,8 @@ limitations under the License.
</div>
</div>
<div class="toc_entry" >
- <a class="toc_link" href="CreateAnApplication/Structure.html" style="display: {{ structure }}">Structure</a>
- <span class="toc_label" style="display: {{ label_structure }}">Structure</span>
+ <a class="toc_link" href="create-an-application/application-structure.html" style="display: {{ structure }}">Application structure</a>
+ <span class="toc_label" style="display: {{ label_structure }}">Application structure</span>
</div>
</div>
</div>
--
To stop receiving notification emails like this one, please contact
aharui@apache.org.
[royale-docs] 02/06: move to top level
Posted by ah...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
aharui pushed a commit to branch develop
in repository https://gitbox.apache.org/repos/asf/royale-docs.git
commit 442fbafaaa9c324b0d1e2697a3a91ff8cd37efba
Author: Alex Harui <ah...@apache.org>
AuthorDate: Thu Jan 25 10:25:39 2018 -0800
move to top level
---
.../application-structure.md | 0
.../migrate-an-existing-app/migrate-from-flex.md | 0
.../migrate-an-existing-app/migrate-from-js.md | 0
3 files changed, 0 insertions(+), 0 deletions(-)
diff --git a/Welcome/create-an-application/application-structure.md b/create-an-application/application-structure.md
similarity index 100%
rename from Welcome/create-an-application/application-structure.md
rename to create-an-application/application-structure.md
diff --git a/Welcome/create-an-application/migrate-an-existing-app/migrate-from-flex.md b/create-an-application/migrate-an-existing-app/migrate-from-flex.md
similarity index 100%
rename from Welcome/create-an-application/migrate-an-existing-app/migrate-from-flex.md
rename to create-an-application/migrate-an-existing-app/migrate-from-flex.md
diff --git a/Welcome/create-an-application/migrate-an-existing-app/migrate-from-js.md b/create-an-application/migrate-an-existing-app/migrate-from-js.md
similarity index 100%
rename from Welcome/create-an-application/migrate-an-existing-app/migrate-from-js.md
rename to create-an-application/migrate-an-existing-app/migrate-from-js.md
--
To stop receiving notification emails like this one, please contact
aharui@apache.org.
[royale-docs] 01/06: ant script so I don't have to remember the
options
Posted by ah...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
aharui pushed a commit to branch develop
in repository https://gitbox.apache.org/repos/asf/royale-docs.git
commit f0903ad663dfa245126bc3290b1cd09691374682
Author: Alex Harui <ah...@apache.org>
AuthorDate: Thu Jan 25 09:53:28 2018 -0800
ant script so I don't have to remember the options
---
build.xml | 37 +++++++++++++++++++++++++++++++++++++
1 file changed, 37 insertions(+)
diff --git a/build.xml b/build.xml
new file mode 100644
index 0000000..31109d8
--- /dev/null
+++ b/build.xml
@@ -0,0 +1,37 @@
+<?xml version="1.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.
+
+-->
+
+<project name="royale-docs" default="main" basedir=".">
+
+ <property file="${basedir}/../env.properties"/>
+ <property environment="env"/>
+ <property file="${basedir}/../local.properties"/>
+ <property file="${basedir}/../build.properties"/>
+
+ <target name="main" description="Build everything">
+ <exec executable="jekyll" failonerror="true">
+ <arg value="build" />
+ <arg value="--config" />
+ <arg value="local_config.yml" />
+ </exec>
+ </target>
+
+</project>
--
To stop receiving notification emails like this one, please contact
aharui@apache.org.
[royale-docs] 05/06: another tweak for new path name
Posted by ah...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
aharui pushed a commit to branch develop
in repository https://gitbox.apache.org/repos/asf/royale-docs.git
commit d8f928e6a9390f2aa9ee517b5e97f0ee82189d83
Author: Alex Harui <ah...@apache.org>
AuthorDate: Thu Jan 25 11:13:33 2018 -0800
another tweak for new path name
---
_layouts/docpage.html | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/_layouts/docpage.html b/_layouts/docpage.html
index 73e06b5..3b60560 100644
--- a/_layouts/docpage.html
+++ b/_layouts/docpage.html
@@ -43,7 +43,7 @@ limitations under the License.
{% assign involved_menu_open = "block" %}
{% elsif part == "GetStarted" %}
{% assign started_menu_open = "block" %}
-{% elsif part == "CreateAnApplication" %}
+{% elsif part == "create-an-application" %}
{% assign app_menu_open = "block" %}
{% elsif part == "ApplicationLifecycle" %}
{% assign lifecycle_menu_open = "block" %}
--
To stop receiving notification emails like this one, please contact
aharui@apache.org.