bugGNU Octave - Bugs: bug #41585, doc: Info manual displays dashed...

 
 

bug #41585: doc: Info manual displays dashed line style incorrectly

Submitted by:  Mike Miller <mtmiller>
Submitted on:  Fri 14 Feb 2014 12:27:10 AM UTC  
 
Category: DocumentationSeverity: 3 - Normal
Priority: 5 - NormalItem Group: Documentation
Status: FixedAssigned to: None
Originator Name: Open/Closed: Closed
Release: devOperating System: Any

Add a New Comment(Rich Markup)
   

You are not logged in

Please log in, so followups can be emailed to you.

 

(Jump to the original submission Jump to the original submission)

Sun 16 Feb 2014 09:07:16 PM UTC, comment #6:

Thanks, that change fixes it for me, looks good in all formats now.

Mike Miller <mtmiller>
Project Administrator
Sun 16 Feb 2014 08:52:06 PM UTC, comment #5:

This was an oversight of how I coded the hack. I used @ifinfo , which only caught the Info case, and @iftex, which only caught the tex case. I tweaked the changeset to use @ifnottex which will capture Info, HTML, and all other formats and then use the @verb syntax. The disappearing double quotes were caused by an oddity with @verb in that it does not use the '{}' characters to define the boundaries of the macro like everything else in Texinfo. I fixed that too.

It's all in this changeset (http://hg.savannah.gnu.org/hgweb/octave/rev/d39fd728ddef). I'll let you test it and close the report since I can't seem to be trusted.

Rik <rik5>
Project Administrator
Sun 16 Feb 2014 07:37:47 PM UTC, comment #4:

Unfortunately that has some bad side effects, at least with Texinfo 5.2. Do you see the same with Texinfo 4.13 or does it render correctly in both Info and HTML for you?

I now see this in the Info format, no quotes around the double-hyphen:

while the HTML format manual shows no hyphens at all now:

The DVI, PDF, and PS formats look correct now as before.

Mike Miller <mtmiller>
Project Administrator
Sun 16 Feb 2014 06:29:39 PM UTC, comment #3:

This problem isn't present on stable since I changed to using the @qcode macro only in the gui-release version and beyond. I fixed the issue (Texinfo helpfully collapses '--' to '-' to mimic an en-dash) in this changeset (http://hg.savannah.gnu.org/hgweb/octave/rev/2b01c11197d6).

Rik <rik5>
Project Administrator
Sun 16 Feb 2014 03:39:35 PM UTC, comment #2:

I'm seeing it in subsection Line Styles, so 'doc "line styles"'. The source has a @table @code, containing a @table @asis, containing an @item @qcode. The double hyphens are being rendered as a single hyphen in info format.

Mike Miller <mtmiller>
Project Administrator
Sat 15 Feb 2014 04:34:31 PM UTC, comment #1:

Where are you seeing this? Is it from the command line with 'doc plot'?

Taking a look at plot.m I see

which looks to be correct Texinfo and renders correctly with 4.13.

Texinfo 5.2 has had all sorts of differences with the 4.X branch. I wonder if they somehow aren't recognizing the @samp command and are transmuting '--' to an en-dash.

From the Texinfo documentation

@samp should very definitely be a literal context, but maybe this is buggy in 5.2. You could try replacing the @samp with @code in plot.m and see if the problem goes away. Even if it does, I'm not sure that the fix doesn't belong in Texinfo rather than in Octave.

Rik <rik5>
Project Administrator
Fri 14 Feb 2014 12:27:10 AM UTC, original submission:

The info format manual built from the current default branch displays the dashed line style incorrectly:

This is clearly wrong. The HTML manual displays two hyphens as expected. I think this has something to do with interaction between @table @code, @table @asis, and @item @qcode. I'm building with Texinfo 5.2.

This does not affect the 3.8.0 release or the stable branch.

Mike Miller <mtmiller>
Project Administrator

 

(Note: upload size limit is set to 16384 kB, after insertion of the required escape characters.)

Attach File(s):
   
   
Comment:
   

No files currently attached

 

Depends on the following items: None found

Items that depend on this one: None found

 

Carbon-Copy List
  • -unavailable- added by rik5 (Posted a comment)
  • -unavailable- added by mtmiller (Submitted the item)
  •  

    Do you think this task is very important?
    If so, you can click here to add your encouragement to it.
    This task has 0 encouragements so far.

    Only project members can vote.

     

    Please enter the title of George Orwell's famous dystopian book (it's a date):

     

     

    Follow 7 latest changes.

    Date Changed By Updated Field Previous Value => Replaced By
    Sun 16 Feb 2014 09:07:16 PM UTCmtmillerStatusIn Progress=>Fixed
      Open/ClosedOpen=>Closed
    Sun 16 Feb 2014 07:37:47 PM UTCmtmillerStatusFixed=>In Progress
      Open/ClosedClosed=>Open
    Sun 16 Feb 2014 06:29:39 PM UTCrik5StatusNeed Info=>Fixed
      Open/ClosedOpen=>Closed
    Sat 15 Feb 2014 04:34:31 PM UTCrik5StatusNone=>Need Info

    Back to the top


    Powered by Savane 3.1-cleanup1