WoltLab Suite Core

https://github.com/woltlab/wcf
Admin
WoltLab Suite Core is a free CMS and web-framework designed for building awesome websites and...
Tokens:191,508
Snippets:1,941
Trust Score:6.6
License:LGPL-2.1
Update:5 months ago
Show doc for...
Tokens:
Raw
### Composer Installation

Source: https://github.com/woltlab/wcf/blob/6.2/wcfsetup/install/files/lib/system/api/paragonie/sodium_compat/README.md

Install sodium_compat using Composer. This is the recommended method for most projects.

```bash
composer require paragonie/sodium_compat
```

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

### Install laminas-progressbar using Composer

Source: https://github.com/woltlab/wcf/blob/6.2/wcfsetup/install/files/lib/system/api/laminas/laminas-progressbar/README.md

Run this command to install the library using Composer.

```bash
$ composer require laminas/laminas-progressbar
```

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

### Install Negotiation via Composer

Source: https://github.com/woltlab/wcf/blob/6.2/wcfsetup/install/files/lib/system/api/willdurand/negotiation/README.md

Use Composer to install the Negotiation library. This is the recommended method.

```bash
$ composer require willdurand/negotiation
```

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

### Define Package Installation Manifest

Source: https://context7.com/woltlab/wcf/llms.txt

Uses `package.xml` to define installation and update instructions for WoltLab Suite packages. Specifies package information, requirements, and installation steps.

```xml
<?xml version="1.0" encoding="UTF-8"?>
<package name="com.example.wcf.guestbook"
         xmlns="http://www.woltlab.com"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://www.woltlab.com http://www.woltlab.com/XSD/6.0/package.xsd">
    <packageinformation>
        <packagename>Example Guestbook</packagename>
        <packagedescription>A simple guestbook plugin for WoltLab Suite.</packagedescription>
        <version>1.0.0</version>
        <date>2024-01-01</date>
    </packageinformation>
    <authorinformation>
        <author>Example Developer</author>
    </authorinformation>
    <requiredpackages>
        <requiredpackage minversion="6.0.0">com.woltlab.wcf</requiredpackage>
    </requiredpackages>
    <instructions type="install">
        <instruction type="file" />            <!-- installs files/ directory -->
        <instruction type="template" />        <!-- installs templates/ directory -->
        <instruction type="objectTypeDefinition" />
        <instruction type="objectType" />
        <instruction type="eventListener" />   <!-- registers event listeners -->
        <instruction type="page" />            <!-- registers pages/routes -->
        <instruction type="userGroupOption" /> <!-- registers permissions -->
    </instructions>
    <instructions type="update" fromversion="0.9.0">
        <instruction type="file" />
    </instructions>
</package>
```

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

### LiveScript Prelude Installation

Source: https://github.com/woltlab/wcf/blob/6.2/wcfsetup/install/files/js/3rdParty/codemirror/mode/livescript/index.html

A meta-function to install the LiveScript prelude onto a target object, ensuring that prelude functions are available.

```livescript
# meta
export installPrelude = !(target) -> unless target.prelude?isInstalled target <<< out$
# using out$ generated by livescript
 target <<< target.prelude.isInstalled = true
```

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

### OCaml: List and float addition examples

Source: https://github.com/woltlab/wcf/blob/6.2/wcfsetup/install/files/js/3rdParty/codemirror/mode/mllike/index.html

Examples of list literal and float addition in OCaml.

```ocaml
[1; 2; 3]
1. +. 2.
```

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

### Asterisk Dialplan Configuration Example

Source: https://github.com/woltlab/wcf/blob/6.2/wcfsetup/install/files/js/3rdParty/codemirror/mode/asterisk/index.html

This is an example of an Asterisk extensions.conf file, demonstrating various dialplan contexts, extensions, and commands. It includes general settings, context definitions, and specific examples for handling calls, voicemail, and system-wide pages.

