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 07:42:57 UTC
[royale-docs] branch master updated: update links to remove the
rest of "a links" and substitute for md links with target blank to unify
all links
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 0587998 update links to remove the rest of "a links" and substitute for md links with target blank to unify all links
0587998 is described below
commit 058799863ba24a5512f8a394f00577e940264be3
Author: Carlos Rovira <ca...@apache.org>
AuthorDate: Tue Sep 3 09:42:32 2019 +0200
update links to remove the rest of "a links" and substitute for md links with target blank to unify all links
---
create-an-application/application-structure.md | 4 +++-
create-an-application/application-tutorial.md | 4 ++--
create-an-application/application-tutorial/data.md | 4 ++--
create-an-application/application-tutorial/main.md | 3 ++-
.../migrate-an-existing-app/migrate-from-flex.md | 3 +--
create-an-application/security.md | 10 ++++++----
frameworks/crux.md | 4 ++--
testing.md | 2 +-
testing/royaleunit.md | 2 +-
9 files changed, 20 insertions(+), 16 deletions(-)
diff --git a/create-an-application/application-structure.md b/create-an-application/application-structure.md
index 1ac1a32..6aeb0c7 100644
--- a/create-an-application/application-structure.md
+++ b/create-an-application/application-structure.md
@@ -16,10 +16,13 @@
layout: docpage
title: Application structure
+description: All about the organization of your project files and folders
---
# Application structure
+All about the organization of your project files and folders
+
Royale applications are usually comprised of many files. If you are in rapid-prototyping or proof-of-concept "get something small running quickly" mode, you can cram everything into one file. But breaking things into multiple pieces often helps you organize or create "separation of concerns", and as your project and team grows, you and your teammates can work on individual pieces independently without stepping on each other's work. Finally, coherent pieces that perform some standard func [...]
There are multiple popular ways of dividing an Application into coherent and reusable pieces: Model-View (MV), Model-View-Controller (MVC), and other alphabet soup like MVP, MVVM, HMVC and more. This documentation will not address these patterns in detail. You can read more about them on the internet.
@@ -64,4 +67,3 @@ If you create a production version, you will also see:
|-MyFirstRoyaleApp.js
|-MyFirstRoyaleApp.css
```
-
diff --git a/create-an-application/application-tutorial.md b/create-an-application/application-tutorial.md
index 48293c2..16745f6 100644
--- a/create-an-application/application-tutorial.md
+++ b/create-an-application/application-tutorial.md
@@ -19,9 +19,9 @@ title: Tutorial - GitHub Commit Log Application
---
# Tutorial - GitHub Commit Log Application
-This tutorial will take you through building an app that displays the commit logs for the Royale project by connecting to the <a href="https://github.com/" target="_blank">GitHub</a> servers.
+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.
-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 <a href="https://github.com/apache/royale-asjs/blob/develop/examples/express/GitHubCommitLogViewer" target="_blank">here</a>. 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 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/data.md b/create-an-application/application-tutorial/data.md
index ffcf1dc..1feac21 100644
--- a/create-an-application/application-tutorial/data.md
+++ b/create-an-application/application-tutorial/data.md
@@ -41,14 +41,14 @@ It might be nice to not hard-code which repos we use to get the commits so that
public var projectName:String;
```
-Next, we need to get the values for these arrays. Let's use a <a href="https://www.json.org/" target="_blank">.json</a> file, called "project.json", to configure which repos to use and the project name. The file contents look like:
+Next, we need to get the values for these arrays. Let's use a [JSON](https://www.json.org){:target='_blank'} file, called "project.json", to configure which repos to use and the project name. The file contents look like:
```json
{ "projectName": "Apache Royale",
"repos": [ "apache/royale-asjs", "apache/royale-typedefs", "apache/royale-compiler" ]
}
```
-You can download this file from [here.](https://github.com/apache/royale-asjs/blob/develop/examples/express/GitHubCommitLogViewer/src/main/resources/project.json)
+You can download this file from [here](https://github.com/apache/royale-asjs/blob/develop/examples/express/GitHubCommitLogViewer/src/main/resources/project.json){:target='_blank'}.
Now we need to add calls that fetch the .json file and then the information about the commits. We can use HTTPService to get the JSON file:
diff --git a/create-an-application/application-tutorial/main.md b/create-an-application/application-tutorial/main.md
index 435adb5..1bfe2ad 100644
--- a/create-an-application/application-tutorial/main.md
+++ b/create-an-application/application-tutorial/main.md
@@ -32,7 +32,8 @@ The file starts with:
```
The line:
-mxml
+
+```mxml
xmlns:js="library://ns.apache.org/royale/express"
```
diff --git a/create-an-application/migrate-an-existing-app/migrate-from-flex.md b/create-an-application/migrate-an-existing-app/migrate-from-flex.md
index 4d24fb4..8e1908d 100644
--- a/create-an-application/migrate-an-existing-app/migrate-from-flex.md
+++ b/create-an-application/migrate-an-existing-app/migrate-from-flex.md
@@ -67,8 +67,7 @@ The Royale compiler supports every options the Flex compiler supports. There are
Then, assuming you aren't using any third-party libraries, your application should compile.
-
-## Intepreting compiler errors and warnings
+## Interpreting compiler errors and warnings
To start migrating your Flex app to Royale, try to get your code to compile without any "import flash' directives and use the Royale emulation components. You will get a bunch of errors and have to rename Flash APIs, and possibly comment out parts of the code that are not essential to getting the core of your application up and running. If you do that, use a special comment format so that, later, you can find places that are temporarily commented out and work on making them Royale-happy.
diff --git a/create-an-application/security.md b/create-an-application/security.md
index 8b1c7e5..ebaf2c0 100644
--- a/create-an-application/security.md
+++ b/create-an-application/security.md
@@ -22,12 +22,14 @@ title: Security
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:
+Each runtime environment has its own security rules. Here are links to security documentation for these runtimes:
-Browsers: <a href="https://developer.mozilla.org/en-US/docs/Web/Security" target="_blank">Mozilla Web Security</a>
-<a href="https://developers.google.com/web/fundamentals/security/" target="_blank">Google Web Fundamentals</a>
+* Browsers:
+ * [Mozilla Web Security](https://developer.mozilla.org/en-US/docs/Web/Security){:target='_blank'}
+ * [Google Web Fundamentals](https://developers.google.com/web/fundamentals/security/){:target='_blank'}
-Flash: <a href="https://www.adobe.com/devnet/flashplayer/security.html" target="_blank">Adobe Flash Security Articles</a>
+* Flash:
+ * [Adobe Flash Security Articles](https://www.adobe.com/devnet/flashplayer/security.html){:target='_blank'}
diff --git a/frameworks/crux.md b/frameworks/crux.md
index b6c546a..4b549df 100644
--- a/frameworks/crux.md
+++ b/frameworks/crux.md
@@ -26,8 +26,8 @@ An Apache Royale framework based on Swiz
Apache Royale Crux provides:
- - <a href="https://www.codeproject.com/articles/592372/dependency-injection-di-vs-inversion-of-control-io" target="_blank">Inversion of Control (IoC) and Dependency Injection (DI)</a> with metadata
- - <a href="https://en.wikipedia.org/wiki/Event_(computing)" target="_blank">Event handling</a> with metadata
+ - [Inversion of Control (IoC) and Dependency Injection (DI)](https://www.codeproject.com/articles/592372/dependency-injection-di-vs-inversion-of-control-io){:target='_blank'} with metadata
+ - [Event handling](https://en.wikipedia.org/wiki/Event_(computing)){:target='_blank'} with metadata
- Simple life cycle for asynchronous remote method invocations
- Decoupling from application code
diff --git a/testing.md b/testing.md
index 15fa03f..c3cfefa 100644
--- a/testing.md
+++ b/testing.md
@@ -31,7 +31,7 @@ Every developer is building something from nothing, or adapting something that m
- Something that was working last week, or in the most recent build, is not working at all today.
- Users are doing things with the app that you didn't expect them to do, like putting lines of code in a text entry field, and things are blowing up everywhere.
-The main defense you have against buggy code and a failed development project is testing. Test early, test often...consider trying out <a href="https://en.wikipedia.org/wiki/Test-driven_development" target="_blank">Test Driven Development</a>.
+The main defense you have against buggy code and a failed development project is testing. Test early, test often...consider trying out [Test Driven Development](https://en.wikipedia.org/wiki/Test-driven_development){:target='_blank'}.
Over time we will add pointers to general testing guides, and tips and tricks more specific to Apache Royale. Keep checking back, or consider contributing your own insights.
diff --git a/testing/royaleunit.md b/testing/royaleunit.md
index 42589a5..0ac4d43 100644
--- a/testing/royaleunit.md
+++ b/testing/royaleunit.md
@@ -28,7 +28,7 @@ _Text coming soon_
## Requirements
-Apache RoyaleUnit is designed to work with <a href="https://ant.apache.org" target="_blank">Apache Ant</a>, a command-line tool which can drive processes described in build files as targets and extension points dependent upon each other. The Ant website provides an overview, documentation, and a free download of the Ant installer.
+Apache RoyaleUnit is designed to work with [Apache Ant](https://ant.apache.org){:target='_blank'}, a command-line tool which can drive processes described in build files as targets and extension points dependent upon each other. The Ant website provides an overview, documentation, and a free download of the Ant installer.
## Tutorials