From 9af2ba2c13d2dc706bdf1387110c13b82175a0cf Mon Sep 17 00:00:00 2001 From: Marius Balteanu Date: Wed, 11 Aug 2021 21:40:56 +0000 Subject: Adds CommonMark Markdown (GitHub Flavored) as third text formatting option (#32424). MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Patch by Jens Krämer. git-svn-id: http://svn.redmine.org/redmine/trunk@21156 e93f8b46-1217-0410-a6f0-8f06a7374b81 --- public/help/en/wiki_syntax_common_mark.html | 87 +++++ .../help/en/wiki_syntax_detailed_common_mark.html | 361 +++++++++++++++++++++ 2 files changed, 448 insertions(+) create mode 100644 public/help/en/wiki_syntax_common_mark.html create mode 100644 public/help/en/wiki_syntax_detailed_common_mark.html (limited to 'public/help/en') diff --git a/public/help/en/wiki_syntax_common_mark.html b/public/help/en/wiki_syntax_common_mark.html new file mode 100644 index 000000000..bda25b13b --- /dev/null +++ b/public/help/en/wiki_syntax_common_mark.html @@ -0,0 +1,87 @@ + + + +Wiki formatting + + + + +

Wiki Syntax Quick Reference (CommonMark Markdown (GitHub Flavored))

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Font Styles (more)
Strong**Strong**Strong
Italic*Italic*Italic
Deleted~~Deleted~~Deleted
Inline Code`Inline Code`Inline Code
Preformatted text```
 lines
 of code
```		 +
+ lines
+ of code
+
+
Highlighted code (more)
Highlighted code```ruby
3.times do
  puts 'Hello'
end
```		 +
3.times do
+  puts 'Hello'
+end
+
+
Line breaks and Paragraphs
An empty line

creates
a new paragraph.

An empty line

creates a new paragraph.

End a line with a backslash\
or two spaces to insert a manual line break.

End a line with a backslash
or two spaces to insert a manual line break.

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 (more)
Heading 1# Title 1

Title 1

Heading 2## Title 2

Title 2

Heading 3### Title 3

Title 3

Links (more)
www.foo.barwww.foo.bar
http://foo.barhttp://foo.bar
[Foo](http://foo.bar)Foo
Redmine links (more)
Link to a Wiki page[[Wiki page]]Wiki page
Issue #12Issue #12
##12Bug #12: The issue subject
Revision r43Revision r43
commit:f30e13e43f30e13e4
source:some/filesource:some/file
Inline images (more)
Image![](image_url)
![](attached_image)
Tables
| A | B | C |
|---|---|---|
| A | B | C |
| D | E | F |		 + + + + + + +
ABC
ABC
DEF
+
Raw HTML (more)
HTML is <del>not</del> <u>allowed</u>.HTML is not allowed. +
+ +

More Information

+ + + diff --git a/public/help/en/wiki_syntax_detailed_common_mark.html b/public/help/en/wiki_syntax_detailed_common_mark.html new file mode 100644 index 000000000..64198fd17 --- /dev/null +++ b/public/help/en/wiki_syntax_detailed_common_mark.html @@ -0,0 +1,361 @@ + + + +RedmineWikiFormatting (CommonMark Markdown (GitHub Flavored)) + + + + + +

Wiki formatting (CommonMark Markdown (GitHub Flavored))

+ + + +

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

+ +

URLs (starting with: www, http, https, ftp, ftps, sftp and sftps) 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 markdown syntax:

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

displays: Redmine web site

+ + +

Text formatting

+ +

For things such as headlines, bold, tables, lists, Redmine supports Markdown syntax according to CommonMark including some extensions commonly referred to as GitHub flavored Markdown. See the GitHub Flavored Markdown Spec 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)}}
+ +
issue
+

Inserts a link to an issue with flexible text. Examples:

+ 
{{issue(123)}}                              -- Issue #123: Enhance macro capabilities
+{{issue(123, project=true)}}                -- Andromeda - Issue #123:Enhance macro capabilities
+{{issue(123, tracker=false)}}               -- #123: Enhance macro capabilities
+{{issue(123, subject=false, project=true)}} -- Andromeda - Issue #123
+
+

+ +

Code highlighting

+ +

Default code highlighting relies on Rouge, a syntax highlighting library written in pure Ruby. It supports many commonly used languages such as c, cpp (c++), csharp (c#, cs), css, diff (patch, udiff), go (golang), groovy, html, java, javascript (js), kotlin, objective_c (objc), perl (pl), php, python (py), r, ruby (rb), sass, scala, shell (bash, zsh, ksh, sh), sql, swift, xml and yaml (yml) languages, where the names inside parentheses are aliases. Please refer to https://www.redmine.org/projects/redmine/wiki/RedmineCodeHighlightingLanguages for the full list of supported languages.

+ +

You can highlight code at any place that supports wiki formatting using this syntax (note that the language name or alias is case-insensitive):

+ +
+```ruby
+  Place your code here.
+```
+
+ +

Example:

+ +
# The Greeter class
+class Greeter
+  def initialize(name)
+    @name = name.capitalize
+  end
+
+  def salute
+    puts "Hello #{@name}!"
+  end
+end
+
+ +

Raw HTML

+ +

You may use raw HTML for more complex formatting tasks, i.e. complex tables with cells spanning multiple rows or columns:

+ + 

+    <table width="50%">
+      <tr><td rowspan="2">Two rows</td><td>foo</td></tr>
+      <tr><td>bar</td></tr>
+      <tr><td align="center" colspan="2">bar</td></tr>
+    </table>
+
+ +

yields

+ + + + + +
Two rowsfoo
bar
bar
+ + + + -- cgit v1.2.3