<div dir="ltr">I've made a number of updates to the Scribble CSS, and posted more sample docs, if you care to revisit:<div><br></div><div><a href="http://mbutterick.github.io/racket-doc-redo/doc/">http://mbutterick.github.io/racket-doc-redo/doc/</a><br>
</div><div><br></div><div><br></div><div>As for the specific requests & suggestions, I considered them all, tried most of them, and left in the ones that worked best, e.g.—</div><div><br></div><div>+ search box & prev/next buttons are no longer fixed to the top left corner.</div>
<div>+ less gray & more color, especially for the definition boxes.<br></div><div>+ interior cross-reference links are no longer bold, & are colored. <br></div><div>+ TOC bar goes away on narrow windows, yielding a one-column layout<br>
</div><div>+ white lines separate elements in @deftogether<br></div><div><br></div><div>Still have some issues to fix (e.g., not all the boxes in "How to Program Racket" are working right yet [1]) but if you find lurking horrors, let me know. Thanks for your help.</div>
<div><br></div><div><br></div><div>[1] <a href="http://mbutterick.github.io/racket-doc-redo/doc/style/Choosing_the_Right_Construct.html">http://mbutterick.github.io/racket-doc-redo/doc/style/Choosing_the_Right_Construct.html</a></div>
<div><br></div><div><br></div><div><br></div><div><br></div></div><div class="gmail_extra"><br><br><div class="gmail_quote">On Sun, Nov 10, 2013 at 1:28 PM, David Vanderson <span dir="ltr"><<a href="mailto:david.vanderson@gmail.com" target="_blank">david.vanderson@gmail.com</a>></span> wrote:<br>
<blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex">
<div text="#000000" bgcolor="#FFFFFF">
This is amazing! Thank you very much!<br>
<br>
Given all the little rendering things that people are pointing out,
I should say that the docs are currently using a transitional
DOCTYPE, which could be part of the problem. You probably have good
reasons for it, but I thought I'd mention it just in case.<br>
<br>
Thanks again!<br>
Dave<div><div class="h5"><br>
<br>
<div>On 11/10/2013 12:16 AM, Matthew
Butterick wrote:<br>
</div>
<blockquote type="cite">
<div dir="ltr">
<div>
<div>Thank you for the comments so far. As for the gentleman
who was "reluctant to say anthing negative," please don't be
— the point of making a prototype is to find out what
doesn't work. </div>
<div><br>
</div>
<div>I won't cover every suggestion here on the mailing list
because it will become unwieldy. But I'll move the trickier
topics onto the github repo as issues, and those interested
can comment further there.</div>
<div><br>
</div>
<div><br>
</div>
</div>
</div>
<div class="gmail_extra"><br>
<br>
<div class="gmail_quote">On Sat, Nov 9, 2013 at 5:52 PM, Greg
Hendershott <span dir="ltr"><<a href="mailto:greghendershott@gmail.com" target="_blank">greghendershott@gmail.com</a>></span>
wrote:<br>
<blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex">This is so
wonderful and I'm so happy you did this. It is awesomely<br>
awesome. Truly.<br>
<br>
Thank you, thank you, thank you!<br>
<br>
<br>
My only gripe so far is the floating search box that insists
on being<br>
in the top-left corner and won't scroll away. On a desktop
browser,<br>
some people find that sort of thing mildly annoying. On a
phone<br>
browser, it's worse. For example if you double-tap the main
column to<br>
zoom in, the search box is still stuck up there floating on
top of<br>
text you want to read. tl;dr I suggest letting it scroll
off normally<br>
along with "on-this-page", preferably IMO always, but at
least on<br>
small screens.<br>
<br>
One other mobile issue: At least on Chrome for Android, the
main text<br>
is a comfortable size, but the code examples are very tiny.
(Whereas<br>
on the desktop, the sizes seem relatively equal.)<br>
<div>
<div><br>
<br>
<br>
On Sat, Nov 9, 2013 at 2:12 AM, Matthew Butterick<br>
<<a href="mailto:mb.list.acct@gmail.com" target="_blank">mb.list.acct@gmail.com</a>>
wrote:<br>
> Rather than edit the Scribble CSS files in the main
Racket repo, I decided<br>
> it would be more efficient to make a new repo to
act as a prototype (and<br>
> serve it via github pages). That way, it's easier
for others to try the new<br>
> CSS and report problems & suggestions. Once the
changes look good, I can put<br>
> them into a pull request for the main repo.<br>
><br>
> What I did is grab part of the docs from the built
version of 5.90.0.9 and<br>
> dropped that in the prototype repo. Then I edited
the CSS files.<br>
><br>
> The prototype repo is here:<br>
><br>
> <a href="https://github.com/mbutterick/racket-doc-redo/tree/gh-pages" target="_blank">https://github.com/mbutterick/racket-doc-redo/tree/gh-pages</a><br>
><br>
> To preview the pages in a web browser, start here:<br>
><br>
> <a href="http://mbutterick.github.io/racket-doc-redo/doc/index.html" target="_blank">http://mbutterick.github.io/racket-doc-redo/doc/index.html</a><br>
><br>
> This is my first attempt at using github pages, so
if there's breakage,<br>
> blame me.<br>
><br>
> As for the design changes, there's more refinement
and nitpickery to come,<br>
> but the basic idea is intact, and good enough to
criticize. Mostly I've<br>
> aimed to simplify and update the layout, while
keeping the character of the<br>
> documentation intact. I've also tried to address
one key functional<br>
> shortcoming of the current CSS: its fixed width.<br>
><br>
> And yes, it is somewhat less colorful overall,
though not because I oppose<br>
> "the colors of the rainbow" ;) Rather, I just think
the color has better<br>
> effect when it's used sparingly. Like a day spa for
the mind.<br>
><br>
> Matthew Butterick<br>
><br>
><br>
><br>
><br>
> On Wed, Oct 16, 2013 at 3:41 PM, Robby Findler <<a href="mailto:robby@eecs.northwestern.edu" target="_blank">robby@eecs.northwestern.edu</a>><br>
> wrote:<br>
>><br>
>> I've just finished reading your (beautiful!)
book and am excitedly looking<br>
>> forward to what you come up with. Do let us
know if you get stuck anywhere.<br>
>> (And yes: we apparently like all the colors of
the rainbow more than you<br>
>> seem to; hopefully you won't hold that against
us :).<br>
>><br>
>> Robby<br>
>><br>
>><br>
>><br>
>> On Fri, Oct 11, 2013 at 5:35 PM, Matthew
Butterick<br>
>> <<a href="mailto:mb.list.acct@gmail.com" target="_blank">mb.list.acct@gmail.com</a>>
wrote:<br>
>>><br>
>>> Consistent with my pledge at RacketCon,
I’ve been working on some<br>
>>> potential improvements to the default CSS
files used by Scribble for Racket<br>
>>> documentation. Before I get too far I just
want to make sure I’m going about<br>
>>> it the right way.<br>
>>><br>
>>> I've read the tutorials by Joe Politz and
Greg Hendershott about how to<br>
>>> contribute to Racket via Github. I made a
fresh fork of plt/racket yesterday<br>
>>> and built it from source. But the Scribble
CSS files are handled a little<br>
>>> differently than others.<br>
>>><br>
>>> I see that the documentation gets built
into racket/racket/doc/,<br>
>>> including the CSS files. So if I edit the
files in that directory, I can see<br>
>>> the CSS changes reflected in the docs.
However, the whole doc directory is<br>
>>> ignored in the git repo. And I need to edit
files that git can see.<br>
>>><br>
>>> So I found the original home of the CSS
files in<br>
>>>
racket/pkgs/scribble-pkgs/scribble-lib/scribble/. If I
update these files,<br>
>>> then git sees them. But the changes aren't
reflected in the live<br>
>>> documentation.<br>
>>><br>
>>> My workaround has just been to replace the
copies in racket/racket/doc<br>
>>> with symlinks to the files in
scribble-pkgs. That way, as I update the CSS<br>
>>> in scribble-pkgs, git can see the updates,
but they're also reflected in the<br>
>>> live docs. (These symlinks will get wiped
out next time I rebuild from<br>
>>> source, but that's the price of progress.)<br>
>>><br>
>>><br>
>>> 1) What's the best way to propose Scribble
CSS updates? Should I assemble<br>
>>> a pull request for
racket/pkgs/scribble-pkgs/scribble-lib/scribble/ ?<br>
>>><br>
>>> 2) Is there a better way of connecting the
CSS file in scribble-pkgs to<br>
>>> the actual CSS file used by the
documentation? (i.e., other than my symlink<br>
>>> technique).<br>
>>><br>
>>> 3) Anyone who wants to try out the new
Scribble CSS files or contribute<br>
>>> to the update will have the same problem,
however. I'm not sure how to avoid<br>
>>> this given that Scribble's HTML rendering
policy is to bring the CSS files<br>
>>> along for the ride and eliminate dependency
on the source directory. OTOH,<br>
>>> it's a drag to have to rebuild the docs
just to see the effect of a few CSS<br>
>>> files.<br>
>>><br>
>>> 4) For now I'm just working with the CSS,
and not delving into the<br>
>>> Scribble HTML renderer, on the idea that
changing fewer files is better, and<br>
>>> maintaining compatibility with existing doc
sources is essential. That said,<br>
>>> there are some occasional defects in the
Scribble HTML output that puts<br>
>>> things out of reach of CSS (e.g., I've
found styling hard-coded into the<br>
>>> HTML in places).<br>
>>><br>
>>><br>
>>> Matthew Butterick<br>
>>><br>
>>> ____________________<br>
>>> Racket Users list:<br>
>>> <a href="http://lists.racket-lang.org/users" target="_blank">http://lists.racket-lang.org/users</a><br>
>>><br>
>><br>
><br>
><br>
> ____________________<br>
> Racket Users list:<br>
> <a href="http://lists.racket-lang.org/users" target="_blank">http://lists.racket-lang.org/users</a><br>
><br>
</div>
</div>
</blockquote>
</div>
<br>
</div>
<br>
<fieldset></fieldset>
<br>
<pre>____________________
Racket Users list:
<a href="http://lists.racket-lang.org/users" target="_blank">http://lists.racket-lang.org/users</a>
</pre>
</blockquote>
<br>
</div></div></div>
<br>____________________<br>
Racket Users list:<br>
<a href="http://lists.racket-lang.org/users" target="_blank">http://lists.racket-lang.org/users</a><br>
<br></blockquote></div><br></div>