Enterprise Pharo

https://github.com/squarebracketassociates/enterprisepharo
Admin
Enterprise Pharo is a book written in Pillar markup that guides users on how to write a book and...
Tokens:6,864
Snippets:40
Trust Score:9.9
License:MIT
Update:1 year ago
Show doc for...
Tokens:
Raw
### Basic HTML Setup for Highlight.js

Source: https://github.com/squarebracketassociates/enterprisepharo/blob/master/support/html/highlightjs/README.md

Demonstrates how to include Highlight.js and its stylesheet in an HTML page for automatic syntax highlighting of code blocks marked with `<pre><code>`. This is the simplest way to get started.

```html
<link rel="stylesheet" href="styles/default.css">
<script src="highlight.pack.js"></script>
<script>hljs.initHighlightingOnLoad();</script>
```

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

### Download Pillar Executable and Pharo Environment

Source: https://github.com/squarebracketassociates/enterprisepharo/blob/master/README.md

This command executes a shell script to download the required Pillar executable, Pharo image, and Virtual Machine (VM). These components are installed locally within the book's directory, setting up the necessary environment for book generation.

```shell
./download.sh
```

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

### jQuery-based Custom Initialization

Source: https://github.com/squarebracketassociates/enterprisepharo/blob/master/support/html/highlightjs/README.md

Provides an example of manually initializing Highlight.js on code blocks using jQuery, which is useful when the default markup is not used or for dynamically added content.

```javascript
$(document).ready(function() {
  $('pre code').each(function(i, e) {hljs.highlightBlock(e)});
});
```

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

### Node.js Integration with Highlight.js

Source: https://github.com/squarebracketassociates/enterprisepharo/blob/master/support/html/highlightjs/README.md

Shows how to install and use Highlight.js within a Node.js environment. It covers highlighting code with a known language or using automatic language detection.

```bash
npm install highlight.js
```

```javascript
var hljs = require('highlight.js');

// If you know the language
hls.highlight(lang, code).value;

// Automatic language detection
hls.highlightAuto(code).value;
```

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

### AMD Build and Usage for Highlight.js

Source: https://github.com/squarebracketassociates/enterprisepharo/blob/master/support/html/highlightjs/README.md

Explains how to build Highlight.js for AMD module loaders and how to use it within an AMD environment. This allows for modular loading of the library.

```bash
python3 tools/build.py -tamd lang1 lang2 ..
```

```javascript
require(["highlight.js/build/highlight.pack"], function(hljs){

  // If you know the language
  hljs.highlight(lang, code).value;

  // Automatic language detection
  hljs.highlightAuto(code).value;
});
```

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

### Generate Individual Book Chapters

Source: https://github.com/squarebracketassociates/enterprisepharo/blob/master/README.md

This command initiates the process of rendering individual book chapters from their Pillar markup source files. The output, consisting of the processed chapters, is placed in the 'book-result/' directory.

```shell
./compile.sh
```

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

### Compose Chapters into Full Book

Source: https://github.com/squarebracketassociates/enterprisepharo/blob/master/README.md

After generating individual chapters, this command is used to compose them into the complete book. It should be executed after './compile.sh' has successfully processed all chapters.

```shell
./compileBook.sh
```

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

### Dynamic Block Highlighting with Custom Markup

Source: https://github.com/squarebracketassociates/enterprisepharo/blob/master/support/html/highlightjs/README.md

Shows how to use `highlightBlock` for dynamically inserted code blocks or blocks not using the standard `<pre><code>` markup. It also demonstrates enabling `<br>` tag support for non-`<pre>` containers.

```javascript
$('div.code').each(function(i, e) {hljs.highlightBlock(e, null, true)});
```

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

### Add TeX Binaries to Mac OS X Path

Source: https://github.com/squarebracketassociates/enterprisepharo/blob/master/README.md

This shell snippet demonstrates how to add the TeX distribution binaries to the system's PATH on macOS. It involves creating a file containing the path and moving it to the system's path configuration directory for persistent access.

```shell
echo /usr/texbin > TeX
sudo mv TeX /etc/paths.d
```

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

### Pillar Markup Chapter Reference

Source: https://github.com/squarebracketassociates/enterprisepharo/blob/master/README.md

This entry references the Pillar markup language used for writing the book. It provides a link to a chapter explaining Pillar, which is essential for understanding the book's content creation process.

```pillar
See [Pillar chapter](https://ci.inria.fr/pharo-contribution/job/EnterprisePharoBook/lastSuccessfulBuild/artifact/book-result/PillarChap/Pillar.html)
```

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

### Export and Post-Process a Single Chapter

Source: https://github.com/squarebracketassociates/enterprisepharo/blob/master/README.md

