summaryrefslogtreecommitdiff
path: root/help/WikiCodeHelp.md
blob: c0d3484a538a1fc87a93631ac6166f2cc616d13c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
---
page: htroot/WikiCodeHelp.html
help: help/WikiCodeHelp.md
title: WikiCode Help
package: content-apps
access: public
kind: ui-page
backend_java: source/net/yacy/htroot/WikiCodeHelp.java
---

# WikiCode Help

## Purpose

WikiCode Help documents the formatting still used by messages, profiles, and MediaWiki dump imports.

Use it when composing content in one of those remaining WikiCode-enabled fields.

## What You Can Do Here

- WikiCode Help explains the remaining reusable formatting syntax.
- Compare markup examples with their rendered output.
- Return to the message or profile form where the formatted content is edited.

## Page Architecture

This is a read-only syntax reference. The local Wiki application and its page store have been retired.

## Correct Use

Use this page as a syntax reference. Editing and saving happen in the calling message or profile page, not in this help page.

## Access And Safety

The page is normally public or read-only, unless the peer is configured to require authentication for all pages.

## Automation And API

Page backend: `source/net/yacy/htroot/WikiCodeHelp.java`.

No request parameters are needed for normal use of this page.

## What To Expect

Expect a static table of supported WikiCode constructs and their rendered forms. No content is stored by this page.

## Related Pages

- `MessageSend_p.html`
- `ConfigProfile_p.html`
- `mediawiki_p.html`