Skip to content

Commit

Permalink
#85: Update (prepared) download section of N4JS webpage (#86)
Browse files Browse the repository at this point in the history
* #85: Modify styles, update documentation, regenerate Eclipse Help
* #85 remove custom HTML from src repo
* #85 remove eclipse resources, modify build scripts, unset web fonts in generated content
* #85 add search function to specification
* #85 update Releases information, organize documentation index
* #85 update IDE setup guide to link to project downloads page
* #85 fix footer information on generated pages
* #85 remove unwanted javascript
* #85 remove github and jira images, fix numbered list items
* #85 remove pdf cover
* GH-85 reduce cover image size
* GH-85 remove references to versions
* #85 modify page resize width to display TOC on smaller screens
* #85 update README
* #85 clean Eclipse dist folder and regenerate Eclipse Help
* #85 minor URL fix to point to Language Spec

Signed-off-by: <brian.smith@numberfour.eu>
  • Loading branch information
bsmith-n4 authored and jpilgrim committed Jul 21, 2017
1 parent e6c20e6 commit a801ef4
Show file tree
Hide file tree
Showing 92 changed files with 67,905 additions and 2,573 deletions.
36 changes: 21 additions & 15 deletions README.adoc
Expand Up @@ -11,20 +11,22 @@ Contributors:

= N4JS

The https://numberfour.github.io/n4js[N4JS language and its IDE] enables high-quality JavaScript development for large Node.js projects.
The https://www.eclipse.org/n4js[Eclipse N4JS language and IDE] enable high-quality JavaScript development for large Node.js projects.
N4JS enriches ECMAScript with a static type system and provides extensive support for static validation hosted within a feature-rich IDE.

N4JS is based on ECMAScript Version 5 and ECMAScript 2015 is supported to a great extent. It adds a sound static type system inspired by Java 8, extended by concepts such as structural typing or union types. The language provides built-in support for state-of-the-art programming paradigms such as dependency injection and robust test support. The Eclipse based IDE for typed JavaScript is custom-built for exactly these concepts. Code is validated as you type in addition to tools such as content-assist and quick-fixes to ensure your code is written safely and intuitively.

== Releases

- N4JS IDE Snapshot Releases: http://goo.gl/qGKcm9[Linux64] http://goo.gl/2QDLfc[Win64] http://goo.gl/DszAu3[MacOS]
- Eclipse Update Site N4JS IDE: http://updates.n4js.org/updatesite/
- N4JS command line compiler (jar): http://goo.gl/09dfYB[n4jsc.jar]
The Eclipse N4JS project is in the link:https://wiki.eclipse.org/Development_Resources/HOWTO/Incubation_Phase[Incubation Phase] and there is no official release available yet (for unofficial releases see the link:https://www.eclipse.org/n4js/download.html[download page].
This doesn't mean that N4JS is unstable; we have an extensive test suite (>90.000 tests including the https://github.com/tc39/test262[ECMAScript test suites]) to ensure a stable nightly build.
N4JS has been in use in several large non-public projects for years.
There still may be bugs (as there are always bugs) and features which are currently under development.
We encourage feedback from all users! For questions about getting started with the N4JS Language and IDE for developing your own projects, see the link:https://www.eclipse.org/forums/index.php/f/365/[the Eclipse N4JS forum].

== Contribute

Eclipse developers who want to develop N4JS itself should use the https://www.eclipse.org/downloads/[Oomph Eclipse installer]. The N4JS project is listed under "Advanced/Github Projects/N4JS"
Eclipse developers who want to develop N4JS itself should use the https://www.eclipse.org/downloads/[Oomph Eclipse installer]. The N4JS project is listed under "Eclipse Projects/N4JS"
This setup installs the correct Eclipse version, creates a new workspace and clones all projects into it (for details see below).

=== Eclipse Installer
Expand All @@ -36,7 +38,7 @@ Run the installer and apply the following steps:

1. change to "Advance Mode" via the menu (upper-right corner) (no need to move the installer)
2. select a product, e.g. "Eclipse IDE for Eclipse Committers" with product version "Latest(Neon)"
3. double-click the entry Github/N4JS so that it is shown in the catalog view below
3. double-click the entry **Eclipse Projects/N4JS** so that it is shown in the catalog view below
4. on the next page, configure paths accordingly. You only have to configure the installation and workspace folder.
5. start installation

Expand All @@ -55,20 +57,24 @@ It is almost impossible to use another IDE to develop Eclipse plugins. The list
- Xpect 0.1

