From 01f098296870cf56f835fa1222607d8216f52811 Mon Sep 17 00:00:00 2001 From: Thomas Kriechbaumer Date: Mon, 22 Jun 2015 15:12:20 +0200 Subject: prettify html docs --- libpathod/templates/docs_lang.html | 306 ++++++++++++++++++++----------------- 1 file changed, 162 insertions(+), 144 deletions(-) (limited to 'libpathod/templates/docs_lang.html') diff --git a/libpathod/templates/docs_lang.html b/libpathod/templates/docs_lang.html index ce778dc9..e3195939 100644 --- a/libpathod/templates/docs_lang.html +++ b/libpathod/templates/docs_lang.html @@ -1,17 +1,15 @@ -{% extends "docframe.html" %} -{% block body %} - +{% extends "docframe.html" %} {% block body %}
-

+

Language Spec The mini-language at the heart of pathoc and pathod.

@@ -28,151 +26,171 @@
-

Features

+

Features

- -

OFFSET

- -

Offsets are calculated relative to the base message, before any - injections or other transforms are applied. They have 3 flavors:

- -
    -
  • An integer byte offset
    • -
  • r for a random location
    • -
  • a for the end of the message
    • -
- - -

VALUE

+ +

OFFSET

-

Literals

+

+ Offsets are calculated relative to the base message, before any injections or other transforms + are applied. They have 3 flavors: +

-

Literal values are specified as a quoted strings:

+
    +
  • An integer byte offset
    • +
  • r for a random location
    • +
  • a for the end of the message
    • +
- 
"foo"
+ +

VALUE

-

Either single or double quotes are accepted, and quotes can be escaped with - backslashes within the string:

+

Literals

- 
'fo\'o'
+

Literal values are specified as a quoted strings:

-

Literal values can contain Python-style backslash escape sequences:

+ 
"foo"
- 
'foo\r\nbar'
- - -

Files

- -

You can load a value from a specified file path. To do so, you have to specify - a _staticdir_ option to pathod on the command-line, like so:

- - 
pathod -d ~/myassets
- -

All paths are relative paths under this directory. File loads are indicated by - starting the value specifier with the left angle bracket: - - 

<my/path

- -

The path value can also be a quoted string, with the same syntax as literals:

- - 
<"my/path"
- - -

Generated values

- -

An @-symbol lead-in specifies that generated data should be used. There are two - components to a generator specification - a size, and a data type. By default - pathod assumes a data type of "bytes".

- -

Here's a value specifier for generating 100 bytes: - - 

@100

- -

You can use standard suffixes to indicate larger values. Here, for instance, is - a specifier for generating 100 megabytes:

- - 
@100m
- -

Data is generated and served efficiently - if you really want to send a - terabyte of data to a client, pathod can do it. The supported suffixes are:

- - - - - - - - - - - - - - - - - - - - -
b 1024**0 (bytes)
k 1024**1 (kilobytes)
m 1024**2 (megabytes)
g 1024**3 (gigabytes)
t 1024**4 (terabytes)
- -

Data types are separated from the size specification by a comma. This - specification generates 100mb of ASCII:

- - 
@100m,ascii
- -

Supported data types are:

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
asciiAll ASCII characters
ascii_lettersA-Za-z
ascii_lowercasea-z
ascii_uppercaseA-Z
bytesAll 256 byte values
digits0-9
hexdigits0-f
octdigits0-7
punctuation - 
!"#$%&\'()*+,-./:;<=>?@[\\]^_`{|}~
-
whitespace - 
\t\n\x0b\x0c\r and space
-
+

+ Either single or double quotes are accepted, and quotes can be escaped with backslashes + within the string: +

+ + 
'fo\'o'
+ +

Literal values can contain Python-style backslash escape sequences:

+ + 
'foo\r\nbar'
+ +

Files

+ +

+ You can load a value from a specified file path. To do so, you have to specify a _staticdir_ + option to pathod on the command-line, like so: +

+ + 
pathod -d ~/myassets
+ +

