Results 1 to 10 of 10

Thread: Minor formatting issue in online documentation

  1. #1
    ctennis is offline Registered User
    Name: Caleb Tennis
    Organization: AEI
    Project: Project GINA
    Join Date
    Mar 2006
    Posts
    123

    Minor formatting issue in online documentation

    I've been reading through the new online docs (thanks a bunch for this!) and I've noticed that lot of words, seemingly randomly, have dashes in them.

    For example, on this page (http://www.zeroc.com/doc/latest/manu...arps.17.5.html) notice the word "corre-sponding" in the first sentence.

    My hunch is that this is from the PDF formatting when words are broken in line wraps.

    Pretty minor detail, but I thought I would share.
    Caleb Tennis
    Analytical Engineering, Inc.
    http://www.aei-tech.com
    Project: Our facility infrastructure heavily utilizes Ice

    Gentoo ebuild maintainer for Ice, IceRuby, etc.

  2. #2
    marc's Avatar
    marc is offline ZeroC Staff
    Name: Marc Laukien
    Organization: ZeroC, Inc.
    Project: The Internet Communications Engine
    Join Date
    Feb 2003
    Location
    Florida
    Posts
    1,860
    Strange... I don't see any dashes

  3. #3
    ctennis is offline Registered User
    Name: Caleb Tennis
    Organization: AEI
    Project: Project GINA
    Join Date
    Mar 2006
    Posts
    123
    Try this page:

    http://zeroc.com/doc/latest/manual/Slice.5.13.html

    The third line has this:

    ::Family::Chil*dren::Child
    Caleb Tennis
    Analytical Engineering, Inc.
    http://www.aei-tech.com
    Project: Our facility infrastructure heavily utilizes Ice

    Gentoo ebuild maintainer for Ice, IceRuby, etc.

  4. #4
    ctennis is offline Registered User
    Name: Caleb Tennis
    Organization: AEI
    Project: Project GINA
    Join Date
    Mar 2006
    Posts
    123
    note: for some reason the dash in the word Children came across as a star on the forums.
    Caleb Tennis
    Analytical Engineering, Inc.
    http://www.aei-tech.com
    Project: Our facility infrastructure heavily utilizes Ice

    Gentoo ebuild maintainer for Ice, IceRuby, etc.

  5. #5
    marc's Avatar
    marc is offline ZeroC Staff
    Name: Marc Laukien
    Organization: ZeroC, Inc.
    Project: The Internet Communications Engine
    Join Date
    Feb 2003
    Location
    Florida
    Posts
    1,860
    I'm afraid I still can't see it. What browser are you using?

    However, I noticed a strange placement of the </a> tag in the HTML code. Unfortunately, we have limited control over the generated HTML. The HTML is generated by WebWorks from our FrameMaker documentation.

  6. #6
    ctennis is offline Registered User
    Name: Caleb Tennis
    Organization: AEI
    Project: Project GINA
    Join Date
    Mar 2006
    Posts
    123
    I'm using Safari on the Mac.

    Here's a link to a screenshot I just took:

    [img=http://img222.imageshack.us/img222/7965/dashedqz0.th.png]
    Caleb Tennis
    Analytical Engineering, Inc.
    http://www.aei-tech.com
    Project: Our facility infrastructure heavily utilizes Ice

    Gentoo ebuild maintainer for Ice, IceRuby, etc.

  7. #7
    ctennis is offline Registered User
    Name: Caleb Tennis
    Organization: AEI
    Project: Project GINA
    Join Date
    Mar 2006
    Posts
    123
    I just opened up the page in Firefox on the mac and the mysterious dash was NOT there.

    Must be a safari issue, then.
    Caleb Tennis
    Analytical Engineering, Inc.
    http://www.aei-tech.com
    Project: Our facility infrastructure heavily utilizes Ice

    Gentoo ebuild maintainer for Ice, IceRuby, etc.

  8. #8
    marc's Avatar
    marc is offline ZeroC Staff
    Name: Marc Laukien
    Organization: ZeroC, Inc.
    Project: The Internet Communications Engine
    Join Date
    Feb 2003
    Location
    Florida
    Posts
    1,860
    Well, there indeed is a strange character in there. I have no idea what it is, and where it is coming from, and why some browsers render it and others don't. We will look into this.

  9. #9
    michi's Avatar
    michi is offline Registered User
    Name: Michi Henning
    Organization: Triodia Technologies
    Project: I have a passing interest in Ice :-)
    Join Date
    Feb 2003
    Location
    Brisbane, Australia
    Posts
    1,055
    This is caused by a bug in the program we use to generate the online doc. I'm afraid that all we can do is report the bug to the vendor...

    Michi.

  10. #10
    ctennis is offline Registered User
    Name: Caleb Tennis
    Organization: AEI
    Project: Project GINA
    Join Date
    Mar 2006
    Posts
    123
    Not a problem. It's pretty obvious when the random dash shouldn't be there. Just wanted to make everyone aware.
    Caleb Tennis
    Analytical Engineering, Inc.
    http://www.aei-tech.com
    Project: Our facility infrastructure heavily utilizes Ice

    Gentoo ebuild maintainer for Ice, IceRuby, etc.

Thread Information

Users Browsing this Thread

There are currently 1 users browsing this thread. (0 members and 1 guests)

Similar Threads

  1. Replies: 0
    Last Post: 03-01-2010, 05:21 PM
  2. Minor typo in 3.2.1 online manual
    By gumshoe in forum Bug Reports
    Replies: 1
    Last Post: 01-17-2008, 03:15 PM
  3. Minor online doc bug
    By ctennis in forum Bug Reports
    Replies: 1
    Last Post: 11-13-2007, 06:51 AM
  4. (minor) IceStorm 3.2 documentation error?
    By borax00 in forum Comments
    Replies: 3
    Last Post: 03-15-2007, 12:44 PM
  5. Minor Documentation Corrections
    By Ken Carpenter in forum Comments
    Replies: 3
    Last Post: 03-03-2003, 09:12 PM

Posting Permissions

  • You may not post new threads
  • You may not post replies
  • You may not post attachments
  • You may not edit your posts
  •