```asterisk
; extensions.conf - the Asterisk dial plan
; [general]
; 
; If static is set to no, or omitted, then the pbx_config will rewrite
; this file when extensions are modified. Remember that all comments
; made in the file will be lost when that happens. static=yes
#include "/etc/asterisk/additional_general.conf

[iaxprovider]
switch => IAX2/user:[key]@myserver/mycontext

[dynamic]
#exec /usr/bin/dynamic-peers.pl

[trunkint]
; 
; International long distance through trunk
; exten => _9011.,1,Macro(dundi-e164,${EXTEN:4})
 exten => _9011.,n,Dial(${GLOBAL(TRUNK)}/${FILTER(0-9,${EXTEN:${GLOBAL(TRUNKMSD)}})})

[local]
; 
; Master context for local, toll-free, and iaxtel calls only
; ignorepat => 9
include => default

[demo]
include => stdexten

; 
; We start with what to do when a call first comes in.
; 
 exten => s,1,Wait(1) ; Wait a second, just for fun
 same => n,Answer ; Answer the line
 same => n,Set(TIMEOUT(digit)=5) ; Set Digit Timeout to 5 seconds
 same => n,Set(TIMEOUT(response)=10) ; Set Response Timeout to 10 seconds
 same => n(restart),BackGround(demo-congrats) ; Play a congratulatory message
 same => n(instruct),BackGround(demo-instruct) ; Play some instructions
 same => n,WaitExten ; Wait for an extension to be dialed.

 exten => 2,1,BackGround(demo-moreinfo) ; Give some more information.
 exten => 2,n,Goto(s,instruct)

 exten => 3,1,Set(LANGUAGE()=fr) ; Set language to french
 exten => 3,n,Goto(s,restart) ; Start with the congratulations

 exten => 1000,1,Goto(default,s,1) ; 

; 
; We also create an example user, 1234, who is on the console and has
; voicemail, etc.
; 
 exten => 1234,1,Playback(transfer,skip) ; "Please hold while..."
; (but skip if channel is not up)
 exten => 1234,n,Gosub(${EXTEN},stdexten(${GLOBAL(CONSOLE)}))
 exten => 1234,n,Goto(default,s,1) ; exited Voicemail

 exten => 1235,1,Voicemail(1234,u) ; Right to voicemail
 exten => 1236,1,Dial(Console/dsp) ; Ring forever
 exten => 1236,n,Voicemail(1234,b) ; Unless busy

; 
; # for when they're done with the demo
; 
 exten => #,1,Playback(demo-thanks) ; "Thanks for trying the demo"
 exten => #,n,Hangup ; Hang them up.

; 
; A timeout and "invalid extension rule"
; 
 exten => t,1,Goto(#,1) ; If they take too long, give up
 exten => i,1,Playback(invalid) ; "That's not valid, try again"

; 
; Create an extension, 500, for dialing the
; Asterisk demo.
; 
 exten => 500,1,Playback(demo-abouttotry); Let them know what's going on
 exten => 500,n,Dial(IAX2/guest@pbx.digium.com/s@default) ; Call the Asterisk demo
 exten => 500,n,Playback(demo-nogo) ; Couldn't connect to the demo site
 exten => 500,n,Goto(s,6) ; Return to the start over message.

; 
; Create an extension, 600, for evaluating echo latency.
; 
 exten => 600,1,Playback(demo-echotest) ; Let them know what's going on
 exten => 600,n,Echo ; Do the echo test
 exten => 600,n,Playback(demo-echodone) ; Let them know it's over
 exten => 600,n,Goto(s,6) ; Start over

; 
; You can use the Macro Page to intercom a individual user
 exten => 76245,1,Macro(page,SIP/Grandstream1) ; or if your peernames are the same as extensions
 exten => _7XXX,1,Macro(page,SIP/${EXTEN})

; 
; System Wide Page at extension 7999
; 
 exten => 7999,1,Set(TIMEOUT(absolute)=60)
 exten => 7999,2,Page(Local/Grandstream1@page&Local/Xlite1@page&Local/1234@page/n)

; Give voicemail at extension 8500
; 
 exten => 8500,1,VoicemailMain
 exten => 8500,n,Goto(s,6)
```

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

### Composer Installation Command

Source: https://github.com/woltlab/wcf/blob/6.2/wcfsetup/install/files/lib/system/api/thecodingmachine/safe/README.md

Use this command to install the Safe-PHP library via Composer.

```bash
composer require thecodingmachine/safe
```

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

### Install laminas-httphandlerrunner using Composer

Source: https://github.com/woltlab/wcf/blob/6.2/wcfsetup/install/files/lib/system/api/laminas/laminas-httphandlerrunner/README.md

Run this command to install the library. This is the standard method for adding packages to a PHP project.

```bash
composer require laminas/laminas-httphandlerrunner
```

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

### WebAssembly Module Example

Source: https://github.com/woltlab/wcf/blob/6.2/wcfsetup/install/files/js/3rdParty/codemirror/mode/wast/index.html

An example of a WebAssembly module written in text format, defining factorial and addition functions.

```wast
/* Example WebAssembly */ (module $foo (export "fac" (func $fac)) (export "plus" (func $plus)) (func $fac (type $t0) (param $p0 i64) (result i64) (if $I0 (result i64) (i64.lt_s (local.get $p0) (i64.const 1)) (then (i64.const 1)) (else (i64.mul (local.get $p0) (call $fac (i64.sub (local.get $p0) (i64.const 1))))))) (func $plus (param $x i32) (param $y i32) (result i32) (i32.add (local.get $x) (local.get $y))))
```

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

### Install getallheaders for PHP >= 5.6

Source: https://github.com/woltlab/wcf/blob/6.2/wcfsetup/install/files/lib/system/api/ralouphie/getallheaders/README.md

Use this command to install the library if your project requires PHP version 5.6 or higher.

```bash
composer require ralouphie/getallheaders
```

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

### Install getallheaders for PHP < 5.6

Source: https://github.com/woltlab/wcf/blob/6.2/wcfsetup/install/files/lib/system/api/ralouphie/getallheaders/README.md

Use this command to install the library if your project requires a PHP version lower than 5.6, specifically targeting version 2 of the library.

```bash
composer require ralouphie/getallheaders "^2"
```

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

### OCaml: Triangle graphics example

Source: https://github.com/woltlab/wcf/blob/6.2/wcfsetup/install/files/js/3rdParty/codemirror/mode/mllike/index.html

A basic OpenGL triangle rendering example using the Glut library in OCaml. Initializes GLUT, sets up display mode, creates a window, and defines a render function.

```ocaml
let () = ignore( Glut.init Sys.argv )
Glut.initDisplayMode ~double_buffer:true ()
ignore (Glut.createWindow ~title:"OpenGL Demo")

let angle t = 10. *. t *. t

let render () =
  GlClear.clear [ `color ]
  GlMat.load_identity ()
  GlMat.rotate ~angle: (angle (Sys.time ())) ~z:1.
  GlDraw.begins `triangles
  List.iter GlDraw.vertex2 [-1., -1.; 0., 1.; 1., -1.]
  GlDraw.ends ()
  Glut.swapBuffers ()

GlMat.mode `modelview
Glut.displayFunc ~cb:render
Glut.idleFunc ~cb:(Some Glut.postRedisplay)
Glut.mainLoop ()
```

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

### Basic FastRoute Usage Example

Source: https://github.com/woltlab/wcf/blob/6.2/wcfsetup/install/files/lib/system/api/nikic/fast-route/README.md

A fundamental example demonstrating how to set up a dispatcher, define routes, and handle dispatched route information. It includes handling 404 and 405 errors.

```php
<?php

require '/path/to/vendor/autoload.php';

