From: Toshi MARUYAMA Date: Thu, 8 Aug 2013 03:38:21 +0000 (+0000) Subject: move English wiki syntax helps to en sub directory (#14630) X-Git-Tag: 2.4.0~149 X-Git-Url: https://source.dussan.org/?a=commitdiff_plain;h=7394aeaa32d5496bc98520951fdae16722efc2e0;p=redmine.git move English wiki syntax helps to en sub directory (#14630) git-svn-id: svn+ssh://rubyforge.org/var/svn/redmine/trunk@12093 e93f8b46-1217-0410-a6f0-8f06a7374b81 --- diff --git a/lib/redmine/wiki_formatting/textile/helper.rb b/lib/redmine/wiki_formatting/textile/helper.rb index 28accb59f..86b95b309 100644 --- a/lib/redmine/wiki_formatting/textile/helper.rb +++ b/lib/redmine/wiki_formatting/textile/helper.rb @@ -22,7 +22,7 @@ module Redmine def wikitoolbar_for(field_id) heads_for_wiki_formatter # Is there a simple way to link to a public resource? - url = "#{Redmine::Utils.relative_url_root}/help/wiki_syntax.html" + url = "#{Redmine::Utils.relative_url_root}/help/en/wiki_syntax.html" javascript_tag("var wikiToolbar = new jsToolBar(document.getElementById('#{field_id}')); wikiToolbar.setHelpLink('#{escape_javascript url}'); wikiToolbar.draw();") end diff --git a/public/help/en/wiki_syntax.html b/public/help/en/wiki_syntax.html new file mode 100644 index 000000000..a92720b4d --- /dev/null +++ b/public/help/en/wiki_syntax.html @@ -0,0 +1,66 @@ + + + + + +Wiki formatting + + + + +

Wiki Syntax Quick Reference

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Font Styles
Strong*Strong*Strong
Italic_Italic_Italic
Underline+Underline+Underline
Deleted-Deleted-Deleted
??Quote??Quote
Inline Code@Inline Code@Inline Code
Preformatted text<pre>
 lines
 of code
</pre>		 +
+ lines
+ of code
+
+
Lists
Unordered list* Item 1
* Item 2
  • Item 1
  • Item 2
Ordered list# Item 1
# Item 2
  1. Item 1
  2. Item 2
Headings
Heading 1h1. Title 1

Title 1

Heading 2h2. Title 2

Title 2

Heading 3h3. Title 3

Title 3

Links
http://foo.barhttp://foo.bar
"Foo":http://foo.barFoo
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!
+ +

More Information

+ + + diff --git a/public/help/en/wiki_syntax_detailed.html b/public/help/en/wiki_syntax_detailed.html new file mode 100644 index 000000000..2ddd2fdf5 --- /dev/null +++ b/public/help/en/wiki_syntax_detailed.html @@ -0,0 +1,287 @@ + + + +RedmineWikiFormatting + + + + + +

Wiki formatting

+ +

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*_
+* +underline+
+* -strike-through-
+
+ +

Display:

+ + + +

Inline images

+ + + +

Headings

+ +
+h1. Heading
+h2. Subheading
+h3. Subsubheading
+
+ +

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

+ + +

Paragraphs

+ +
+p>. right aligned
+p=. centered
+
+ +

This is a centered paragraph.

+ + +

Blockquotes

+ +

Start the paragraph with bq.

+ +
+bq. 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.

include

Include a wiki page. Example:

+ + 
{{include(Foo)}}
macro_list

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

+ + +

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:

+ +
+<pre><code class="ruby">
+  Place you code here.
+</code></pre>
+
+ +

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/wiki_syntax.html b/public/help/wiki_syntax.html deleted file mode 100644 index a92720b4d..000000000 --- a/public/help/wiki_syntax.html +++ /dev/null @@ -1,66 +0,0 @@ - - - - - -Wiki formatting - - - - -

Wiki Syntax Quick Reference

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Font Styles
Strong*Strong*Strong
Italic_Italic_Italic
Underline+Underline+Underline
Deleted-Deleted-Deleted
??Quote??Quote
Inline Code@Inline Code@Inline Code
Preformatted text<pre>
 lines
 of code
</pre>		 -
- lines
- of code
-
-
Lists
Unordered list* Item 1
* Item 2
  • Item 1
  • Item 2
Ordered list# Item 1
# Item 2
  1. Item 1
  2. Item 2
Headings
Heading 1h1. Title 1

Title 1

Heading 2h2. Title 2

Title 2

Heading 3h3. Title 3

Title 3

Links
http://foo.barhttp://foo.bar
"Foo":http://foo.barFoo
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!
- -

More Information

- - - diff --git a/public/help/wiki_syntax_detailed.html b/public/help/wiki_syntax_detailed.html deleted file mode 100644 index 2ddd2fdf5..000000000 --- a/public/help/wiki_syntax_detailed.html +++ /dev/null @@ -1,287 +0,0 @@ - - - -RedmineWikiFormatting - - - - - -

Wiki formatting

- -

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*_
-* +underline+
-* -strike-through-
-
- -

Display:

- - - -

Inline images

- - - -

Headings

- -
-h1. Heading
-h2. Subheading
-h3. Subsubheading
-
- -

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

- - -

Paragraphs

- -
-p>. right aligned
-p=. centered
-
- -

This is a centered paragraph.

- - -

Blockquotes

- -

Start the paragraph with bq.

- -
-bq. 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.

include

Include a wiki page. Example:

- - 
{{include(Foo)}}
macro_list

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

- - -

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:

- -
-<pre><code class="ruby">
-  Place you code here.
-</code></pre>
-
- -

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
-
- -