[GHC] #10342: Convert User Guide from DocBook to AsciiDoc
#10342: Convert User Guide from DocBook to AsciiDoc -------------------------------------+------------------------------------- Reporter: dmbergey | Owner: dmbergey Type: task | Status: new Priority: normal | Milestone: Component: | Version: 7.10.1 Documentation | Operating System: Unknown/Multiple Keywords: | Type of failure: None/Unknown Architecture: | Blocked By: Unknown/Multiple | Related Tickets: Test Case: | Blocking: | Differential Revisions: | -------------------------------------+------------------------------------- See initial proposal and discussion on the mailing list: https://mail.haskell.org/pipermail/ghc-devs/2014-October/006599.html and the more recent call for volunteers: https://ghc.haskell.org/trac/ghc/blog/weekly20150414 Quoting the latter: the idea [is] that it will A) make life easier for people who frequently modify the users guide, and B) make life easier for people who add things irregularly, as a lower barrier to entry. I expect that asciidoc & DocBook can coexist while I work on this. After the initial changes to the build system, the docbook-to-HTML phase should read both the asciidoc-generated XML and the not-yet-converted XML files. This ticket will track progress on the task, as I plan to submit multiple patches, perhaps as many as one per file converted. -- Ticket URL: http://ghc.haskell.org/trac/ghc/ticket/10342 GHC http://www.haskell.org/ghc/ The Glasgow Haskell Compiler
#10342: Convert User Guide from DocBook to AsciiDoc -------------------------------------+------------------------------------- Reporter: dmbergey | Owner: dmbergey Type: task | Status: new Priority: normal | Milestone: Component: Documentation | Version: 7.10.1 Resolution: | Keywords: Operating System: Unknown/Multiple | Architecture: Type of failure: Documentation | Unknown/Multiple bug | Test Case: Blocked By: | Blocking: Related Tickets: | Differential Revisions: -------------------------------------+------------------------------------- Comment (by bgamari): I have looked into this in the past and found that asciidoc has a few rough edges that make a * conversion of the users guide rather ugly. I recently tried a conversion to ReStructuredText and was happy to find that a mostly mechanical conversion got quite far. I've proposed moving to ReStructuredText in [[https://mail.haskell.org/pipermail/ghc-devs/2015-September/010001.html this mailing list thread]] (which references my preliminary conversion). -- Ticket URL: http://ghc.haskell.org/trac/ghc/ticket/10342#comment:2 GHC http://www.haskell.org/ghc/ The Glasgow Haskell Compiler
#10342: Convert User Guide from DocBook to AsciiDoc -------------------------------------+------------------------------------- Reporter: dmbergey | Owner: dmbergey Type: task | Status: new Priority: normal | Milestone: Component: Documentation | Version: 7.10.1 Resolution: | Keywords: Operating System: Unknown/Multiple | Architecture: Type of failure: Documentation | Unknown/Multiple bug | Test Case: Blocked By: | Blocking: Related Tickets: | Differential Revisions: -------------------------------------+------------------------------------- Comment (by bgamari): I have started a [[https://ghc.haskell.org/trac/ghc/wiki/UsersGuide/MoveFromDocBook|page]] to describe this change. -- Ticket URL: http://ghc.haskell.org/trac/ghc/ticket/10342#comment:3 GHC http://www.haskell.org/ghc/ The Glasgow Haskell Compiler
#10342: Convert User Guide from DocBook to AsciiDoc -------------------------------------+------------------------------------- Reporter: dmbergey | Owner: dmbergey Type: task | Status: new Priority: normal | Milestone: Component: Documentation | Version: 7.10.1 Resolution: | Keywords: Operating System: Unknown/Multiple | Architecture: Type of failure: Documentation | Unknown/Multiple bug | Test Case: Blocked By: | Blocking: Related Tickets: | Differential Revisions: -------------------------------------+------------------------------------- Comment (by thomie): Don't forget to update `utils/mkUserGuidePart`. -- Ticket URL: http://ghc.haskell.org/trac/ghc/ticket/10342#comment:4 GHC http://www.haskell.org/ghc/ The Glasgow Haskell Compiler
#10342: Convert User Guide from DocBook to AsciiDoc -------------------------------------+------------------------------------- Reporter: dmbergey | Owner: dmbergey Type: task | Status: closed Priority: normal | Milestone: 8.0.1 Component: Documentation | Version: 7.10.1 Resolution: fixed | Keywords: Operating System: Unknown/Multiple | Architecture: Type of failure: Documentation | Unknown/Multiple bug | Test Case: Blocked By: | Blocking: Related Tickets: | Differential Rev(s): -------------------------------------+------------------------------------- Changes (by thomie): * status: new => closed * resolution: => fixed * milestone: => 8.0.1 Comment: In 4fd6207ec6960c429e6a1bcbe0282f625010f52a: {{{ Author: Ben Gamari <> Date: Thu Oct 1 01:08:41 2015 +0200 Move user's guide to ReStructuredText }}} -- Ticket URL: http://ghc.haskell.org/trac/ghc/ticket/10342#comment:5 GHC http://www.haskell.org/ghc/ The Glasgow Haskell Compiler
participants (1)
-
GHC