$dispatcher = FastRoute\simpleDispatcher(function(FastRoute\ConfigureRoutes $r) {
    $r->addRoute('GET', '/users', 'get_all_users_handler');
    // {id} must be a number (\d+)
    $r->addRoute('GET', '/user/{id:\d+}', 'get_user_handler');
    // The /{title} suffix is optional
    $r->addRoute('GET', '/articles/{id:\d+}[/{title}]', 'get_article_handler');
});

// Fetch method and URI from somewhere
$httpMethod = $_SERVER['REQUEST_METHOD'];
$uri = $_SERVER['REQUEST_URI'];

// Strip query string (?foo=bar) and decode URI
if (false !== $pos = strpos($uri, '?')) {
    $uri = substr($uri, 0, $pos);
}
$uri = rawurldecode($uri);

$routeInfo = $dispatcher->dispatch($httpMethod, $uri);
switch ($routeInfo[0]) {
    case FastRoute\Dispatcher::NOT_FOUND:
        // ... 404 Not Found
        break;
    case FastRoute\Dispatcher::METHOD_NOT_ALLOWED:
        $allowedMethods = $routeInfo[1];
        // ... 405 Method Not Allowed
        break;
    case FastRoute\Dispatcher::FOUND:
        $handler = $routeInfo[1];
        $vars = $routeInfo[2];
        // ... call $handler with $vars
        break;
}

```

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

### Install FastRoute using Composer

Source: https://github.com/woltlab/wcf/blob/6.2/wcfsetup/install/files/lib/system/api/nikic/fast-route/README.md

Install the FastRoute library using Composer. Requires PHP 8.1 or newer.

```sh
composer require nikic/fast-route
```

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

### Gas Assembler Syntax Example

Source: https://github.com/woltlab/wcf/blob/6.2/wcfsetup/install/files/js/3rdParty/codemirror/mode/gas/index.html

An example demonstrating AT&T assembler syntax, including directives, comments, and basic assembly instructions.

```gas
.syntax unified
.global main
/*
 * A
 * multi-line
 * comment. 
 */
@ A single line comment.
main:
  push {sp, lr}
  ldr r0, =message
  bl puts
  mov r0, #0
  pop {sp, pc}
message:
  .asciz "Hello world!<br />"
