From a5b40dc4a73873db96e096176b615992d8a50ab9 Mon Sep 17 00:00:00 2001 From: Toshi MARUYAMA Date: Mon, 20 Apr 2015 11:54:58 +0000 Subject: [PATCH] add English markdown wiki syntax help (#16373) Contributed by Go MAEDA. git-svn-id: http://svn.redmine.org/redmine/trunk@14189 e93f8b46-1217-0410-a6f0-8f06a7374b81 --- .../en/wiki_syntax_detailed_markdown.html | 329 ++++++++++++++++++ public/help/en/wiki_syntax_markdown.html | 82 +++++ 2 files changed, 411 insertions(+) create mode 100644 public/help/en/wiki_syntax_detailed_markdown.html create mode 100644 public/help/en/wiki_syntax_markdown.html diff --git a/public/help/en/wiki_syntax_detailed_markdown.html b/public/help/en/wiki_syntax_detailed_markdown.html new file mode 100644 index 000000000..bf87f5e68 --- /dev/null +++ b/public/help/en/wiki_syntax_detailed_markdown.html @@ -0,0 +1,329 @@ + + + +RedmineWikiFormatting (Markdown) + + + + + +

Wiki formatting (Markdown)

+ +

Links

+ +

Redmine links

+ +

Redmine allows hyperlinking between resources (issues, changesets, wiki pages...) from anywhere wiki formatting is used.

+ + +

Wiki links:

+ + + +

You can also link to pages of an other project wiki:

+ + + +

Wiki links are displayed in red if the page doesn't exist yet, eg: Nonexistent page.

+ +

Links to other resources:

+ + + + + + + + + + + + + + + + + + + +

Escaping:

+ + + + +

External links

+ +

HTTP URLs and email addresses are automatically turned into clickable links:

+ +
+http://www.redmine.org, someone@foo.bar
+
+ +

displays: http://www.redmine.org,

+ +

If you want to display a specific text instead of the URL, you can use the standard textile syntax:

+ +
+[Redmine web site](http://www.redmine.org)
+
+ +

displays: Redmine web site

+ + +

Text formatting

+ + +

For things such as headlines, bold, tables, lists, Redmine supports Textile syntax. See http://en.wikipedia.org/wiki/Textile_(markup_language) for information on using any of these features. A few samples are included below, but the engine is capable of much more of that.

+ +

Font style

+ +
+* **bold**
+* *Italic*
+* ***bold italic***
+* ~~strike-through~~
+
+ +

Display:

+ + + +

Inline images

+ + + +

Headings

+ +
+# Heading
+## Subheading
+### Subsubheading
+
+ +

Redmine assigns an anchor to each of those headings thus you can link to them with "#Heading", "#Subheading" and so forth.

+ + +

Blockquotes

+ +

Start the paragraph with >

+ +
+> Rails is a full-stack framework for developing database-backed web applications according to the Model-View-Control pattern.
+To go live, all you need to add is a database and a web server.
+
+ +

Display:

+ +
+

Rails is a full-stack framework for developing database-backed web applications according to the Model-View-Control pattern.
To go live, all you need to add is a database and a web server.

+
+ + +

Table of content

+ +
+{{toc}} => left aligned toc
+{{>toc}} => right aligned toc
+
+ +

Horizontal Rule

+ +
+---
+
+ +

Macros

+ +

Redmine has the following builtin macros:

+ +

+

+
hello_world
+

Sample macro.

+ +
macro_list
+

Displays a list of all available macros, including description if available.

+ +
child_pages
+

Displays a list of child pages. With no argument, it displays the child pages of the current wiki page. Examples:

+ 
{{child_pages}} -- can be used from a wiki page only
+{{child_pages(depth=2)}} -- display 2 levels nesting only
+ +
include
+

Include a wiki page. Example:

+ 
{{include(Foo)}}
+

or to include a page of a specific project wiki:

+ 
{{include(projectname:Foo)}}
+ +
collapse
+

Inserts of collapsed block of text. Example:

+ 
{{collapse(View details...)
+This is a block of text that is collapsed by default.
+It can be expanded by clicking a link.
+}}
+ +
thumbnail
+

Displays a clickable thumbnail of an attached image. Examples:

+ 
{{thumbnail(image.png)}}
+{{thumbnail(image.png, size=300, title=Thumbnail)}}
+
+

+ +

Code highlighting

+ +

Default code highlightment relies on CodeRay, a fast syntax highlighting library written completely in Ruby. It currently supports c, cpp, css, delphi, groovy, html, java, javascript, json, php, python, rhtml, ruby, scheme, sql, xml and yaml languages.

+ +

You can highlight code in your wiki page using this syntax:

+ +
+~~~ ruby
+  Place your code here.
+~~~
+
+ +

Example:

+ +
 1 # The Greeter class
+ 2 class Greeter
+ 3   def initialize(name)
+ 4     @name = name.capitalize
+ 5   end
+ 6
+ 7   def salute
+ 8     puts "Hello #{@name}!"
+ 9   end
+10 end
+
+ + diff --git a/public/help/en/wiki_syntax_markdown.html b/public/help/en/wiki_syntax_markdown.html new file mode 100644 index 000000000..c6f6eff5a --- /dev/null +++ b/public/help/en/wiki_syntax_markdown.html @@ -0,0 +1,82 @@ + + + + + +Wiki formatting + + + + +

Wiki Syntax Quick Reference (Markdown)

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Font Styles
Strong**Strong**Strong
Italic*Italic*Italic
Deleted~~Deleted~~Deleted
Inline Code`Inline Code`Inline Code
Preformatted text~~~
 lines
 of code
~~~		 +
+ lines
+ of code
+
+
Lists
Unordered list* Item 1
  * Sub
* Item 2
  • Item 1
    • Sub
  • Item 2
Ordered list1. Item 1
   1. Sub
2. Item 2
  1. Item 1
    1. Sub
  2. Item 2
Headings
Heading 1# Title 1

Title 1

Heading 2## Title 2

Title 2

Heading 3### Title 3

Title 3

Links
http://foo.barhttp://foo.bar
[Foo](http://foo.bar)Foo
Redmine links
Link to a Wiki page[[Wiki page]]Wiki page
Issue #12Issue #12
Revision r43Revision r43
commit:f30e13e43f30e13e4
source:some/filesource:some/file
Inline images
Image![](image_url)
![](attached_image)
Tables
| A | B | C |
|---|---|---|
| A | B | C |
| D | E | F |		 + + + + + + +
ABC
ABC
DEF
+
+ +

More Information

+ + + -- 2.39.5