This sequence of commands exports a specific chapter (e.g., 'Teapot') from its Pillar source file and then runs a post-export script. This is useful for generating or previewing individual chapters.

```shell
./pillar export Teapot/Teapot.pillar
bash pillarPostExport.sh
```

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

### Mizar Syntax Tokens

Source: https://github.com/squarebracketassociates/enterprisepharo/blob/master/support/html/highlightjs/classref.txt

Details syntax highlighting token types for Mizar, covering keywords and comments.

```APIDOC
Mizar Syntax Tokens:
  keyword: keyword
  comment: comment
```

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

### OpenGL Shading Language (GLSL) Syntax Tokens

Source: https://github.com/squarebracketassociates/enterprisepharo/blob/master/support/html/highlightjs/classref.txt

Details syntax highlighting token types for GLSL, including comments, numbers, preprocessor directives, keywords, built-in functions/variables, and literals (true, false).

```APIDOC
OpenGL Shading Language (GLSL) Syntax Tokens:
  comment: comment
  number: number
  preprocessor: preprocessor directive
  keyword: keyword
  built_in: GLSL built-in functions and variables
  literal: true false
```

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

### Brainfuck Syntax Tokens

Source: https://github.com/squarebracketassociates/enterprisepharo/blob/master/support/html/highlightjs/classref.txt

Specifies syntax highlighting token types for Brainfuck, including commands for loops (while), memory manipulation (inc/dec), input/output, and comments.

```APIDOC
Brainfuck Syntax Tokens:
  title: Brainfuck while loop command
  literal: Brainfuck inc and dec commands
  comment: comment
  string: Brainfuck input and output commands
```

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

### JavaScript Tab Replacement Configuration

Source: https://github.com/squarebracketassociates/enterprisepharo/blob/master/support/html/highlightjs/README.md

Illustrates how to configure Highlight.js to replace tab characters in code with a specified number of spaces or a styled span element for consistent indentation.

```javascript
hljs.tabReplace = '    '; // 4 spaces
// ... or
hls.tabReplace = '<span class="indent">\t</span>';

hls.initHighlightingOnLoad();
```

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

### Matlab Syntax Tokens

Source: https://github.com/squarebracketassociates/enterprisepharo/blob/master/support/html/highlightjs/classref.txt

Outlines syntax highlighting token types for Matlab, covering comments, strings, numbers, keywords, function names, function definitions, parameters, matrices, and cells.

```APIDOC
Matlab Syntax Tokens:
  comment: comment
  string: string
  number: number
  keyword: keyword
  title: function name
  function: function
  param: params of function
  matrix: matrix in [ .. ]
  cell: cell in { .. }
```

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

### Vala Syntax Tokens

Source: https://github.com/squarebracketassociates/enterprisepharo/blob/master/support/html/highlightjs/classref.txt

Defines token types for syntax highlighting in Vala. Includes keywords, numbers, strings, comments, class definitions, and constants.

```vala
keyword: keyword
number: number
string: string
comment: comment
class: class definitions
title: in class definition
constant: ALL_UPPER_CASE
```

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

### C# Syntax Tokens

Source: https://github.com/squarebracketassociates/enterprisepharo/blob/master/support/html/highlightjs/classref.txt

Defines token types for syntax highlighting in C#. Covers keywords, numbers, strings, comments, and XML documentation tags.

```cs
keyword: keyword
number: number
string: string
comment: commment
xmlDocTag: xmldoc tag ("///", "<!--", "-->", "<..>")
```

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

### RenderMan RIB Syntax Tokens

Source: https://github.com/squarebracketassociates/enterprisepharo/blob/master/support/html/highlightjs/classref.txt

Defines token types for syntax highlighting in RenderMan Interface Bytestream (RIB). Includes keywords, numbers, strings, comments, and commands.

```rib
keyword: keyword
number: number
string: string
comment: comment
commands: command
```

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

### RenderMan RSL Syntax Tokens

Source: https://github.com/squarebracketassociates/enterprisepharo/blob/master/support/html/highlightjs/classref.txt

Defines token types for syntax highlighting in RenderMan Shading Language (RSL). Covers keywords, numbers, strings, comments, preprocessor directives, shader, shading, and built-in functions.

```rsl
keyword: keyword
number: number
string: string (including @"..")
comment: comment
preprocessor: preprocessor directive
shader: sahder keywords
shading: shading keywords
built_in: built-in function
```

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

### Scilab Syntax Tokens

Source: https://github.com/squarebracketassociates/enterprisepharo/blob/master/support/html/highlightjs/classref.txt

Specifies syntax highlighting token types for Scilab, similar to Matlab, including comments, strings, numbers, keywords, function names, function definitions, parameters, matrices, and cells.