+ All paths are relative paths under this directory. File loads are indicated by starting + the value specifier with the left angle bracket: +

+ + 
<my/path
+ +

The path value can also be a quoted string, with the same syntax as literals:

+ + 
<"my/path"
+ + +

Generated values

+ +

+ An @-symbol lead-in specifies that generated data should be used. There are two components + to a generator specification - a size, and a data type. By default pathod assumes + a data type of "bytes". +

+ +

Here's a value specifier for generating 100 bytes: + + 

@100
+

+ +

+ You can use standard suffixes to indicate larger values. Here, for instance, is a specifier + for generating 100 megabytes: +

+ + 
@100m
+ +

+ Data is generated and served efficiently - if you really want to send a terabyte of data + to a client, pathod can do it. The supported suffixes are: +

+ + + + + + + + + + + + + + + + + + + + + + + + +
b1024**0 (bytes)
k1024**1 (kilobytes)
m1024**2 (megabytes)
g1024**3 (gigabytes)
t1024**4 (terabytes)
+ +

+ Data types are separated from the size specification by a comma. This specification generates + 100mb of ASCII: +

+ + 
@100m,ascii
+ +

Supported data types are:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
asciiAll ASCII characters
ascii_lettersA-Za-z
ascii_lowercasea-z
ascii_uppercaseA-Z
bytesAll 256 byte values
digits0-9
hexdigits0-f
octdigits0-7
punctuation + 
!"#$%&\'()*+,-./:;
+                        <=>?@[\\]^_`{|}~
+
whitespace + 
\t\n\x0b\x0c\r and space
+
- {% endblock %} -- cgit v1.2.3 From 427e6d23ef76ab9f113bce1d17e6a7a8cddb275c Mon Sep 17 00:00:00 2001 From: Thomas Kriechbaumer Date: Fri, 26 Jun 2015 11:47:39 +0200 Subject: apply js-beautify changes selectivly --- libpathod/templates/docs_lang.html | 24 ++++++++++++------------ 1 file changed, 12 insertions(+), 12 deletions(-) (limited to 'libpathod/templates/docs_lang.html') diff --git a/libpathod/templates/docs_lang.html b/libpathod/templates/docs_lang.html index e3195939..a1d22aef 100644 --- a/libpathod/templates/docs_lang.html +++ b/libpathod/templates/docs_lang.html @@ -33,8 +33,8 @@

OFFSET

- Offsets are calculated relative to the base message, before any injections or other transforms - are applied. They have 3 flavors: + Offsets are calculated relative to the base message, before any injections or other + transforms are applied. They have 3 flavors:

    @@ -66,8 +66,8 @@

    Files

    - You can load a value from a specified file path. To do so, you have to specify a _staticdir_ - option to pathod on the command-line, like so: + You can load a value from a specified file path. To do so, you have to specify a + _staticdir_ option to pathod on the command-line, like so: 

    pathod -d ~/myassets
    @@ -88,8 +88,8 @@

    An @-symbol lead-in specifies that generated data should be used. There are two components - to a generator specification - a size, and a data type. By default pathod assumes - a data type of "bytes". + to a generator specification - a size, and a data type. By default pathod + assumes a data type of "bytes".

    Here's a value specifier for generating 100 bytes: @@ -98,15 +98,15 @@

    - You can use standard suffixes to indicate larger values. Here, for instance, is a specifier - for generating 100 megabytes: + You can use standard suffixes to indicate larger values. Here, for instance, is a + specifier for generating 100 megabytes: 

    @100m

    - Data is generated and served efficiently - if you really want to send a terabyte of data - to a client, pathod can do it. The supported suffixes are: + Data is generated and served efficiently - if you really want to send a terabyte + of data to a client, pathod can do it. The supported suffixes are:

    @@ -135,8 +135,8 @@

    - Data types are separated from the size specification by a comma. This specification generates - 100mb of ASCII: + Data types are separated from the size specification by a comma. This specification + generates 100mb of ASCII: 

    @100m,ascii
    -- cgit v1.2.3