Skip to content

Commit

Permalink
ZK Installation Guide -fix links, add missing images
Browse files Browse the repository at this point in the history
  • Loading branch information
hawkchen committed Sep 13, 2024
1 parent 5db7224 commit ea80673
Show file tree
Hide file tree
Showing 26 changed files with 162 additions and 321 deletions.
4 changes: 0 additions & 4 deletions _data/navigation.yml
Original file line number Diff line number Diff line change
Expand Up @@ -901,21 +901,17 @@ zk_installation_guide:
- title: "Resin"
url: "/zk_installation_guide/resin"
- title: "Setting up OS"
url: "/zk_installation_guide/setting_up_os"
children:
- title: "Linux"
url: "/zk_installation_guide/linux"
- title: "IOS"
url: "/zk_installation_guide/ios"
- title: "Setting up IDE"
url: "/zk_installation_guide/setting_up_ide"
children:
- title: "Eclipse with ZK Studio"
url: "/zk_installation_guide/eclipse_with_zk_studio"
- title: "Eclipse without ZK Studio"
url: "/zk_installation_guide/eclipse_without_zk_studio"
- title: "Eclipse with Maven"
url: "/zk_installation_guide/eclipse_with_maven"
- title: "XML Editor"
url: "/zk_installation_guide/xml_editor"
zk_style_customization_guide:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ First, you have to prepare a Web server. You can use any Web servers
that support Java Servlet (2.3 or later). Here we introduce the
installation of [Tomcat](http://tomcat.apache.org). For other servers
and more information, please refer to [Setting up
Servers](ZK_Installation_Guide/Setting_up_Servers).
Servers](Setting_up_Servers).

1. Visit [Tomcat Official Site](http://tomcat.apache.org/)
2. Select the correct binary distribution for your environment and
Expand Down Expand Up @@ -65,11 +65,11 @@ directly under <u>WEB-INF</u> folder*.

- For the content of <u>web.xml</u>, please refer to [Sample of web.xml
for Servlet
3.0](ZK_Installation_Guide/ZK_Background/Sample_of_web.xml_for_Servlet_3.0),
3.0](ZK_Background/Sample_of_web.xml_for_Servlet_3.0),
[Sample of web.xml for Servlet
2.4](ZK_Installation_Guide/ZK_Background/Sample_of_web.xml_for_Servlet_2.4)
2.4](ZK_Background/Sample_of_web.xml_for_Servlet_2.4)
or [Sample of web.xml for Servlet
2.3](ZK_Installation_Guide/ZK_Background/Sample_of_web.xml_for_Servlet_2.3),
2.3](ZK_Background/Sample_of_web.xml_for_Servlet_2.3),
depending on your Web server support.

### Create First ZUL file
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,15 +12,15 @@ Please follow the installation guide for your Eclipse:


[ Install
Eclipse](ZK_Installation_Guide/Quick_Start/Create_and_Run_Your_First_ZK_Application_with_Eclipse_and_ZK_Studio#Install_Eclipse)
Eclipse](Quick_Start/Create_and_Run_Your_First_ZK_Application_with_Eclipse_and_ZK_Studio#Install_Eclipse)

## Install M2eclipse

Please follow the installation guide for your M2eclipse:


[ Install
M2eclipse](ZK_Installation_Guide/Setting_up_IDE/Maven/Setting_up_Maven_on_Eclipse)
M2eclipse](Setting_up_IDE/Maven/Setting_up_Maven_on_Eclipse)

## Add ZK Maven Archetype