```APIDOC
Scilab Syntax Tokens:
  comment: comment
  string: string
  number: number
  keyword: keyword
  title: function name
  function: function
  param: params of function
  matrix: matrix in [ .. ]
```

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

### R Syntax Tokens

Source: https://github.com/squarebracketassociates/enterprisepharo/blob/master/support/html/highlightjs/classref.txt

Describes syntax highlighting token types for R, encompassing comments, string constants, numbers, language keywords, structural functions, and special literals like TRUE, FALSE, and NULL.

```APIDOC
R Syntax Tokens:
  comment: comment
  string: string constant
  number: number
  keyword: language keywords (function, if) plus "structural" functions (attach, require, setClass)
  literal: special literal: TRUE, FALSE, NULL, NA, etc.
```

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

### HTML Class for Language Specification

Source: https://github.com/squarebracketassociates/enterprisepharo/blob/master/support/html/highlightjs/README.md

Demonstrates how to explicitly set the language for a code block by assigning a class to the `<code>` element, improving autodetection accuracy or overriding it.

```html
<pre><code class="html">...</code></pre>
```

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

### Rust Syntax Tokens

Source: https://github.com/squarebracketassociates/enterprisepharo/blob/master/support/html/highlightjs/classref.txt

Details syntax highlighting token types for Rust, including comments, strings, numbers, keywords, function/declaration names, and preprocessor directives.

```APIDOC
Rust Syntax Tokens:
  comment: comment
  string: string
  number: number
  keyword: keyword
  title: name of declaration
  preprocessor: preprocessor directive
```

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

### Smalltalk Syntax Tokens

Source: https://github.com/squarebracketassociates/enterprisepharo/blob/master/support/html/highlightjs/classref.txt

Defines token types for syntax highlighting in Smalltalk. Covers keywords, numbers, strings, comments, symbols, arrays, class names, characters, and local variables.

```smalltalk
keyword: keyword
number: number
string: string
comment: commment
symbol: symbol
array: array
class: name of a class
char: char
localvars: block of local variables
```

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

### D Syntax Tokens

Source: https://github.com/squarebracketassociates/enterprisepharo/blob/master/support/html/highlightjs/classref.txt

Defines token types for syntax highlighting in D. Includes comments, strings, numbers, keywords, constants (true, false, null), and built-in types.

```d
comment: comment
string: string constant
number: number
keyword: language keywords (including @attributes)
constant: true false null
built_in: built-in plain types (int, string etc.)
```

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

### SQL Syntax Tokens

Source: https://github.com/squarebracketassociates/enterprisepharo/blob/master/support/html/highlightjs/classref.txt

Defines token types for syntax highlighting in SQL. Includes keywords (SQL'92, SQL'99), numbers, strings, comments, and aggregate functions.

```sql
keyword: keyword (mostly SQL'92 and SQL'99)
number: number
string: string (of any type: "..", '..', `..`)
comment: comment
aggregate: aggregate function
```

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

### Java Syntax Tokens

Source: https://github.com/squarebracketassociates/enterprisepharo/blob/master/support/html/highlightjs/classref.txt

Defines token types for syntax highlighting in Java. Covers keywords, numbers, strings, comments, annotations, Javadoc, class headers, and inheritance.

```java
keyword: keyword
number: number
string: string
comment: commment
annotation: annotation
javadoc: javadoc comment
class: class header from "class" till "{"
title: class name inside a header
params: everything in parentheses inside a class header
inheritance: keywords "extends" and "implements" inside class header
```

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

### C++ Syntax Tokens

Source: https://github.com/squarebracketassociates/enterprisepharo/blob/master/support/html/highlightjs/classref.txt

Defines token types for syntax highlighting in C++. Includes keywords, numbers, strings, comments, preprocessor directives, and STL containers.

```cpp
keyword: keyword
number: number
string: string and character
comment: comment
preprocessor: preprocessor directive
stl_container: instantiation of STL containers ("vector<...>")
```

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

### Lua Syntax Tokens

Source: https://github.com/squarebracketassociates/enterprisepharo/blob/master/support/html/highlightjs/classref.txt

Defines token types for syntax highlighting in Lua. Covers keywords, numbers, strings, comments, built-in operators, and function definitions.

```lua
keyword: keyword
number: number
string: string
comment: comment
built_in: built-in operator
function: header of a function
title: name of a function inside a header
params: everything inside parentheses in a function's header
long_brackets: multiline string in [=[ .. ]=]
```

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

### AppleScript Syntax Tokens

Source: https://github.com/squarebracketassociates/enterprisepharo/blob/master/support/html/highlightjs/classref.txt

Defines syntax highlighting token types for AppleScript, covering keywords, core commands, built-in constants and properties, variable types, numbers, strings, comments, and handler names.

