CJ2 docs rearranging (#16)

Co-authored-by: Alex Bates <[email protected]>
leaningtech · Sep 28, 2023 · 47ea3eb · 47ea3eb
1 parent 789dbba
commit 47ea3eb
Show file tree

Hide file tree

Showing 24 changed files with 772 additions and 501 deletions.
diff --git a/.github/styles/Vocab/LeaningTechnologies/accept.txt b/.github/styles/Vocab/LeaningTechnologies/accept.txt
@@ -41,6 +41,17 @@ virtualized
 methodName
 resolvedMethod
 preloadResources
+arg 
+className
+resolvedFunc
+funcName
+JSString
+jsCall
+runMain
+classPath
+resolveCall
+nops
+
 
 
 
diff --git a/src/components/TableOfContents.astro b/src/components/TableOfContents.astro
@@ -29,7 +29,7 @@ function buildToc(headings: BasicHeading[]) {
 			toc.push(heading);
 		} else if (
 			parentHeadings.get(heading.depth - 1) != undefined &&
-			heading.depth < 4
+			heading.depth < 5
 		) {
 			parentHeadings.get(heading.depth - 1).subheadings.push(heading);
 		}

diff --git a/src/content/docs/cheerp/00-installation/01-ppa.md b/src/content/docs/cheerp/00-installation/01-ppa.md
@@ -36,7 +36,7 @@ sudo apt-get update
 
 ## Install packages
 
-To install all cheerp components, run
+To install all Cheerp components, run
 
 ```sh
 apt-get install cheerp-core

diff --git a/src/content/docs/cheerpj2/01-demos.md b/src/content/docs/cheerpj2/01-demos.md
@@ -30,7 +30,7 @@ A few selected Java Swing examples to demonstrate how complex Swing GUI apps can
 
 A playground to compile and run Java programs directly in the browser. Both console and GUI applications are supported. The standard `javac` compiler is used, since `javac` is also written in Java the whole compiler runs in the browser, together with the compiled application.
 
-- Go to the [demo](ttps://javafiddle.leaningtech.com/) (please inspect the page using the devtools).
+- Go to the [demo](https://javafiddle.leaningtech.com/) (please inspect the page using the devtools).
 
 ## iText Demo
 

diff --git a/src/content/docs/cheerpj2/03-getting-started/00-Java-app.md b/src/content/docs/cheerpj2/03-getting-started/00-Java-app.md
@@ -0,0 +1,83 @@
+---
+title: Run a Java application
+---
+
+CheerpJ can run a Java application in the browser with little to no modifications. This page will help you getting started with CheerpJ and running your first Java application in the browser.
+
+Java source code is not needed to use CheerpJ. If you are building your own application you should already have its `.jar` file(s).
+
+**To get started you will need:**
+
+- Your Java application file(s). You can also use this [TextDemo.jar](https://docs.oracle.com/javase/tutorialJWS/samples/uiswing/TextDemoProject/TextDemo.jar) sample.
+- An HTML file where your Java app will be wrapped
+- A simple HTTP server to test your webpage locally
+
+## 1. Create a project directory
+
+Let's start by creating a project folder where all your files will be. Please copy your java and future HTML files here.
+
+```shell
+
+mkdir directory_name
+
+```
+
+## 2. Create a basic HTML file
+
+Let's create a basic HTML file like the following example. Please notice the CheerpJ runtime environment has been integrated and initialized. In this example we are assuming your HTML file and your `.jar` files are under the project directory you just created.
+
+```html title="index.html" {6, 10-12}
+<!doctype html>
+<html lang="en">
+	<head>
+		<meta charset="utf-8" />
+		<title>CheerpJ test</title>
+		<script src="https://cjrtnc.leaningtech.com/2.3/loader.js"></script>
+	</head>
+	<body>
+		<script>
+			cheerpjInit();
+			cheerpjCreateDisplay(800, 600);
+			cheerpjRunJar("/app/my_application_archive.jar");
+		</script>
+	</body>
+</html>
+```
+
+Alternatively, if your application is not designed to be executed with the command `java -jar` you can replace `cheerpjRunJar()` for `cheerpjRunMain()` and pass your qualified class name as an argument. For example:
+
+```js
+cheerpjRunMain(
+	"com.application.MyClassName",
+	"/app/my_application_archive.jar:/app/my_dependency_archive.jar",
+);
+```
+
+## 3. Host your page
+
+You can now serve this web page on a simple HTTP server, such as the http-server utility.
+
+```shell
+npm install http-server
+http-server -p 8080
+```
+
+> To test CheerpJ you must use a web server. Opening the `.html` page directly from the disk (for example, by double-clicking on it) is not supported.
+
+## What's going on?
+
+- CheerpJ loader is included from our cloud runtime as
+  `<script src="https://cjrtnc.leaningtech.com/2.3/loader.js"></script>`.
+- CheerpJ runtime environment is initialized by `cheerpjInit()`.
+- `cheerpjCreateDisplay()` creates a graphical environment to contain all Java windows
+- `cheerpjRunMain()` executes the `main` method of `ChangeThisToYourClassName`. The second parameter is a `:` separated list of `.jar` files where application classes can be found (the classpath).
+- The `/app/` is a virtual file system mount point that reference the root of the web server this page is loaded from.
+
+## The result
+
+You will see the CheerpJ display on your browser with some loading messages before showing your application running. Depending on your application and the optimizations applied, this could take just a few seconds.
+
+## Further reading
+
+- [AOT optimization](/cheerpj2/guides/AOT-optimization)
+- [Runtime API](/cheerpj2/reference/Runtime-API)
diff --git a/src/content/docs/cheerpj2/03-getting-started/00-Tutorial.md b/src/content/docs/cheerpj2/03-getting-started/00-Tutorial.md
diff --git a/src/content/docs/cheerpj2/03-getting-started/01-Getting-Started.md b/src/content/docs/cheerpj2/03-getting-started/01-Getting-Started.md