It is important to use the latest version of Xtext and the corresponding service release of Xcore. You will find the latest version numbers and plugins used in the target platform definition at
https://github.com/NumberFour/n4js/blob/master/releng/org.eclipse.n4js.targetplatform/org.eclipse.n4js.targetplatform.target
https://github.com/eclipse/n4js/blob/master/releng/org.eclipse.n4js.targetplatform/org.eclipse.n4js.targetplatform.target

== Documentation

- http://numberfour.github.io/n4js/userguides[User Guides and Tutorials]: IDE Setup, writing Node.js modules and exporting as npm with the N4JS IDE
- http://numberfour.github.io/n4js/spec/N4JSSpec.html[N4JS Language Specification]
- https://numberfour.github.io/n4js/features/[Complete Feature Table]
- https://numberfour.github.io/n4js/releases/[Release Notes]
- https://www.eclipse.org/n4js/userguides[User Guides and Tutorials]: IDE Setup, writing Node.js modules and exporting as npm with the N4JS IDE
- https://www.eclipse.org/n4js/spec/N4JSSpec.html[N4JS Language Specification]
- https://www.eclipse.org/n4js/features/[Complete Feature Table]
- https://www.eclipse.org/n4js/releases/[Release Notes]

== Participate

- https://numberfour.github.io/n4js/faq/[FAQ]
- http://groups.google.com/group/n4js[mailing list / web forum]
- https://github.com/numberfour/n4js/issues/[issues]
- https://www.eclipse.org/n4js/faq/[FAQ]
- https://www.eclipse.org/forums/index.php/f/365/[Eclipse Forum]
- https://dev.eclipse.org/mailman/listinfo/n4js-dev[Developer Mailing List]
- https://github.com/eclipse/n4js/issues/[Issues]
- http://n4js.blogspot.de/[Eclipse N4JS Blog]
- https://projects.eclipse.org/projects/technology.n4js[Eclipse Project Pages]
- https://projects.eclipse.org/projects/technology.n4js/who[Who's Involved]

== Build the N4JS IDE from command line

Expand All @@ -83,7 +89,7 @@ installed on your system.
Clone the repository

----
git clone https://github.com/NumberFour/n4js.git
git clone https://github.com/Eclipse/n4js.git
----

Change to the n4js folder:
Expand Down
15 changes: 3 additions & 12 deletions docs/org.eclipse.n4js.doc/build.sh
Expand Up @@ -36,7 +36,6 @@ echo copying resources to ./$GEN_FOLDER/

rm -rf ./$GEN_FOLDER/; mkdir ./$GEN_FOLDER/
cp -r ./res/scripts ./res/styles ./src/articles ./src/faq ./src/features ./src/images ./src/releases ./src/userguides ./$GEN_FOLDER/
cp ./src/index.html ./$GEN_FOLDER/index.html

pushd src
FILES=`find . -name "*.adoc" ! -name 'config.adoc' -print`
Expand All @@ -45,23 +44,15 @@ popd
# Rundoc function to convert source files to HTML. Attributes are passed with the '-a' flag.
for f in $FILES;
do
# If Jenkins is building, then use AsciiSpec
# otherwise, use AsciiDoctor
if [ "${1}" == "--jenkins" ]; then
echo "Terminate running but possibly outdated asciispec server..."
asciispec term
ASPEC=asciispec
else
ASPEC=asciidoctor
fi

ASPEC=asciidoctor
ADOC_FILE=src/$f
REL_PATH="${f//\.\//}"
REL_PATH="${REL_PATH//[^\/]/}"
REL_PATH="${REL_PATH//[\/]/../}"
HEADER_DIR=$(basename $(dirname $f))
OUT_FOLDER=./$GEN_FOLDER/$(dirname $f)
ATTRS="-a doctype=book -a experimental=true -a stylesheet=n4js-adoc.css -a sectlinks -a docinfo1=true -a linkcss=true -a !source-highlighter -a reproducible -a icons=font"
ATTRS="-a doctype=book -a experimental=true -a sectlinks -a docinfo1=true -a linkcss=true -a !source-highlighter -a reproducible -a icons=font -a !webfonts"

echo running $ASPEC on $ADOC_FILE to $OUT_FOLDER

Expand All @@ -82,6 +73,6 @@ if [ "${1}" == "--jenkins" ]; then
exit 0
# Add -p flag to launch pages after build
elif [ "${1}" == "--preview" ] || [ "${1}" == "-p" ]; then
open ./$GEN_FOLDER/index.html
open ./$GEN_FOLDER/userguides/index.html
exit 0
fi

0 comments on commit a801ef4

Please sign in to comment.