```APIDOC
AppleScript Syntax Tokens:
  keyword: keyword
  command: core AppleScript command
  constant: AppleScript built in constant
  type: AppleScript variable type (integer, etc.)
  property: Applescript built in property (length, etc.)
  number: number
  string: string
  comment: comment
  title: name of a handler
```

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

### Objective-C Syntax Tokens

Source: https://github.com/squarebracketassociates/enterprisepharo/blob/master/support/html/highlightjs/classref.txt

Defines token types for syntax highlighting in Objective-C. Covers keywords, Cocoa/Cocoa Touch constants, numbers, strings, comments, preprocessor directives, class declarations, and properties.

```objectivec
keyword: keyword
built_in: Cocoa/Cocoa Touch constants and classes
number: number
string: string
comment: comment
preprocessor: preprocessor directive
class: interface/implementation, protocol and forward class declaration
variable: properties and struct accesors
```

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

### F# Syntax Tokens

Source: https://github.com/squarebracketassociates/enterprisepharo/blob/master/support/html/highlightjs/classref.txt

Defines token types for syntax highlighting in F#. Includes keywords, numbers, strings, comments, custom types (classes), and attributes.

```fsharp
keywords: keyword
number: number
string: string
commment: comment
class: any custom F# type
title: the name of a custom F# type
annotation: any attribute
```

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

### Clojure Syntax Tokens

Source: https://github.com/squarebracketassociates/enterprisepharo/blob/master/support/html/highlightjs/classref.txt

Defines token types for syntax highlighting in Clojure. Covers comments, strings, numbers, collections, keywords (attributes), and function names.

```clojure
comment: comments and hints
string: string
number: number
collection: collections
attribute: :keyword
title: function name (built-in or user defined)
```

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

### Lisp Syntax Tokens

Source: https://github.com/squarebracketassociates/enterprisepharo/blob/master/support/html/highlightjs/classref.txt

Defines token types for syntax highlighting in Lisp. Includes keywords, numbers, strings, comments, variables, literals, lists, and specific list elements like title and body.

```lisp
keyword: keyword
number: number
string: string
comment: commment
variable: variable
literal: b, t and nil
list: non-quoted list
title: first symbol in a non-quoted list
body: remainder of the non-quoted list
quoted: quoted list, both "(quote .. )" and "'(..)"
```

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

### Erlang Syntax Tokens

Source: https://github.com/squarebracketassociates/enterprisepharo/blob/master/support/html/highlightjs/classref.txt

Defines syntax highlighting token types for the Erlang programming language, covering comments, strings, numbers, keywords, record access, declaration names, variables, module attributes, and function calls.

```APIDOC
Erlang Syntax Tokens:
  comment: comment
  string: string
  number: number
  keyword: keyword
  record_name: record access (#record_name)
  title: name of declaration function
  variable: variable (starts with capital letter or with _)
  pp.keywords: module's attribute (-attribute)
  function_name: atom or atom:atom in case of function call
```

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

### Maya Embedded Language (MEL) Syntax Tokens

Source: https://github.com/squarebracketassociates/enterprisepharo/blob/master/support/html/highlightjs/classref.txt

Defines token types for syntax highlighting in Maya Embedded Language (MEL). Covers keywords, numbers, strings, comments, and variables.

```mel
keyword: keyword
number: number
string: string
comment: comment
variable: variable
```

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

### Delphi Syntax Tokens

Source: https://github.com/squarebracketassociates/enterprisepharo/blob/master/support/html/highlightjs/classref.txt

Defines token types for syntax highlighting in Delphi. Includes keywords, comments, numbers, strings, function/procedure headers, and class definitions.

```delphi
keyword: keyword
comment: comment (of any type)
number: number
string: string
function: header of a function, procedure, constructor and destructor
title: name of a function, procedure, constructor or destructor inside a header
params: everything inside parentheses in a function's header
class: class' body from "= class" till "end;"
```

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

### OCaml Syntax Tokens

Source: https://github.com/squarebracketassociates/enterprisepharo/blob/master/support/html/highlightjs/classref.txt

Defines token types for syntax highlighting in OCaml. Covers keywords, numbers, strings, comments, custom types (classes), and attributes.

```ocaml
keywords: keyword
number: number
string: string
commment: comment
class: any custom OCaml type
title: the name of a custom OCaml type
annotation: any attribute
```

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

### HTML Class to Disable Highlighting

Source: https://github.com/squarebracketassociates/enterprisepharo/blob/master/support/html/highlightjs/README.md

Explains how to prevent Highlight.js from processing a specific code block by assigning the `no-highlight` class to its container element.

```html
<pre><code class="no-highlight">...</code></pre>
```
Tokens:
Raw