Skip to content

Commit d9483cb

Browse files
committed
Merge branch 'website-v2' into adopt-tutor-docs
2 parents 3ab6ce3 + f103d08 commit d9483cb

62 files changed

Lines changed: 3527 additions & 272 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.github/workflows/base-jobs.yml

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,9 @@ name: Base Website builder
33
on:
44
workflow_call:
55

6+
env:
7+
MAVEN_OPTS: "-Xmx4G -Dorg.slf4j.simpleLogger.log.org.apache.maven.cli.transfer.Slf4jMavenTransferListener=warn -Dorg.slf4j.simpleLogger.showDateTime=true -Djava.awt.headless=true"
8+
69
jobs:
710
prepare-sources:
811
name: Prepare the website sources
@@ -37,7 +40,7 @@ jobs:
3740

3841
# Copy docs from dependent projects, run tutor on local courses folder and copy results into docs and static/assets
3942
- name: Run rascal-tutor and reuse libraries
40-
run: MAVEN_OPTIONS="-Xss256m -Xmx3G" mvn -B clean package -Dwebdriver.chrome.driver=/usr/local/bin/chromedriver -Dwebdriver.chrome.browser=`which chrome`
43+
run: MAVEN_OPTIONS="-Xss256m -Xmx3G" mvn -B clean package -Dwebdriver.chrome.driver=/usr/local/bin/chromedriver -Dwebdriver.chrome.browser=`which chrome` | grep -v "\[INFO\] Downloading"
4144

4245
- uses: actions/upload-artifact@v4
4346
with:
@@ -48,4 +51,4 @@ jobs:
4851
!.git
4952
!.github
5053
!.vscode
51-
!META-INF
54+
!META-INF

.github/workflows/pr-builder.yml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,11 @@ jobs:
2020
with:
2121
name: sources
2222

23+
- uses: actions/setup-node@v4
24+
with:
25+
node-version: 20
26+
cache: yarn
27+
2328
# Do a dummy build to see if there are errors
2429
- name: Install dependencies
2530
run: yarn install --frozen-lockfile

courses/Bibliography/Bibliography.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@ This literature is about the meta systems themselves, their design and their eva
7878
* Mauricio Verano Merino, Tom Beckmann, Tijs van der Storm, Robert Hirschfeld, and Jurgen J. Vinju. Getting Grammars into Shape for Block-based. (2021) International Conference on Software Language Engineering.
7979
> We can generate block-based syntax editors from context-free grammars. The paper bridges between the grammarware and blockware technological spaces. A collaboration with TU Eindhoven en Canon Production Printing.
8080
* Jurgen J. Vinju and Tijs van der Storm. Bacatá: Notebooks for DSLs, Almost for Free. (2020) <Programming> Journal and DSLDI 2020
81-
> We can generate Jupyter Notebook interfaces for language descriptions in Rascal, similar to the way we can generate Eclipse plugins and VScode extensions,
81+
> We can generate Jupyter Notebook interfaces for language descriptions in Rascal, similar to the way we can generate Eclipse plugins and VS Code extensions,
8282
> but with a very different user experience.
8383
8484
### 2010's

courses/GettingHelp/Browsing/Browsing.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ been checked before publication.
3030

3131
Every Rascal library project also represents one _course_. Each module produces
3232
one _concept_ and encapsulates what is defined and documented within. In particular
33-
the [standard library]((Library)) is interesting to browse. The package hierarchy
33+
the [standard library]((Library:Index)) is interesting to browse. The package hierarchy
3434
of the library is mapped one-to-one to the concept hierarchy of the corresponding course.
3535

3636
#### Code examples
@@ -44,5 +44,5 @@ Most pages are indexed carefully, for example using the appropriate keywords and
4444

4545
Nevertheless the search box on the website will produce
4646
results in all courses, like [Help]((GettingHelp)) (this course)
47-
and [Recipes]((Recipes)) or ((Library)).
47+
and [Recipes]((Recipes)) or ((Library:Index)).
4848

courses/GettingHelp/FurtherReading/FurtherReading.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,12 +14,12 @@ keywords:
1414
1. To understand the terminology used in Rascal and by Rascal programmers ((Rascalopedia)) is a focused encyclopedia of meta programming.
1515
1. To understand error messages produced by Rascal, there is information on all ((RunTimeErrors)) and ((CompileTimeErrors)).
1616
1. To know everything about every detail of Rascal syntax and semantics, the [Rascal reference manual]((course:Rascal)) applies.
17-
1. The full standard ((Library)) is documented [here]((Library)).
17+
1. The full standard ((Library:Index)) is documented [here]((Library:Index)).
1818

1919
#### Packages
2020

