Feature #16373
closed
TextFormatting help for Markdown formatting
Added by Ofer Nave over 10 years ago. Updated over 8 years ago.
0%
Description
Just recently became a Redmine user/administrator. Started with 2.4.2, but upgrading to 2.5.0 yesterday once I learned about the new Markdown support in the core: #15520
Shortly after, I started editing wiki pages and attempted to add an inline image for the first time using the syntax documented here:
RedmineTextFormatting#Inline-images
However, the markup ("!new_project.png!") ends up rendered as plain-text, rather than being replaced by the inline image of the same name which I attached to the same Wiki page.
I then went to the Redmine Demo to confirm that I am in, in fact, doing it right:
http://demo.redmine.org/projects/test-of-in-lining-images-in-wiki/wiki/Wiki
So, I suspect this has something to do with changing my setting to Markdown. I'm attaching a screenshot showing the results of my failed attempt.
From the admin info page:
Redmine 2.5.0.stable.12980
Environment:
Redmine version 2.5.0.stable.12980
Ruby version 1.9.3-p484 (2013-11-22) [x86_64-linux]
Rails version 3.2.17
Environment production
Database adapter Mysql2
Redmine plugins:
no plugin installed
Files
| Screenshot from 2014-03-18 02_12_57.png (47 KB) Screenshot from 2014-03-18 02_12_57.png | Ofer Nave, 2014-03-18 07:13 | ||
| wiki_syntax_md.html (4.5 KB) wiki_syntax_md.html | Markdown version of wiki_syntax.html | Go MAEDA, 2015-03-09 13:00 | |
| wiki_syntax_detailed_md.html (14.1 KB) wiki_syntax_detailed_md.html | Markdown version of wiki_syntax_detailed.html | Go MAEDA, 2015-03-22 06:37 | |
| markdown_help.diff.gz (230 KB) markdown_help.diff.gz | patch to add Markdown help (please apply with -E option) | Go MAEDA, 2015-03-22 14:34 | |
| 0001-Remove-remaining-textile-refs-from-_detailed_markdow.patch (111 KB) 0001-Remove-remaining-textile-refs-from-_detailed_markdow.patch | Mischa The Evil, 2015-07-12 11:39 |
Related issues
Updated by Jean-Philippe Lang over 10 years ago
- Tracker changed from Defect to Feature
- Subject changed from Wiki inline images broken with Markdown to TextFormatting help for Markdown formatting
- Category changed from Wiki to Documentation
The markup you're using (!new_project.png!) is a Textile markup. If you want to use Markdown, you'll have to use the Markdown markup for that, eg. .
Part of the documentation available in RedmineTextFormatting is specific to textile formatting. We should split it and add Markdown examples.
Updated by Ofer Nave over 10 years ago
Ah, I see. I had read somewhere that the syntax for linking to internal objects was Redmine-specific, so I assume that meant independant of wiki syntax. (For example, the syntax for inlining an external image still works the same after the changeover.)
I just tested it to confirm this, and it's working. Thanks!
Updated by Jean-Philippe Lang over 10 years ago
Yes, internal linking syntax does not depend on text formatting setting. The documentation should explain that.
Thanks for your feedback.
Updated by Go MAEDA over 9 years ago
- Has duplicate Feature #16086: Markdown syntax help button in toolbar is needed. added
Updated by Go MAEDA over 9 years ago
- File wiki_syntax_md.html wiki_syntax_md.html added
I have written Markdown version of wiki_syntax.html.
I am going to deal with wiki_syntax_detailed.html too in a few days.
Updated by Go MAEDA over 9 years ago
Markdown version of wiki_syntax_detailed.html.
Updated by Go MAEDA over 9 years ago
- File markdown_help.diff.gz markdown_help.diff.gz added
I have created a patch to add Markdown help.
You will be able to see appropriate version of help for the active markup.
Updated by Toshi MARUYAMA over 9 years ago
- Status changed from New to Closed
- Resolution set to Fixed
Updated by Mischa The Evil over 9 years ago
- File 0001-Remove-remaining-textile-refs-from-_detailed_markdow.patch 0001-Remove-remaining-textile-refs-from-_detailed_markdow.patch added
- Status changed from Closed to Reopened
There are still five textile references left in the new *_detailed_markdown.html files. The attached patch fixes them. The patch is created against source:/trunk@14420 and can be applied using "patch -p1 < 0001...".
Updated by dezhi xiong over 9 years ago
Hi @Go MAEDA, I can see this syntax help link within the official redmine issue editor. But there's no link in my own deploy. Is this link only available in the official site?
Updated by Go MAEDA over 9 years ago
dezhi xiong wrote:
Hi @Go MAEDA, I can see this syntax help link within the official redmine issue editor. But there's no link in my own deploy. Is this link only available in the official site?
Markdown help will be available in Redmine 3.1.0 (not yet released). Please wait 3.1.0 or consider overwriting public/help/*/wiki_syntax.html and public/help/*/wiki_syntax_detailed.html on your installation with wiki_syntax_md.html and wiki_syntax_detailed_md.html.
Updated by Jean-Philippe Lang over 9 years ago
- Status changed from Reopened to Closed
- Assignee set to Jean-Philippe Lang
Patch committed, thanks.
Updated by dumb blob over 9 years ago
In the discussion starting with http://www.redmine.org/issues/15520#note-11 there was a revelation of Redmine having a special Markdown flavour, not standard Markdown. This should be visibly emphasized at the beginning of the documentation and in the settings, the name shouldn't be Markdown any more, but rather Redmine Markdown indicating it's a non-standard Markdown/CommonMark flavour.
Also if you really decide in the end, that HTML will be disabled, this should be also emphasized in the Redmine Markdown help, because it's another major divergence from the standard Markdown/CommonMark.
Updated by Go MAEDA over 9 years ago
dumb blob, this issue and #15520 are closed.
It would be better to create a new issue if you want to discuss support of inline HTML.
Updated by Hiroo Hayashi over 8 years ago
Updated by Toshi MARUYAMA over 8 years ago
Hiroo Hayashi wrote:
Could you update http://www.redmine.org/projects/redmine/wiki/RedmineTextFormattingMarkdown page, too?
You can edit it.
Updated by Hiroo Hayashi over 8 years ago
Maruyama-san,
You can edit it.
Yes, I can.
But I only have wiki_syntax_detailed_md.html. I think it must be generated from a Textile source code.
If you send it to me, I am glad to replace http://www.redmine.org/projects/redmine/wiki/RedmineTextFormattingMarkdown page with it.
Thank you.
Updated by Toshi MARUYAMA over 8 years ago
Hiroo Hayashi wrote:
Maruyama-san,
You can edit it.
Yes, I can.
But I only have wiki_syntax_detailed_md.html. I think it must be generated from a Textile source code.
If you send it to me,
What do you mean?
Updated by Hiroo Hayashi over 8 years ago
But I only have wiki_syntax_detailed_md.html. I think it must be generated from a Textile source code.
If you send it to me, I am glad to replace http://www.redmine.org/projects/redmine/wiki/RedmineTextFormattingMarkdown page with it.What do you mean?
We need a Textile source code (text) to update http://www.redmine.org/projects/redmine/wiki/RedmineTextFormattingMarkdown which is written in Textile.
Without the textile text I have to convert wiki_syntax_detailed_md.html written in HTML to Textile.
I hope this makes sense for you.
Updated by Toshi MARUYAMA over 8 years ago
I don't know RedmineTextFormattingMarkdown status.
If you think it is not synced with source:trunk/public/help/en/wiki_syntax_detailed_markdown.html@15715 ,
You can edit it manually.
Updated by Hiroo Hayashi over 8 years ago
Maruyama-san,
If you think it is not synced with source:trunk/public/help/en/wiki_syntax_detailed_markdown.html@15715 ,
It is not sync-ed at a glance.
But I understand the situation by checking history of source:trunk/public/help/en/wiki_syntax_detailed_markdown.html.
I thought Maeda-san attached wiki_syntax_detailed_md.html which was converted from textile.
But you are maintaining the two same contents separately.
I'll try to sync the wiki page with the HTML. Give me some time.
Updated by Hiroo Hayashi over 8 years ago
I'll try to sync the wiki page with the HTML. Give me some time.
Before doing this, I've found we have to sync source:trunk/public/help/en/wiki_syntax_detailed_textile.html with RedmineTextFormattingTextile.
As far as I took a look, RedmineTextFormattingTextile is most maintained. I am going to use RedmineTextFormattingTextile as a master file.
I will sync the Textile helps first. Then I will sync the Markdown helps with the Textile helps.
Updated by Hiroo Hayashi over 8 years ago
I've updated RedmineTextFormattingTextile first. Please double-check.
- changes to be more consistent. (displays, Display, Displays -> displays, etc.)
- merge some lines which were only in source:trunk/public/help/en/wiki_syntax_detailed_textile.html
The section Redmine Links is common to RedmineTextFormattingTextile and RedmineTextFormattingMarkdown (according to the current documents. I have not test most of them in Markdown mode.)
So I'd like to propose the following change to sync each other. Do you see any concern or problem?
- create a wiki page RedmineTextFormattingRedmineLinks.
- Move the section "Redmine Links" into the new wiki page.
- let RedmineTextFormattingTextile and RedmineTextFormattingMarkdown include the new wiki page
Updated by Hiroo Hayashi over 8 years ago
So I'd like to propose the following change to sync each other. Do you see any concern or problem?
- create a wiki page RedmineTextFormattingRedmineLinks.
- Move the section "Redmine Links" into the new wiki page.
- let RedmineTextFormattingTextile and RedmineTextFormattingMarkdown include the new wiki page
I've made these changes.
Updated by Hiroo Hayashi over 8 years ago
I've updated RedmineTextFormattingTextile and RedmineTextFormattingMarkdown.
RedmineTextFormattingTextile¶
- Rename the section "Predefined" to "Preformatted Text"
- Add preformatted texts to the section "Paragraphs".
RedmineTextFormattingMarkdown¶
- sync with RedmineTextFormattingTextile
Please double check.
Updated by Go MAEDA over 8 years ago
This issue is closed. Please create a new issue for a new topic.
Updated by Hiroo Hayashi over 8 years ago
This issue is closed. Please create a new issue for a new topic.
I've opened #23413.