Re: [racket-users] Controlling the installation-specific "Racket Documentation" page

2017-06-22 Thread Matthew Flatt
You can set "doc-site.css" and "doc-site.js" to customize the
presentation of documentation. That's how http://docs.racket-lang.org/
adds the Racket logo to the top-right of the page, for example. When
you re-render documentation via `raco pkg` and/or `raco setup`, they
won't replace your "doc-site.css" and "doc-site.js".

That hook doesn't give you a convenient way to reorder the table of
contents, but since JavaScript in "doc-site.js" can do just about
anything, it would be possible to reorder the listing to bring yours to
the top and to add extra links.

At Wed, 21 Jun 2017 18:32:45 -0500, Philip McGrath wrote:
> Hi everyone,
> 
> I'm looking for information on how to customize the top-level "Racket
> Documentation" page generated by Scribble for a particular Racket
> installation.
> 
> Specifically, I am working with a group that has now accumulated a few
> internal Racket packages with documentation, as well as some documents of a
> similar nature to which our developers need to refer. (Many, though not
> all, of these documents are written in Scribble, and some of the developers
> involved are not Racketeers.) I would like to customize the
> installation-specific "Racket Documentation" page on our server — for
> example, to put the documentation for our group's packages at the very top
> of the list. Then I could simply serve that directory over HTTPS and give
> our team, including the non-Racketeers, a convenient way to view these
> documents in a central location.
> 
> (I could, of course, roll my own web page that simply linked to the
> documents, but it would be nice to cooperate with Scribble's "top" link
> etc., and I definitely want to avoid adding anything to our Racket package
> documentation that would make them *only* work in the context of our
> server.)
> 
> Is there a mechanism for doing this sort of customization?
> 
> Thanks,
> Philip
> 
> -- 
> You received this message because you are subscribed to the Google Groups 
> "Racket Users" group.
> To unsubscribe from this group and stop receiving emails from it, send an 
> email to racket-users+unsubscr...@googlegroups.com.
> For more options, visit https://groups.google.com/d/optout.

-- 
You received this message because you are subscribed to the Google Groups 
"Racket Users" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to racket-users+unsubscr...@googlegroups.com.
For more options, visit https://groups.google.com/d/optout.


[racket-users] Controlling the installation-specific "Racket Documentation" page

2017-06-21 Thread Philip McGrath
Hi everyone,

I'm looking for information on how to customize the top-level "Racket
Documentation" page generated by Scribble for a particular Racket
installation.

Specifically, I am working with a group that has now accumulated a few
internal Racket packages with documentation, as well as some documents of a
similar nature to which our developers need to refer. (Many, though not
all, of these documents are written in Scribble, and some of the developers
involved are not Racketeers.) I would like to customize the
installation-specific "Racket Documentation" page on our server — for
example, to put the documentation for our group's packages at the very top
of the list. Then I could simply serve that directory over HTTPS and give
our team, including the non-Racketeers, a convenient way to view these
documents in a central location.

(I could, of course, roll my own web page that simply linked to the
documents, but it would be nice to cooperate with Scribble's "top" link
etc., and I definitely want to avoid adding anything to our Racket package
documentation that would make them *only* work in the context of our
server.)

Is there a mechanism for doing this sort of customization?

Thanks,
Philip

-- 
You received this message because you are subscribed to the Google Groups 
"Racket Users" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to racket-users+unsubscr...@googlegroups.com.
For more options, visit https://groups.google.com/d/optout.