21-
Rascal can be extended by loading different (third-party) packages. For example:
21+
Rascal can be extended by loading different (third-party) [packages](/docs/Packages). For example:
2222

23-
* ((flybytes)) enables JVM bytecode analysis, transformation and generation in Rascal.
24-
* ((typepal)) is a generic name and type analysis framework for programming languages and textual DSLs.
23+
* [flybytes](/docs/Packages/org.rascalmpl.flybytes) enables JVM bytecode analysis, transformation and generation in Rascal.
24+
* [typepal](/docs/Packages/org.rascalmpl.typepal) is a generic name and type analysis framework for programming languages and textual DSLs.
2525

courses/GettingHelp/GettingHelp.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ details:
3131
* Directly in the Rascal IDE there is help available:
3232
1. On the commandline, type `:help`
3333
2. In Eclipse there is the `Tutor View` which opens all the documentation pages inside Eclipse.
34-
3. In VScode use the command palette and search for `Rascal` for more commands.
34+
3. In VS Code use the command palette and search for `Rascal` for more commands.
3535
* For specific application topics, "Howto" kind of information, etc. please go to ((FurtherReading)).
3636
* There is a lot of documentation on Rascal and its libraries. Read the ((Browsing)) page on how to navigate it.
3737

courses/GettingStarted/CreateNewProject/CreateNewProject.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,8 @@ import IO;
88
remove(|home:///my-project-name|, recursive=true);
99
```
1010

11-
Rascal projects, generally, work the same in all three IDE contexts:
12-
* Eclipse
13-
* VScode
11+
Rascal projects, generally, work the same in all contexts:
12+
* VS Code
1413
* Commandline
1514

1615
To create an empty project to get started, follow these instructions:
@@ -24,7 +23,7 @@ newRascalProject(|home:///my-project-name|)
2423

2524
The Eclipse plugin has a "New Project Wizard" you can use as well.
2625

27-
The next step is to import the new project into VScode or Eclipse, or
26+
The next step is to import the new project into VS Code or Eclipse, or
2827
to `cd` to the project's root directory. From there on ((RunningRascal))
2928
with the new project's source and library settings is trivial.
3029

@@ -52,7 +51,7 @@ The `pom.xml` file is the basic setup that names the project and defines its dep
5251
```
5352

5453
Next to that `RASCAL.MF` is required to configure the development environment for the project. Some
55-
information from the `pom.xml` is repeated here, because this file is common between Eclipse, VScode and empty commandline projects,
54+
information from the `pom.xml` is repeated here, because this file is common between Eclipse, VS Code and empty commandline projects,
5655
and such projects could work with a `pom.xml`:
5756

5857
```MF

courses/GettingStarted/DownloadAndInstallation/DownloadAndInstallation.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ sidebar_position: 1
66
Rascal is deployed as one of four easy-to-use packages:
77

88
1. **A standalone "jar" file**, which can be downloaded [here](https://update.rascal-mpl.org/console/rascal-shell-stable.jar)
9-
2. A **Visual Studio Code extension**, which can be found [here](https://marketplace.visualstudio.com/items?itemName=usethesource.rascalmpl) or search for "Rascal" in the "Extension" view in VScode itself.
9+
2. A **Visual Studio Code extension**, which can be found [here](https://marketplace.visualstudio.com/items?itemName=usethesource.rascalmpl) or search for "Rascal" in the "Extension" view in VS Code itself.
1010
3. An **Eclipse plugin**, for which the update site is <https://update.rascal-mpl.org/stable/>.
1111
4. A set of **Maven MOJOs**, for which the plugin repository is <https://releases.usethesource.io/maven/>
1212

courses/GettingStarted/RascalShell/Commands/Edit/Edit.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,4 +17,4 @@ mean different things:
1717

1818
* On the Unix commandline the `${EDITOR}` environment variable will be used to open a file. If that file is present in the local file system, it is opened by running `${EDITOR} /absolute/path/to/module.rsc`, but if the file is hidden behind an opaque ((Values-Location)) scheme, then it is first copied to a temporary file on the local file system, and then opened.
1919
* In Eclipse, the eclipse editor framework is used to open an editor for the file. If it is a so called "resource" in the eclipse file system, and editable file is opened with all the Rascal language support. If the file is from an embedded library (inside a jar) then the contents of the file are shown in a similar editor, but read-only.
20-
* In VScode a similar experience is provided as in Eclipse, but the editor for library files does not know it is read-only.
20+
* In VS Code a similar experience is provided as in Eclipse, but the editor for library files does not know it is read-only.

courses/GettingStarted/RunningRascal/Eclipse/Eclipse.md

Lines changed: 0 additions & 40 deletions
This file was deleted.

0 commit comments

Comments
 (0)