```

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

### Swift Protocol and Struct Example

Source: https://github.com/woltlab/wcf/blob/6.2/wcfsetup/install/files/js/3rdParty/codemirror/mode/swift/index.html

Demonstrates Swift protocol definition, struct implementation, and type erasure with an example of a header view.

```swift
protocol HeaderViewProtocol { func setTitle(_ string: String) }
struct AnyHeaderView {
    let view: UIView
    let headerView: HeaderViewProtocol
    init<T: UIView>(view: T) where T: HeaderViewProtocol {
        self.view = view
        self.headerView = view
    }
}
let header = AnyHeaderView(view: myView)
header.headerView.setTitle("hi")
struct HeaderView {
    let view: UIView
    let setTitle: (String) -> ()
}
var label = UILabel()
let header = HeaderView(view: label) { str in label.text = str }
header.setTitle("hello")
```

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

### Install PKI Framework with Composer

Source: https://github.com/woltlab/wcf/blob/6.2/wcfsetup/install/files/lib/system/api/spomky-labs/pki-framework/README.md

Use Composer to install the Spomky-Labs PKI framework. Ensure you have PHP >= 8.1 and the `mbstring` extension enabled.

```bash
composer require spomky-labs/pki-framework
```

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

### Install Library with Composer

Source: https://github.com/woltlab/wcf/blob/6.2/wcfsetup/install/files/lib/system/api/paragonie/constant_time_encoding/README.md

Use Composer to add this library as a project dependency.

```sh
composer require paragonie/constant_time_encoding
```

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

### CodeMirror Setup for LiveScript

Source: https://github.com/woltlab/wcf/blob/6.2/wcfsetup/install/files/js/3rdParty/codemirror/mode/livescript/index.html

Demonstrates how to initialize CodeMirror with a specific theme and line numbers enabled, using a textarea element with the ID 'code'. This is a basic setup for using CodeMirror with any mode.

```javascript
var editor = CodeMirror.fromTextArea(document.getElementById("code"), { theme: "solarized light", lineNumbers: true });
```

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

### Remove Unwanted CSS Rules with PHP CSS Parser

Source: https://github.com/woltlab/wcf/blob/6.2/wcfsetup/install/files/lib/system/api/sabberworm/php-css-parser/README.md

Use `Document::getAllRuleSets` to get all rule sets and then `RuleSet::removeRule` to remove specific rules by name. This example shows how to remove rules starting with 'font-' and the 'cursor' rule.

```php
$parser = new \Sabberworm\CSS\Parser($css);
$cssDocument = $parser->parse();
foreach($cssDocument->getAllRuleSets() as $oRuleSet) {
    // Note that the added dash will make this remove all rules starting with
    // `font-` (like `font-size`, `font-weight`, etc.) as well as a potential
    // `font` rule.
    $oRuleSet->removeRule('font-');
    $oRuleSet->removeRule('cursor');
}
```

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

### Install Test Suite with Composer

Source: https://github.com/woltlab/wcf/blob/6.2/wcfsetup/install/files/lib/system/api/willdurand/negotiation/README.md

Use this command to set up the test suite for the Negotiation library. This command should be run in your project directory.

```bash
$ composer install --dev
```

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

### LESS CSS Preprocessor Syntax Examples

Source: https://github.com/woltlab/wcf/blob/6.2/wcfsetup/install/files/js/3rdParty/codemirror/mode/css/less.html

Illustrates various LESS syntax features including media queries, nested rules, variables, mixins, and imports. These examples showcase how LESS extends CSS.

```less
@media screen and (device-aspect-ratio: 16/9) { … }
```

```less
@media screen and (device-aspect-ratio: 1280/720) { … }
```

```less
@media screen and (device-aspect-ratio: 2560/1440) { … }
```

```less
html:lang(fr-be) tr:nth-child(2n+1) /* represents every odd row of an HTML table */ img:nth-of-type(2n+1) { float: right; }
```

```less
img:nth-of-type(2n) { float: left; }
```

```less
body > h2:not(:first-of-type):not(:last-of-type)
```

```less
html|*:not(:link):not(:visited) *|*:not(:hover) p::first-line { text-transform: uppercase }
```

```less
@namespace foo url(http://www.example.com); foo|h1 { color: blue } /* first rule */
```

```less
span[hello="Ocean"][goodbye="Land"] E[foo]{ padding:65px; }
```

```less
input[type="search"]::-webkit-search-decoration, input[type="search"]::-webkit-search-cancel-button { -webkit-appearance: none; // Inner-padding issues in Chrome OSX, Safari 5 }
```

```less
button::-moz-focus-inner, input::-moz-focus-inner { // Inner padding and border oddities in FF3/4 padding: 0; border: 0; }
```

```less
.btn { // reset here as of 2.0.3 due to Recess property order border-color: #ccc; border-color: rgba(0,0,0,.1) rgba(0,0,0,.1) rgba(0,0,0,.25); }
```

```less
fieldset span button, fieldset span input[type="file"] { font-size:12px; font-family:Arial, Helvetica, sans-serif; }
```

```less
.rounded-corners (@radius: 5px) { border-radius: @radius; -webkit-border-radius: @radius; -moz-border-radius: @radius; }
```

```less
@import url("something.css");
```

```less
@light-blue: hsl(190, 50%, 65%);
```

```less
#menu { position: absolute; width: 100%; z-index: 3; clear: both; display: block; background-color: @blue; height: 42px; border-top: 2px solid lighten(@alpha-blue, 20%); border-bottom: 2px solid darken(@alpha-blue, 25%); .box-shadow(0, 1px, 8px, 0.6); -moz-box-shadow: 0 0 0 #000; // Because firefox sucks. &.docked { background-color: hsla(210, 60%, 40%, 0.4); } &:hover { background-color: @blue; } #dropdown { margin: 0 0 0 117px; padding: 0; padding-top: 5px; display: none; width: 190px; border-top: 2px solid @medium; color: @highlight; border: 2px solid darken(@medium, 25%); border-left-color: darken(@medium, 15%); border-right-color: darken(@medium, 15%); border-top-width: 0; background-color: darken(@medium, 10%); ul { padding: 0px; } li { font-size: 14px; display: block; text-align: left; padding: 0; border: 0; a { display: block; padding: 0px 15px; text-decoration: none; color: white; &:hover { background-color: darken(@medium, 15%); text-decoration: none; } } } .border-radius(5px, bottom); .box-shadow(0, 6px, 8px, 0.5); } }
```

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

### Install From Source

Source: https://github.com/woltlab/wcf/blob/6.2/wcfsetup/install/files/lib/system/api/paragonie/sodium_compat/README.md

Include the autoload.php script in your project if you are not using Composer. Ensure you have downloaded a release tarball.

```php
<?php
require_once "/path/to/sodium_compat/autoload.php";
```

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

### Install sebastian/diff as a development dependency

Source: https://github.com/woltlab/wcf/blob/6.2/wcfsetup/install/files/lib/system/api/sebastian/diff/README.md

Use this command if you only need the library during development, for example, to run your project's test suite.

```bash
composer require --dev sebastian/diff
```

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

### Dockerfile Syntax Highlighting Example

Source: https://github.com/woltlab/wcf/blob/6.2/wcfsetup/install/files/js/3rdParty/codemirror/mode/dockerfile/index.html

This is a sample Dockerfile demonstrating various instructions and syntax elements. It is used for testing and showcasing the Dockerfile mode.

```dockerfile
# Install Ghost blogging platform and run development environment
#
# VERSION 1.0.0
FROM ubuntu:12.10
MAINTAINER Amer Grgic "amer@livebyt.es"
WORKDIR /data/ghost

# Install dependencies for nginx installation
RUN apt-get update
RUN apt-get install -y python g++ make software-properties-common --force-yes
RUN add-apt-repository ppa:chris-lea/node.js
RUN apt-get update

# Install unzip
RUN apt-get install -y unzip

# Install curl
RUN apt-get install -y curl

# Install nodejs & npm
RUN apt-get install -y rlwrap
RUN apt-get install -y nodejs

# Download Ghost v0.4.1
RUN curl -L https://ghost.org/zip/ghost-latest.zip -o /tmp/ghost.zip

# Unzip Ghost zip to /data/ghost
RUN unzip -uo /tmp/ghost.zip -d /data/ghost

# Add custom config js to /data/ghost
ADD ./config.example.js /data/ghost/config.js

# Install Ghost with NPM
RUN cd /data/ghost/ && npm install --production

# Expose port 2368
EXPOSE 2368

# Run Ghost
CMD 
["npm","start"]

```

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

### Enable and Use Filter.ExtractStyleBlocks

Source: https://github.com/woltlab/wcf/blob/6.2/wcfsetup/install/files/lib/system/api/ezyang/htmlpurifier/library/HTMLPurifier/ConfigSchema/schema/Filter.ExtractStyleBlocks.txt

This example demonstrates how to enable the ExtractStyleBlocks filter and process HTML containing style blocks. It shows how to retrieve the extracted styles from the context and save them to files, linking them in the document head. Ensure CSSTidy is installed and accessible.

```php
<?php
    header('Content-type: text/html; charset=utf-8');
    echo '<?xml version="1.0" encoding="UTF-8"?>';
?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
<head>
  <title>Filter.ExtractStyleBlocks</title>
<?php
    require_once '/path/to/library/HTMLPurifier.auto.php';
    require_once '/path/to/csstidy.class.php';

    $dirty = '<style>body {color:#F00;}</style> Some text';

    $config = HTMLPurifier_Config::createDefault();
    $config->set('Filter', 'ExtractStyleBlocks', true);
    $purifier = new HTMLPurifier($config);

    $html = $purifier->purify($dirty);

    // This implementation writes the stylesheets to the styles/ directory.
    // You can also echo the styles inside the document, but it's a bit
    // more difficult to make sure they get interpreted properly by
    // browsers; try the usual CSS armoring techniques.
    $styles = $purifier->context->get('StyleBlocks');
    $dir = 'styles/';
    if (!is_dir($dir)) mkdir($dir);
    $hash = sha1($_GET['html']);
    foreach ($styles as $i => $style) {
        file_put_contents($name = $dir . $hash . "_$i");
        echo '<link rel="stylesheet" type="text/css" href="'.$name.'" />';
    }
?>
</head>
<body>
  <div>
    <?php echo $html; ?>
  </div>
</body>
</html>
```

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

### Properties File Syntax Example

Source: https://github.com/woltlab/wcf/blob/6.2/wcfsetup/install/files/js/3rdParty/codemirror/mode/properties/index.html

Illustrates the syntax for properties files, including comments, key-value pairs, multi-line values, and Unicode characters. This mode is useful for editing configuration files.

```properties
# This is a properties file a.key = A value another.key = http://example.com ! Exclamation mark as comment but.not=Within ! A value # indeed # Spaces at the beginning of a line spaces.before.key=value backslash=Used for multi\ line entries,\ that's convenient. # Unicode sequences unicode.key=This is \u0020 Unicode no.multiline=here # Colons colons : can be used too # Spaces spaces\ in\ keys=Not very common...
```

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

### Install guzzlehttp/psr7

Source: https://github.com/woltlab/wcf/blob/6.2/wcfsetup/install/files/lib/system/api/guzzlehttp/psr7/README.md

Use Composer to install the guzzlehttp/psr7 package.

```shell
composer require guzzlehttp/psr7
```

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

### XQuery Syntax Example

Source: https://github.com/woltlab/wcf/blob/6.2/wcfsetup/install/files/js/3rdParty/codemirror/mode/xquery/index.html

Demonstrates basic XQuery syntax including comments, variables, and element constructors.

```xquery
xquery version "1.0-ml"; (: this is : a "comment" :)
let $let := <x attr="value">"test"<func>function() $var {function()} {$var}</func></x>
let $joe:=1
return element element { attribute attribute { 1 }, element test { 'a' }, attribute foo { "bar" }, fn:doc()[
 foo/@bar eq $let 
], //x } (: a more 'evil' test :)
(: Modified Blakeley example (: with nested comment :) ... :)
declare private function local:declare() {()};
declare private function local:private() {()};
declare private function local:function() {()};
declare private function local:local() {()};
let $let := <let>let $let := "let"</let>
return element element { attribute attribute { try { xdmp:version() } catch($e) { xdmp:log($e) } }, attribute fn:doc { "bar" castable as xs:string }, element text { text { "text" } }, fn:doc()[
 child::eq/(@bar | attribute::attribute) eq $let 
], //fn:doc }
```

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

### Initialize Personal Repository

Source: https://github.com/woltlab/wcf/blob/6.2/wcfsetup/install/files/lib/system/api/zend/README-GIT.md

Initialize a new Git repository on your personal server. This is the first step for setting up your own repository.

```sh
% git init
```

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

### WCF AbstractAction Controller Example

Source: https://context7.com/woltlab/wcf/llms.txt

An example of a custom action controller extending AbstractAction for handling non-page requests like form submissions or redirects. This example shows session invalidation and redirection.

```php
<?php
namespace wcf\action;

use wcf\system\WCF;
use wcf\util\HeaderUtil;
use Laminas\Diactoros\Response\RedirectResponse;

class LogoutAction extends AbstractAction
{
    public $loginRequired = true;

    public function execute(): void
    {
        parent::execute();

        // Invalidate session
        WCF::getSession()->delete();

        // Redirect using PSR-7 response (WCF 5.5+)
        return new RedirectResponse(
            \wcf\system\request\LinkHandler::getInstance()->getLink('Index')
        );
    }
}

```

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

### ProtoBuf Syntax Example

Source: https://github.com/woltlab/wcf/blob/6.2/wcfsetup/install/files/js/3rdParty/codemirror/mode/protobuf/index.html

Illustrates the syntax for defining messages, enums, services, and options in Protocol Buffers. This is useful for understanding the structure of .proto files.

```protobuf
package addressbook; message Address { required string street = 1; required string postCode = 2; } message PhoneNumber { required string number = 1; } message Person { optional int32 id = 1; required string name = 2; required string surname = 3; optional Address address = 4; repeated PhoneNumber phoneNumbers = 5; optional uint32 age = 6; repeated uint32 favouriteNumbers = 7; optional string license = 8; enum Gender { MALE = 0; FEMALE = 1; } optional Gender gender = 9; optional fixed64 lastUpdate = 10; required bool deleted = 11 [default = false]; }
```

```protobuf
syntax = "proto3"; package tutorial; import "google/protobuf/timestamp.proto"; option java_package = "com.example.tutorial"; option java_outer_classname = "AddressBookProtos"; option csharp_namespace = "Google.Protobuf.Examples.AddressBook"; message Person { string name = 1; int32 id = 2; // Unique ID number for this person. string email = 3; enum PhoneType { MOBILE = 0; HOME = 1; WORK = 2; } message PhoneNumber { string number = 1; PhoneType type = 2; } repeated PhoneNumber phones = 4; google.protobuf.Timestamp last_updated = 5; } // Our address book file is just one of these. message AddressBook { repeated Person people = 1; } service Test { rpc SayHello (HelloRequest) returns (HelloReply) {} rpc SayHelloAgain (HelloRequest) returns (HelloReply) {} }
```

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

### Composer Installation for PHPStan Integration

Source: https://github.com/woltlab/wcf/blob/6.2/wcfsetup/install/files/lib/system/api/thecodingmachine/safe/README.md

Install the PHPStan extension for Safe-PHP as a development dependency.

```bash
composer require --dev thecodingmachine/phpstan-safe-rule
```

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

### Build Documentation with mkdocs

Source: https://github.com/woltlab/wcf/blob/6.2/wcfsetup/install/files/lib/system/api/laminas/laminas-httphandlerrunner/README.md

If you have mkdocs installed, you can use this command to build the project's documentation locally. This is useful for developers contributing to the documentation.

```bash
mkdocs build
```

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

### Basic HTTP Server in Crystal

Source: https://github.com/woltlab/wcf/blob/6.2/wcfsetup/install/files/js/3rdParty/codemirror/mode/crystal/index.html

A simple Crystal program demonstrating how to set up an HTTP server to respond to requests.

```crystal
# Features of Crystal # - Ruby-inspired syntax. # - Statically type-checked but without having to specify the type of variables or method arguments. # - Be able to call C code by writing bindings to it in Crystal. # - Have compile-time evaluation and generation of code, to avoid boilerplate code. # - Compile to efficient native code. # A very basic HTTP server
require "http/server"

server = HTTP::Server.new(8080) do |request|
  HTTP::Response.ok "text/plain", "Hello world, got #{request.path}!"
end

puts "Listening on http://0.0.0.0:8080"
server.listen
```

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

### Install PSR Clock via Composer

Source: https://github.com/woltlab/wcf/blob/6.2/wcfsetup/install/files/lib/system/api/psr/clock/README.md

Install the PSR Clock interface package using Composer.

```bash
composer require psr/clock
```

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

### Media Type Negotiation Example

Source: https://github.com/woltlab/wcf/blob/6.2/wcfsetup/install/files/lib/system/api/willdurand/negotiation/README.md

Negotiate the best media type from an Accept header and a list of priorities. Returns an instance of `Accept` or null.

```php
$negotiator = new \Negotiation\Negotiator();

$acceptHeader = 'text/html, application/xhtml+xml, application/xml;q=0.9, */*;q=0.8';
$priorities   = array('text/html; charset=UTF-8', 'application/json', 'application/xml;q=0.5');

$mediaType = $negotiator->getBest($acceptHeader, $priorities);

$value = $mediaType->getValue();
// $value == 'text/html; charset=UTF-8'
```

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

### Install Parsedown with Composer

Source: https://github.com/woltlab/wcf/blob/6.2/wcfsetup/install/files/lib/system/api/erusev/parsedown/README.md

Use Composer to install the Parsedown package. This is the recommended method for managing dependencies.

```sh
composer require erusev/parsedown
```

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

### Install Rector for Automated Refactoring

Source: https://github.com/woltlab/wcf/blob/6.2/wcfsetup/install/files/lib/system/api/thecodingmachine/safe/README.md

Install the Rector package as a development dependency to enable automated code refactoring.

```bash
composer require --dev rector/rector
```

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

### C Demo Code with ZMQ

Source: https://github.com/woltlab/wcf/blob/6.2/wcfsetup/install/files/js/3rdParty/codemirror/mode/clike/index.html

Demonstrates C code using ZeroMQ (zmq) and pthreads for asynchronous operations. Includes context management and thread creation.

```c
#include <zmq.h>
#include <pthread.h>
#include <semaphore.h>
#include <time.h>
#include <stdio.h>
#include <fcntl.h>
#include <malloc.h>
typedef struct {
    void* arg_socket;
    zmq_msg_t* arg_msg;
    char* arg_string;
    unsigned long arg_len;
    int arg_int, arg_command;
    int signal_fd;
    int pad;
    void* context;
    sem_t sem;
} acl_zmq_context;
#define p(X) (context->arg_##X)
void* zmq_thread(void* context_pointer) {
    acl_zmq_context* context = (acl_zmq_context*)context_pointer;
    char ok = 'K', err = 'X';
    int res;
    while (1) {
        while ((res = sem_wait(&context->sem)) == EINTR);
        if (res) {
            write(context->signal_fd, &err, 1);
            goto cleanup;
        }
        switch(p(command)) {
            case 0: goto cleanup;
            case 1: p(socket) = zmq_socket(context->context, p(int)); break;
            case 2: p(int) = zmq_close(p(socket)); break;
            case 3: p(int) = zmq_bind(p(socket), p(string)); break;
            case 4: p(int) = zmq_connect(p(socket), p(string)); break;
            case 5: p(int) = zmq_getsockopt(p(socket), p(int), (void*)p(string), &p(len)); break;
            case 6: p(int) = zmq_setsockopt(p(socket), p(int), (void*)p(string), p(len)); break;
            case 7: p(int) = zmq_send(p(socket), p(msg), p(int)); break;
            case 8: p(int) = zmq_recv(p(socket), p(msg), p(int)); break;
            case 9: p(int) = zmq_poll(p(socket), p(int), p(len)); break;
        }
        p(command) = errno;
        write(context->signal_fd, &ok, 1);
    }
cleanup:
    close(context->signal_fd);
    free(context_pointer);
    return 0;
}
void* zmq_thread_init(void* zmq_context, int signal_fd) {
    acl_zmq_context* context = malloc(sizeof(acl_zmq_context));
    pthread_t thread;
    context->context = zmq_context;
    context->signal_fd = signal_fd;
    sem_init(&context->sem, 1, 0);
    pthread_create(&thread, 0, &zmq_thread, context);
    pthread_detach(thread);
    return context;
}
```

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

### RPM Spec File Example

Source: https://github.com/woltlab/wcf/blob/6.2/wcfsetup/install/files/js/3rdParty/codemirror/mode/rpm/index.html

An example of an RPM spec file, which can be edited using CodeMirror with the 'rpm-spec' mode.

```rpm-spec
# # spec file for package minidlna # # Copyright (c) 2011, Sascha Peilicke <saschpe@gmx.de> # # All modifications and additions to the file contributed by third parties # remain the property of their copyright owners, unless otherwise agreed # upon. The license for this file, and modifications and additions to the # file, is the same license as for the pristine package itself (unless the # license for the pristine package is not an Open Source License, in which # case the license is the MIT License). An "Open Source License" is a # license that conforms to the Open Source Definition (Version 1.9) # published by the Open Source Initiative. Name: libupnp6 Version: 1.6.13 Release: 0 Summary: Portable Universal Plug and Play (UPnP) SDK Group: System/Libraries License: BSD-3-Clause Url: http://sourceforge.net/projects/pupnp/ Source0: http://downloads.sourceforge.net/pupnp/libupnp-%{version}.tar.bz2 BuildRoot: %{\_tmppath}/%{name}-%{version}-build %description The portable Universal Plug and Play (UPnP) SDK provides support for building UPnP-compliant control points, devices, and bridges on several operating systems. %package -n libupnp-devel Summary: Portable Universal Plug and Play (UPnP) SDK Group: Development/Libraries/C and C++ Provides: pkgconfig(libupnp) Requires: %{name} = %{version} %description -n libupnp-devel The portable Universal Plug and Play (UPnP) SDK provides support for building UPnP-compliant control points, devices, and bridges on several operating systems. %prep %setup -n libupnp-%{version} %build %configure --disable-static make %{?_smp_mflags} %install %makeinstall find %{buildroot} -type f -name '*.la' -exec rm -f {} ';' %post -p /sbin/ldconfig %postun -p /sbin/ldconfig %files %defattr(-,root,root,-) %doc ChangeLog NEWS README TODO %{\_libdir}/libixml.so.* %{\_libdir}/libthreadutil.so.* %{\_libdir}/libupnp.so.* %files -n libupnp-devel %defattr(-,root,root,-) %{\_libdir}/pkgconfig/libupnp.pc %{\_libdir}/libixml.so %{\_libdir}/libthreadutil.so %{\_libdir}/libupnp.so %{\_includedir}/upnp/ %changelog
```

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

### Stylus Syntax Highlighting Example

Source: https://github.com/woltlab/wcf/blob/6.2/wcfsetup/install/files/js/3rdParty/codemirror/mode/stylus/index.html

Demonstrates basic Stylus syntax for selectors, properties, and variables. This is useful for understanding how the mode highlights different parts of a Stylus stylesheet.

```stylus
/* Stylus mode */
#id, .class, article {
  font-family: Arial, sans-serif;
}

// Variables
font-size-base = 16px
line-height-base = 1.5
font-family-base = "Helvetica Neue", Helvetica, Arial, sans-serif
text-color = lighten(#000, 20%)

body {
  font: 400 16px/1.5 "Helvetica Neue", Helvetica, Arial, sans-serif;
  color: #333;
}

// Variables
link-color = darken(#428bca, 6.5%)
link-hover-color = darken(link-color, 15%)
link-decoration = none
link-hover-decoration = false

// Mixin
tab-focus() {
  outline: thin dotted;
  outline: 5px auto -webkit-focus-ring-color;
  outline-offset: -2px;
}

a {
  color: link-color;
  if link-decoration {
    text-decoration: link-decoration;
  }

  &:hover, &:focus {
    color: link-hover-color;
    if link-hover-decoration {
      text-decoration: link-hover-decoration;
    }
  }

  &:focus {
    tab-focus();
  }
}

a {
  color: #3782c4;
  text-decoration: none;
}

a:hover, a:focus {
  color: #2f6ea7;
}

a:focus {
  outline: thin dotted;
  outline: 5px auto -webkit-focus-ring-color;
  outline-offset: -2px;
}
```

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

### N-Quads Example Data

Source: https://github.com/woltlab/wcf/blob/6.2/wcfsetup/install/files/js/3rdParty/codemirror/mode/ntriples/index.html

This example demonstrates N-Quads data, which extends N-Triples by including a graph identifier for each statement.

```turtle
<http://Sub1> <http://pred1> <http://obj> <http://graph3> . <http://Sub2> <http://pred2#an2> "literal 1" <http://graph2> . <http://Sub3#an3> <http://pred3> 	_:bnode3 <http://graph2> . 	_:bnode4 <http://pred4> "literal 2"@lang <http://graph2> . # if a graph label 	_:bnode5 <http://pred5> "literal 3"^^<http://type> .
```

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

### JSON-LD Example

Source: https://github.com/woltlab/wcf/blob/6.2/wcfsetup/install/files/js/3rdParty/codemirror/mode/javascript/json-ld.html

An example of JSON-LD data structure, including context, schema definitions, and specific entity information.

```json
{
  "@context": {
    "name": "http://schema.org/name",
    "description": "http://schema.org/description",
    "image": {
      "@id": "http://schema.org/image",
      "@type": "@id"
    },
    "geo": "http://schema.org/geo",
    "latitude": {
      "@id": "http://schema.org/latitude",
      "@type": "xsd:float"
    },
    "longitude": {
      "@id": "http://schema.org/longitude",
      "@type": "xsd:float"
    },
    "xsd": "http://www.w3.org/2001/XMLSchema#"
  },
  "name": "The Empire State Building",
  "description": "The Empire State Building is a 102-story landmark in New York City.",
  "image": "http://www.civil.usherbrooke.ca/cours/gci215a/empire-state-building.jpg",
  "geo": {
    "latitude": "40.75",
    "longitude": "73.98"
  }
}
```

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

### Fortran Program Example

Source: https://github.com/woltlab/wcf/blob/6.2/wcfsetup/install/files/js/3rdParty/codemirror/mode/fortran/index.html

A sample Fortran program demonstrating basic input, calculations for averages, and output. It handles allocation and deallocation of arrays.

```fortran
program average
! Read in some numbers and take the average
! As written, if there are no data points, an average of zero is returned
! While this may not be desired behavior, it keeps this example simple
implicit none
real, dimension(:), allocatable :: points
integer :: number_of_points
real :: average_points=0., positive_average=0., negative_average=0.
write (*,*) "Input number of points to average:"
read (*,*) number_of_points
allocate (points(number_of_points))
write (*,*) "Enter the points to average:"
read (*,*) points
! Take the average by summing points and dividing by number_of_points
if (number_of_points > 0) average_points = sum(points) / number_of_points
! Now form average over positive and negative points only
if (count(points > 0.) > 0) then
positive_average = sum(points, points > 0.) / count(points > 0.)
end if
if (count(points < 0.) > 0) then
negative_average = sum(points, points < 0.) / count(points < 0.)
end if
deallocate (points)
! Print result to terminal
write (*,'(a,g12.4)') 'Average = ', average_points
write (*,'(a,g12.4)') 'Average of positive points = ', positive_average
write (*,'(a,g12.4)') 'Average of negative points = ', negative_average
end program average
```

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

### HTML Mixed Mode Example

Source: https://github.com/woltlab/wcf/blob/6.2/wcfsetup/install/files/js/3rdParty/codemirror/mode/htmlmixed/index.html

An example of an HTML document with embedded CSS and JavaScript, suitable for rendering in a browser.

```html
<html style="color: green"> <!-- this is a comment --> <head> <title>Mixed HTML Example</title> <style> h1 {font-family: comic sans; color: #f0f;} div {background: yellow !important;} body { max-width: 50em; margin: 1em 2em 1em 5em; } </style> </head> <body> <h1>Mixed HTML Example</h1> <script> function jsFunc(arg1, arg2) { if (arg1 && arg2) document.body.innerHTML = "achoo"; } </script> </body> </html>
```

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

### Handlebars Template Example

Source: https://github.com/woltlab/wcf/blob/6.2/wcfsetup/install/files/js/3rdParty/codemirror/mode/handlebars/index.html

This is an example of a Handlebars template, demonstrating various Handlebars expressions, comments, and block helpers.

```handlebars
{{> breadcrumbs}} {{!-- You can use the t function to get content translated to the current locale, es: {{t 'article_list'}} --}} <h1>{{t 'article_list'}}</h1> {{! one line comment }} {{{propertyContainingRawHtml}}} {{#each articles}} {{~title}} <p>{{excerpt body size=120 ellipsis=true}}</p> {{#with author}} written by {{first_name}} {{last_name}} from category: {{../category.title}} {{#if @../last}}foobar!{{/if}} {{/with~}} {{#if promoted.latest}}Read this one! {{else}} This is ok! {{/if}} {{#if @last}}<hr>{{/if}} {{/each}} {{#form new_comment}} <input type="text" name="body"> {{/form}}
```

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

### Buffer Initialization

Source: https://github.com/woltlab/wcf/blob/6.2/wcfsetup/install/files/lib/system/api/nelexa/buffer/README.md

Demonstrates how to initialize different types of buffers: StringBuffer, FileBuffer, MemoryResourceBuffer, and ResourceBuffer.

```APIDOC
## Buffer Initialization

### Initialize buffer as string.
```php
$buffer = new \Nelexa\StringBuffer();
// or
$buffer = new \Nelexa\StringBuffer($text);
```

### Initialize buffer as file.
```php
$buffer = new \Nelexa\FileBuffer($filename);
```

### Initialize buffer as memory resource (php://memory).
```php
$buffer = new \Nelexa\MemoryReourceBuffer();
// or
$buffer = new \Nelexa\MemoryReourceBuffer($text);
```

### Initialize buffer as stream resource.
```php
$fp = fopen('php://temp', 'w+b');
// or
$buffer = new \Nelexa\ResourceBuffer($fp);
```
```

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

### YAML Lists Example

Source: https://github.com/woltlab/wcf/blob/6.2/wcfsetup/install/files/js/3rdParty/codemirror/mode/yaml/index.html

Demonstrates the syntax for defining lists in YAML using hyphens.

```yaml
---
# Favorite movies
- Casablanca
- North by Northwest
- The Man Who Wasn't There
---
```

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

### Factor Code Example

Source: https://github.com/woltlab/wcf/blob/6.2/wcfsetup/install/files/js/3rdParty/codemirror/mode/factor/index.html

This is an example of Factor code, a concatenative programming language. It demonstrates a simple time server.

```factor
! Copyright (C) 2008 Slava Pestov. ! See http://factorcode.org/license.txt for BSD license. ! A simple time server USING: accessors calendar calendar.format io io.encodings.ascii io.servers kernel threads ;
IN: time-server
: handle-time-client ( -- ) now timestamp>rfc822 print ;
: <time-server> ( -- threaded-server ) ascii <threaded-server> "time-server" >>name 1234 >>insecure [ handle-time-client ] >>handler ;
: start-time-server ( -- ) <time-server> start-server drop ;
MAIN: start-time-server
```

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

### Install Guzzle Promises

Source: https://github.com/woltlab/wcf/blob/6.2/wcfsetup/install/files/lib/system/api/guzzlehttp/promises/README.md

Use Composer to install the Guzzle Promises library. This command adds the library as a dependency to your project.

```shell
composer require guzzlehttp/promises
```

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

### YAML Shopping List Example

Source: https://github.com/woltlab/wcf/blob/6.2/wcfsetup/install/files/js/3rdParty/codemirror/mode/yaml/index.html

Shows a simple shopping list format in YAML.

```yaml
---
# Shopping list
[milk, pumpkin pie, eggs, juice]
---
```
Tokens:
Raw