Home > Authoring > Guide > Syntax
Here is a complete list of special markers that can be added or embedded in a Markdown source file that is preprocessed by PREPRO tools, a set of perl scripts written for Markdown authoring.
See documentation: Japanese English
Documentation: Japanese English
| Syntax | Marker | Description | Example | Script |
|---|---|---|---|---|
| !@path! | File include | Loads a local file | !@/var/www/data/caution.txt! | Include |
| !%url! | URL download | Loads remote content | !%https://example.com/data/ad.txt! | Include |
Documentation: Japanese English
| Syntax | Marker | Description | Example | Script |
|---|---|---|---|---|
| /lang/ | Language selector | Starts a passage for language lang. | /ja/ ... /en/ ... /end/ | Selector |
| /.version/ | Version selector | Starts a passage for version. | /.debian/ ... /.centos/ ... /end/ | Selector |
| /end/ | End of selector | Ends passage selection | /en/ ... /end/ | Selector |
Documentation: Japanese English
| Syntax | Marker | Description | Example | Script |
|---|---|---|---|---|
| {class} | Style marker | Starts an HTML div block with stylesheet class class | {right} ... {end} | Style |
| {end} | End of style marker | Ends the previously output HTML div block | {right} ... {end} | Style |
Documentation: Japanese English
| Syntax | Marker | Description | Example | Script |
|---|---|---|---|---|
| !draw! | Draw marker | Starts draw instruction block | !draw! ... !end! | Draw |
| !end! | End of draw marker | Ends draw instruction block | !draw! ... !end! | Draw |
| Shape | Represents: |
|---|---|
| box | Hardware such as PC or server |
| ball | software or process (shown as a rugby ball) |
| paper | File or resource |
| disk | File system or folder |
| ~ | Blank |
| Hand | Direction |
|---|---|
| - | Right |
| | | Down |
| + | Right and Down |
| ~ | No line |
| Syntax | Macro | Description | Example | Script |
|---|---|---|---|---|
| ${var} | Environment variable | Value of environment variable | Home: ${HOME} | HereDoc |
| $var | Same as above | Home: $HOME | HereDoc | |
| $(cmd) | Command output | Command output | Date: $(date) | HereDoc |
| `cmd` | Same as above | Date: `date` | HereDoc |
Note: For security reason, this preprocessor is not available in the Markdown hosting service. You can use this processor by yourself by downloading the source code from github.
Documentation: Japanese English
| Syntax | Macro | Description | Example |
|---|---|---|---|
| $(var) | Display variable | Value of data variable | Price: $(price) |
| $(?var) | Entry variable | HTML input tag for data variable | Phone: $(?phone) |
| $(??var) | Required entry variable | HTML input tag for data variable which must be entered | Enter address: $(??address) |
| $(!action) | Action Macro | HTML button to perform action | $(!delete) |
| $(.var) | Page variable | Read-only page-related variable | $(.account) |
| $(+name[=value]) | Hidden parameter | Hidden form parameter | $(+discount=true) |
| Input type | Description | HTML | Remark | |--|--|--| | text | Text field | <input type="text"... | Default |
| Action | Description |
|---|---|
| add | Add a new row with specified values of columns |
| update | Modify a row with values of columns |
| delete | Delete a row |
| edit | Reload page for editing a row |
| reset | Reload page for adding a new row |
| Page Variable | Description |
|---|---|
| Email address if logged in or ticket passed | |
| account | Account name of the page |
| table | Table name being accessed |
| lang | Language being selected |
| action | Table action |
| datetime | Current local date and time |
Presented by Kobu.Com
2020-oct-05 written
2020-oct-15 updated