[Scummvm-tracker] [ScummVM :: Bugs] #10938: MAC OS X: Help Menu’s links unresponsive for README.md & NEWS.md files.

ScummVM :: Bugs trac at scummvm.org
Sat Apr 20 18:26:46 CEST 2019


#10938: MAC OS X: Help Menu’s links unresponsive for README.md & NEWS.md files.
---------------------+----------------------------
  Reporter:  macca8  |      Owner:  criezy
      Type:  defect  |     Status:  new
  Priority:  normal  |  Component:  Port: Mac OS X
Resolution:          |   Keywords:
      Game:          |
---------------------+----------------------------

Comment (by criezy):

 While looking at this, I am also looking at improving the README we get
 from the Help menu when pandoc is present. Currently pandoc converts the
 markdown file to plain text. This is what we had before switching the file
 to markdown, but we can probably do better now.

 One possibility would be to generate a RTF file instead of plain text,
 which would give us a nice formatting. However it seems that TextEdit does
 not support having links to bookmark within the document, so while I can
 generate a nicely formatted RTF, the TOC does not have links, which is a
 shame.

 Another options would be to use html, and use a web browser instead of
 TextEdit to open the file. With this option we do get links in the TOC.
 This file would be present locally, so it would not require having
 internet access.

 Do you have a preference between the Help menu opening a README RTF
 document with no link in the table of content (but external links work
 properly), and a HTML document with properly working links in the table of
 content?

 For reference in case I forget, if we want to generate RTF file we need to
 use pandoc to generate html first, and then textutil to generate the RTF
 file. In theory pandoc can output rtf directly, but it gives a file that
 cannot be properly displayed in TextEdit.

-- 
Ticket URL: <https://bugs.scummvm.org/ticket/10938#comment:5>
ScummVM :: Bugs <https://bugs.scummvm.org>
ScummVM


More information about the Scummvm-tracker mailing list