Expand All @@ -33,7 +33,7 @@ M2eclipse](ZK_Installation_Guide/Setting_up_IDE/Maven/Setting_up_Maven_on_Eclips
[`https://mavensync.zkoss.org/maven2/`](https://mavensync.zkoss.org/maven2/)

- Click **Verify** and then **OK** to add the catalog.
- If the Remote catalog is <font color="red">empty</font>.<ref>
- If the Remote catalog is **empty**.

If an error message appears stating that the Remote catalog is empty,
this is most likely due to a bug in the m2eclipse plugin in v0.12.x,
Expand All @@ -60,51 +60,32 @@ there are two possible workarounds:
Use the command line version of Maven to create a
project](#Use_the_command_line_version_of_Maven_to_create_a_project).

</ref>

------------------------------------------------------------------------

<references/>

# Create a "Hello World" application with ZK Maven Archetype

## Create a Maven Project

- **\[File\]** -\> **\[New\]** -\> **\[Other\]** --\> **\[Maven
Project\]**

<figure>
<img src="images/ZK_Installation_Guide_Quick_Start_Maven_New_project-01.png
title="ZK_Installation_Guide_Quick_Start_Maven_New_project-01.png" />
<figcaption>ZK_Installation_Guide_Quick_Start_Maven_New_project-01.png</figcaption>
</figure>

![](/zk_installation_guide/images/ZK_Installation_Guide_Quick_Start_Maven_New_project-01.png)
- Make sure *Create a simple project* is unticked in the first screen of
the New Maven Project wizard and click **Next \>**.

<figure>
<img src="images/ZK_Installation_Guide_Maven_Archetype_step1.png
title="ZK_Installation_Guide_Maven_Archetype_step1.png" />
<figcaption>ZK_Installation_Guide_Maven_Archetype_step1.png</figcaption>
</figure>

![](/zk_installation_guide/images/ZK_Installation_Guide_Maven_Archetype_step1.png)
- From the *Select an Archetype* screen, select **ZK Maven Archetype**
from the catalog dropdown list.

<figure>
<img src="images/ZK_Installation_Guide_Quick_Start_Maven_New_project-02.png
title="ZK_Installation_Guide_Quick_Start_Maven_New_project-02.png" />
<figcaption>ZK_Installation_Guide_Quick_Start_Maven_New_project-02.png</figcaption>
</figure>

![](/zk_installation_guide/images/ZK_Installation_Guide_Quick_Start_Maven_New_project-02.png)
-
- Select *zk-archetype-webapp* from the list. (At the time of writing
this article was at version *'6.0*. Please choose the latest release
available.').
- Next, fill in details for *group id, artifact id, version* number and
*package* name.

<figure>
<img src="images/ZK_Installation_Guide_Quick_Start_Maven_New_project-03.png
title="ZK_Installation_Guide_Quick_Start_Maven_New_project-03.png" />
<figcaption>ZK_Installation_Guide_Quick_Start_Maven_New_project-03.png</figcaption>
</figure>

![](/zk_installation_guide/images/ZK_Installation_Guide_Quick_Start_Maven_New_project-03.png)

- The property *zk-version-since* might be missing.


Expand Down Expand Up @@ -174,50 +155,47 @@ maven-archetype-plugin version 3.0.1 you'll have to use the following
command (using 2.4 as a fallback -
[ARCHETYPE-519](https://issues.apache.org/jira/browse/ARCHETYPE-519)):

` $ mvn org.apache.maven.plugins:maven-archetype-plugin:2.4:generate -DarchetypeCatalog=`[`https://mavensync.zkoss.org/maven2/`](https://mavensync.zkoss.org/maven2/)

` $ mvn archetype:generate -DarchetypeCatalog=`[`https://mavensync.zkoss.org/maven2/`](https://mavensync.zkoss.org/maven2/)
` [INFO] Scanning for projects...`
` [INFO] Searching repository for plugin with prefix: 'archetype'.`
` [INFO] ------------------------------------------------------------------------`
` [INFO] Building Maven Default Project`
` [INFO]    task-segment: [archetype:generate] (aggregator-style)`
` [INFO] ------------------------------------------------------------------------`
` [INFO] Preparing archetype:generate`
` [INFO] No goals needed for project - skipping`
` [INFO] [archetype:generate {execution: default-cli}]`
` [INFO] Generating project in Interactive mode`
` [INFO] No archetype defined. Using maven-archetype-quickstart (org.apache.maven.`
` archetypes:maven-archetype-quickstart:1.0)`
` Choose archetype:`
` 1: `[`https://mavensync.zkoss.org/maven2/`](https://mavensync.zkoss.org/maven2/)` -> zk-archetype-component (An archetype `
` that generates a starter ZK component project)`
` 2: `[`https://mavensync.zkoss.org/maven2/`](https://mavensync.zkoss.org/maven2/)` -> zk-archetype-extension (An archetype `
` that generates a starter ZK extension project)`
` 3: `[`https://mavensync.zkoss.org/maven2/`](https://mavensync.zkoss.org/maven2/)` -> zk-archetype-webapp (An archetype that`
` generates a starter ZK CE webapp project)`
` 4: `[`https://mavensync.zkoss.org/maven2/`](https://mavensync.zkoss.org/maven2/)` -> zk-ee-eval-archetype-webapp (An `
` archetype that generates a starter ZK EE-eval webapp project)`
` Choose a number: : 3`
` Define value for property 'groupId': : com.foo`
` Define value for property 'artifactId': : mywebapp`
` Define value for property 'version': 1.0-SNAPSHOT: 0.8.0`
` Define value for property 'package': com.foo:`
` [INFO] Using property: zk-version-since = 6.0.1`
` Confirm properties configuration:`
` groupId: com.foo`
` artifactId: mywebapp`
` version: 0.8.0`
` package: com.foo`
` zk-version-since: 6.0.1`
` Y:`
` [INFO] ------------------------------------------------------------------------`
` [INFO] BUILD SUCCESSFUL`
` [INFO] ------------------------------------------------------------------------`
` [INFO] Total time: 29 seconds`
` [INFO] Finished at: Fri Jun 22 16:55:27 CST 2012`
` [INFO] Final Memory: 13M/150M`
` [INFO] ------------------------------------------------------------------------`
```text
$ mvn org.apache.maven.plugins:maven-archetype-plugin:2.4:generate -DarchetypeCatalog=https://mavensync.zkoss.org/maven2/
$ mvn archetype:generate -DarchetypeCatalog=https://mavensync.zkoss.org/maven2/
[INFO] Scanning for projects...
[INFO] Searching repository for plugin with prefix: 'archetype'.
[INFO] ------------------------------------------------------------------------
[INFO] Building Maven Default Project
[INFO] task-segment: [archetype:generate] (aggregator-style)
[INFO] ------------------------------------------------------------------------
[INFO] Preparing archetype:generate
[INFO] No goals needed for project - skipping
[INFO] [archetype:generate {execution: default-cli}]
[INFO] Generating project in Interactive mode
[INFO] No archetype defined. Using maven-archetype-quickstart (org.apache.maven.archetypes:maven-archetype-quickstart:1.0)
Choose archetype:
1: https://mavensync.zkoss.org/maven2/ -> zk-archetype-component (An archetype that generates a starter ZK component project)
2: https://mavensync.zkoss.org/maven2/ -> zk-archetype-extension (An archetype that generates a starter ZK extension project)
3: https://mavensync.zkoss.org/maven2/ -> zk-archetype-webapp (An archetype that generates a starter ZK CE webapp project)
4: https://mavensync.zkoss.org/maven2/ -> zk-ee-eval-archetype-webapp (An archetype that generates a starter ZK EE-eval webapp project)
Choose a number: : 3
Define value for property 'groupId': : com.foo
Define value for property 'artifactId': : mywebapp
Define value for property 'version': 1.0-SNAPSHOT: 0.8.0
Define value for property 'package': com.foo:
[INFO] Using property: zk-version-since = 6.0.1
Confirm properties configuration:
groupId: com.foo
artifactId: mywebapp
version: 0.8.0
package: com.foo
zk-version-since: 6.0.1
Y:
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESSFUL
[INFO] ------------------------------------------------------------------------
[INFO] Total time: 29 seconds
[INFO] Finished at: Fri Jun 22 16:55:27 CST 2012
[INFO] Final Memory: 13M/150M
[INFO] ------------------------------------------------------------------------
```

## Run the Project

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ to simplify the development of ZK applications with Eclipse.

If you prefer to install it manually or use with other IDE, please refer
to [Create and Run Your First ZK Application
Manually](ZK_Installation_Guide/Quick_Start/Create_and_Run_Your_First_ZK_Application_Manually).
Manually](Quick_Start/Create_and_Run_Your_First_ZK_Application_Manually).

# Prepare Eclipse

Expand Down Expand Up @@ -61,7 +61,7 @@ Before deploying and testing your application, you have to install an
application server (such as Tomcat) and specify the server in Eclipse.
For more information on how to install an application server, please see
[ZK Installation Guide/Setting up
Servers/Tomcat](ZK_Installation_Guide/Setting_up_Servers/Tomcat).
Servers/Tomcat](Setting_up_Servers/Tomcat).

To specify the server in Eclipse, please follow the instructions below:

Expand All @@ -73,7 +73,7 @@ To specify the server in Eclipse, please follow the instructions below:
- For example, the root directory of **Apache Tomcat** might be
`C:\Program Files\Apache Software Foundation\Tomcat 6.0`
- For how to install Tomcat, please refer to [this
section](ZK_Installation_Guide/Setting_up_Servers/Tomcat)
section](Setting_up_Servers/Tomcat)
5. Click **Finish**

# Create a "Hello World" application from scratch with ZK Sutdio
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -167,12 +167,11 @@ The server will stop at breakpoints.

## Import a Gradle project into your IDE

<figure>
<img src="images/zk-gradle-idea-run-config.png
title="An exemplary development run config for IntelliJ IDEA" />

![](images/zk-gradle-idea-run-config.png)
<figcaption>An exemplary development run config for IntelliJ
IDEA</figcaption>
</figure>


The [example project](https://github.com/zkoss-demo/zk-gradle) doesn't
include or require any IDE specific settings and can be imported into
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

The recommended way to use ZK in NetBeans is to import a maven project.
Reference [ this
document](ZK_Installation_Guide/Setting_up_IDE/Maven/Resolving_ZK_Framework_Artifacts_via_Maven)
document](Setting_up_IDE/Maven/Resolving_ZK_Framework_Artifacts_via_Maven)
for sample pom file.

# Install NetBeans REM
Expand Down Expand Up @@ -44,7 +44,7 @@ IDE](https://netbeans.apache.org/download/index.html) and install
![](images/ZKInstallationGuide_NetBeans_SelectNewZKProject.png "ZKInstallationGuide_NetBeans_SelectNewZKProject.png")

3. Confirm and create a new ZK project.
![](images/_ZKInstallationGuide_NetBeans_CreateNewZKProject.png "_ZKInstallationGuide_NetBeans_CreateNewZKProject.png")
![](images/ZKInstallationGuide_NetBeans_CreateNewZKProject.png "_ZKInstallationGuide_NetBeans_CreateNewZKProject.png")

4. Select the ZK project folder, and right click "Run" to deploy the
project on Glassfish
Expand Down
105 changes: 0 additions & 105 deletions zk_installation_guide/eclipse_with_maven.md

This file was deleted.

Loading

0 comments on commit ea80673

Please sign in to comment.