Feature #32169

Add links to the detailed Wiki formatting help in Quick Reference

Added by Go MAEDA 3 months ago. Updated 2 months ago.

Status:ClosedStart date:
Priority:NormalDue date:
Assignee:Go MAEDA% Done:

0%

Category:Documentation
Target version:4.1.0
Resolution:Fixed

Description

The attached patch adds links to the detailed Wiki formatting help in Quick Reference.

Currently, there is only one link to the detailed help in Quick Reference. The link is placed at the bottom of the page, so it is not prominent. Some users don't know that they can read the detailed help.

This patch improves the accessibility to the detailed help by adding a link on each section header in Quick Reference. The user is navigated to the corresponding section in the detailed help when they click the link.

Links in Quick Reference. You can find "more" in the section title:

For example, when you click "more" next to "Font style", you will be navigated to "Text formatting" section in the detailed help:

detailed-ref-text-formatting-section@2x.png (20 KB) Go MAEDA, 2019-09-29 12:33

link-in-quick-ref@2x.png (109 KB) Go MAEDA, 2019-09-29 12:34

0001-Add-links-to-the-detailed-Wiki-formatting-help-in-Qu.patch Magnifier (427 KB) Go MAEDA, 2019-09-29 12:42

fix-link-destination.diff Magnifier (240 KB) Go MAEDA, 2019-10-08 09:42

Associated revisions

Revision 18571
Added by Go MAEDA 3 months ago

Add links to the detailed Wiki formatting help in Quick Reference (#32169).

Patch by Go MAEDA.

Revision 18572
Added by Go MAEDA 3 months ago

Fix wrong markup in public/help/ja/wiki_syntax_detailed_(markdown|textile).html (#32169).

Patch by Go MAEDA.

Revision 18625
Added by Go MAEDA 2 months ago

Fix wong link destinations in wiki_syntax_markdown.html (#32169).

History

#1 Updated by Go MAEDA 3 months ago

  • Assignee set to Go MAEDA
  • Target version changed from Candidate for next major release to 4.1.0

Setting the target version to 4.1.0.

#2 Updated by Go MAEDA 3 months ago

  • Status changed from New to Closed
  • Resolution set to Fixed

Committed the patch.

#3 Updated by Mizuki ISHIKAWA 2 months ago

The link of a.more_info of wiki_syntax_markdown.html is wiki_syntax_detailed_textile.html.
I think it should be wiki_syntax_detailed_markdown.html.

#4 Updated by Go MAEDA 2 months ago

#5 Updated by Go MAEDA 2 months ago

  • Status changed from Reopened to Closed

Mizuki ISHIKAWA wrote:

The link of a.more_info of wiki_syntax_markdown.html is wiki_syntax_detailed_textile.html.
I think it should be wiki_syntax_detailed_markdown.html.

Fixed in r18625. Thank you.

Also available in: Atom PDF