Michael Granger's RDoc template

Ask a Question related to Ruby, Design and Development.

  1. #1

    Default Michael Granger's RDoc template

    Hi -talk,

    Has anyone attempted to improve on Mike's excellent effort yet? The
    Wiki page is bare.

    I just wanted to mention that it's rather odd that <h1> is rendered
    larger than <h2>. It's not just my browser, surely.

    Other points of style I disagree with:
    - light blue background for text in Files/Classes/Methods frames when
    surrounding background is white
    - rendering of dictionary lists could be improved with a little
    vertical space between entries
    - hyperlinks: blue background on mouse over doesn't grab me; I'd
    rather see classic underlines

    Anyway, it's a great piece of work, and hasn't seen a mention on the
    list in a while, so ...

    Cheers,
    Gavin


    Gavin Sinclair Guest

  2. Similar Questions and Discussions

    1. Bug in RDoc?
      I just found a bug (?) in rdoc tool. I have the following directory structure: doc/ lib/ sws.rb sws/ some .rb files
    2. rdoc template problem
      Has anyone seen this? For one of my projects, I can use older rdoc's successfully. But a recent CVS version gives: ...
    3. Michael Scarpitti BEWARE OF HIS ADVICE
      "Film Shooter" <filmguide@laksamana.net> wrote in message news:18484992.0308201609.3405a9c7@posting.google.com... KER-PLONK
    4. RDoc now does constants
      I've added experimental support for documenting constants to RDoc. Right now it's only in the CVS version, and only the default HTML template makes...
    5. New RDoc template, and a question
      Michael Granger has produced a wonderful new RDoc template, which looks about 1067 times better than any HTML I ever produced. What's even better:...
  3. #2

    Default Re: Michael Granger's RDoc template

    Gavin Sinclair wrote:
    > I just wanted to mention that it's rather odd that <h1> is rendered
    > larger than <h2>. It's not just my browser, surely.
    Sorry you lost me here. H1 is the largest H5 (or is it H6) the smallest, thats
    the way HTML works. What are you expecting?


    Peter Hickman Guest

  4. #3

    Default Re: Michael Granger's RDoc template

    On Monday, November 17, 2003, 11:24:25 PM, Peter wrote:
    > Gavin Sinclair wrote:
    >> I just wanted to mention that it's rather odd that <h1> is rendered
    >> larger than <h2>. It's not just my browser, surely.
    > Sorry you lost me here. H1 is the largest H5 (or is it H6) the smallest, thats
    > the way HTML works. What are you expecting?
    My mistake: I meant to say that H1 renders *smaller* than H2.

    Gavin



    Gavin Sinclair Guest

  5. #4

    Default Re: Michael Granger's RDoc template

    Hi!

    * Gavin Sinclair; 2003-11-17, 14:37 UTC:
    > My mistake: I meant to say that H1 renders *smaller* than H2.
    H1 and H2 are logical markup tags. It is up to the browsers if and
    how they use physical markup to display them.

    Several browsers (Mosaic, Opera, ...) allow you to fine-tune the look
    of every level. Perhaps you did misconfigure the one you use?

    Josef 'Jupp' Schugt
    --
    .-------.
    message > 100 kB? / | |
    sender = spammer? / | R.I.P.|
    text = spam? / ___| |___

    Josef 'Jupp' SCHUGT Guest

  6. #5

    Default Re: Michael Granger's RDoc template

    * Josef 'Jupp' SCHUGT <jupp@gmx.de> [Nov, 17 2003 22:50]:
    > H1 and H2 are logical markup tags. It is up to the browsers if and
    > how they use physical markup to display them.
    eh?
    > Several browsers (Mosaic, Opera, ...) allow you to fine-tune the look
    > of every level. Perhaps you did misconfigure the one you use?
    no he probably didn't, the style sheet is messed up - for the reason
    that .big-title-font sets its font-size to large, while
    small-title-font sets it to 10px.
    nikolai

    --
    ::: name: Nikolai Weibull :: aliases: pcp / lone-star / aka :::
    ::: born: Chicago, IL USA :: loc atm: Gothenburg, Sweden :::
    ::: page: [url]www.pcppopper.org[/url] :: fun atm: gf,lps,ruby,lisp,war3 :::
    main(){printf(&linux["\021%six\012\0"],(linux)["have"]+"fun"-97);}


    Nikolai Weibull Guest

  7. #6

    Default Re: Michael Granger's RDoc template

    Hi!

    * Nikolai Weibull; 2003-11-17, 23:51 UTC:
    > * Josef 'Jupp' SCHUGT <jupp@gmx.de> [Nov, 17 2003 22:50]:
    > > H1 and H2 are logical markup tags. It is up to the browsers if and
    > > how they use physical markup to display them.
    > eh?
    Didn't notice that 'template' is used in place of 'stylesheet'. To me
    a 'template' would be something like this:

    <html>
    <head>
    <title>#{title}</title>
    <body>
    <h1>#{title}<h1>
    <h2>#{date}</h2>
    #{ads}
    #{news}
    #{disclaimer}
    </body>
    </html>

    Perhaps calling a stylesheet a stylesheet is a good idea (TM)?

    Josef 'Jupp' Schugt
    --
    .-------.
    message > 100 kB? / | |
    sender = spammer? / | R.I.P.|
    text = spam? / ___| |___


    Josef 'Jupp' SCHUGT Guest

  8. #7

    Default Re: Michael Granger's RDoc template

    * Josef 'Jupp' SCHUGT <jupp@gmx.de> [Nov, 18 2003 15:00]:
    > Didn't notice that 'template' is used in place of 'stylesheet'. To me
    > a 'template' would be something like this:
    [an HTML template]
    > Perhaps calling a stylesheet a stylesheet is a good idea (TM)?
    eh?
    it's a template, and the template uses a stylesheet. the thing is that
    no h1's or h2's are being used, rather tables and classes are used to
    set text properties - which is of course bad, but that's the way the
    template works at the moment...
    nikolai

    --
    ::: name: Nikolai Weibull :: aliases: pcp / lone-star / aka :::
    ::: born: Chicago, IL USA :: loc atm: Gothenburg, Sweden :::
    ::: page: [url]www.pcppopper.org[/url] :: fun atm: gf,lps,ruby,lisp,war3 :::
    main(){printf(&linux["\021%six\012\0"],(linux)["have"]+"fun"-97);}

    Nikolai Weibull Guest

  9. #8

    Default Re: Michael Granger's RDoc template

    On Nov 18, 2003, at 7:13 AM, Nikolai Weibull wrote:
    > it's a template, and the template uses a stylesheet. the thing is that
    > no h1's or h2's are being used, rather tables and classes are used to
    > set text properties - which is of course bad, but that's the way the
    > template works at the moment...
    I think you're confused. The template I created *does* use h1 and h2
    (IMO correctly), and only uses tables for tabular data, preferring
    <div> for most things. The stylesheet doesn't (as suggested in a
    previous post) even have .{big,small}-title-font classes, nor do the h1
    or h2 elements set the font size to 'large' or pixel-sizes. The h1
    element is set to "120%" in the default stylesheet, but I try to avoid
    absolute pixel-sizes whenever possible when targeting many browsers.

    Responding to the general thread:

    I have no idea why an element whose font-size is set to "120%" would
    render smaller than a default h2. I've tested it in Mozilla, IE, and
    Safari on MacOSX, and Mozilla and Konqueror in Linux. Suggestions about
    how to eliminate this problem welcomed.

    The aesthetics of it are of course subject to debate, but that's the
    nature of aesthetics. I dislike the classic underline, especially in a
    page that's so link-heavy, but there's certainly a case to be made for
    making links look like people expect them to look.

    Soon after I submitted the 'css2' template, I also submitted (and Dave
    accepted) a patch that allows you to set your own custom stylesheet,
    which I think is a better solution than debating the aesthetic merits
    of the default stylesheet anyway. This allows you to use the css2 (or
    any other)
    template, but provide a stylesheet which reflects your own particular
    tastes.

    --
    Michael Granger <ged@FaerieMUD.org>
    Rubymage, Believer, Architect
    The FaerieMUD Consortium <http://www.FaerieMUD.org/>


    Michael Granger Guest

  10. #9

    Default Re: Michael Granger's RDoc template

    * Michael Granger <ged@FaerieMUD.org> [Nov, 18 2003 19:30]:
    > I think you're confused.
    I must be. I was talking about the -T kilmer theme.
    so, where can i get your theme?
    nikolai

    --
    ::: name: Nikolai Weibull :: aliases: pcp / lone-star / aka :::
    ::: born: Chicago, IL USA :: loc atm: Gothenburg, Sweden :::
    ::: page: [url]www.pcppopper.org[/url] :: fun atm: gf,lps,ruby,lisp,war3 :::
    main(){printf(&linux["\021%six\012\0"],(linux)["have"]+"fun"-97);}


    Nikolai Weibull Guest

  11. #10

    Default Re: Michael Granger's RDoc template


    On Nov 18, 2003, at 12:36 PM, Nikolai Weibull wrote:
    > so, where can i get your theme?
    It's the 'css2' theme in the CVS version.

    --
    Michael Granger <ged@FaerieMUD.org>
    Rubymage, Believer, Architect
    The FaerieMUD Consortium <http://www.FaerieMUD.org/>



    Michael Granger Guest

Posting Permissions

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

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139