Re: [racket-users] Where to put scribblings in 'multi package?
Also there's some history, IIRC: Early on, multi collection packages were the only kind. Even an actively maintained package might stick with this, to continue to support older versions of Racket. Same story for info.rkt files using #lang setup/infotab instead of #lang info. -- 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.
Re: [racket-users] Where to put scribblings in 'multi package?
The gui-lib might be an example. It provides modules spanning different collections such as racket/gui, framework/ and mrlib/. https://github.com/racket/gui/tree/master/gui-lib On Wed, Aug 29, 2018 at 7:13 AM, Erich Rast wrote: > On Wed, 29 Aug 2018 06:46:49 -0500 > Philip McGrath wrote: > > >> You don't need a multi-collection package to do this. If your >> structure is: >> >> appy/ >> | >> |--info.rkt >> |--main.rkt >> |--gui.rkt >> |--… >> >> Then `(require appy)` will import "main.rkt" and `(require appy/gui)` >> will import "gui.rkt". > > Oh, that's very useful info I didn't know that. I thought this > possibility is exactly the purpose of multi-collection packages. I'll > make it flat again ASAP. > > Out of curiosity, if it's not the above selective importing, what *is* > the main use case for multi-collection packages? > > Best, > > Erich > > -- > 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.
Re: [racket-users] Where to put scribblings in 'multi package?
On Wed, 29 Aug 2018 06:46:49 -0500 Philip McGrath wrote: > You don't need a multi-collection package to do this. If your > structure is: > > appy/ > | > |--info.rkt > |--main.rkt > |--gui.rkt > |--… > > Then `(require appy)` will import "main.rkt" and `(require appy/gui)` > will import "gui.rkt". Oh, that's very useful info I didn't know that. I thought this possibility is exactly the purpose of multi-collection packages. I'll make it flat again ASAP. Out of curiosity, if it's not the above selective importing, what *is* the main use case for multi-collection packages? Best, Erich -- 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.
Re: [racket-users] Where to put scribblings in 'multi package?
On Wed, Aug 29, 2018 at 6:29 AM Erich Rast wrote: > The reason why I want this to be a multi-collection package is that the > framework without anything gui-related is fairly small and should be > required by default as (require appy). The GUI-related extensions on > the other hand import and re-export a lot of additional modules - there > might even be a complete abstraction layer over Racket's GUI classes > later - and so I want them to be required explicitly as (require > appy/gui). > You don't need a multi-collection package to do this. If your structure is: appy/ | |--info.rkt |--main.rkt |--gui.rkt |--… Then `(require appy)` will import "main.rkt" and `(require appy/gui)` will import "gui.rkt". On the other hand, if you want users to be able to *install* the non-GUI portions separately, a multi-collection package isn't enough: that's what leads to the profligration of foo + foo-lib + foo-test + foo-doc package families. -Philip > > That being said, everybody seems to discourage making multi-collection > packages everywhere I've looked. Are they just more complicated or are > there plans to deprecate them in the future? > > Best, > > Erich > > -- > 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.
Re: [racket-users] Where to put scribblings in 'multi package?
Thanks a lot Philip and Ryan! Splitting up the info.rkt file worked fine. The reason why I want this to be a multi-collection package is that the framework without anything gui-related is fairly small and should be required by default as (require appy). The GUI-related extensions on the other hand import and re-export a lot of additional modules - there might even be a complete abstraction layer over Racket's GUI classes later - and so I want them to be required explicitly as (require appy/gui). That being said, everybody seems to discourage making multi-collection packages everywhere I've looked. Are they just more complicated or are there plans to deprecate them in the future? Best, Erich -- 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.
Re: [racket-users] Where to put scribblings in 'multi package?
On 08/29/2018 12:37 PM, Erich Rast wrote:
I have a preliminary scribbling for the manual
of a multi source package, but it doesn't show up in Racket's main
documentation when I install the package locally.
Here is the directory structure:
appy
|
|--info.rkt
|--appy
|
|--
|--scribblings
|
|--manual.scrbl
And "info.rkt" looks like this:
#lang info
(define version "0.1")
(define pkg-desc "a framework for cross-platform end-user applications
and their deployment")
(define collection 'multi)
(define distribution-preference 'source)
(define pkg-authors '("Erich Rast"))
(define scribblings '(("scribblings/manual.scrbl" main-doc
main-doc-root (library) "APPY: a framework for writing end-user GUI
applications")))
Raco install in the appy directory reports no errors, the package is
installed locally, but the "manual.scrblr" does not show up and does not
seem to be compiled. I've changed the path to
"appy/scribblings/manual.scrbl" without effect.
What's the correct way to set up the documentation? Related to this,
will raco pkg install report an error if my scribbling doesn't compile?
There are pkg-level info keys (like version, pkg-desc, collection, etc)
and collects-level info keys (like scribblings, compile-omit-paths,
etc). For single-collection layouts (ie, the collections key is a string
instead of 'multi) they're combined into a single info.rkt file, but for
multi-collection packages they're in different places.
Create a new info.rkt file in the apply *collection* directory (the same
one that has the source files and the scribblings subdirectory) and move
the scribblings definition there.
For an example of this organization in the main distribution, see the
redex repository at https://github.com/racket/redex. In particular, look
at the redex-doc (pkg) directory. It has a pkg-level info.rkt file, and
the redex collection subdirectory has a collection-level info.rkt file
with a scribblings entry.
(Actually, I believe any subdirectory can have an info file with keys
like scribblings, compile-omit-paths, etc; just not the pkg root
directory of a multi-collection package.)
Ryan
--
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] Where to put scribblings in 'multi package?
I have a preliminary scribbling for the manual
of a multi source package, but it doesn't show up in Racket's main
documentation when I install the package locally.
Here is the directory structure:
appy
|
|--info.rkt
|--appy
|
|--
|--scribblings
|
|--manual.scrbl
And "info.rkt" looks like this:
#lang info
(define version "0.1")
(define pkg-desc "a framework for cross-platform end-user applications
and their deployment")
(define collection 'multi)
(define distribution-preference 'source)
(define pkg-authors '("Erich Rast"))
(define scribblings '(("scribblings/manual.scrbl" main-doc
main-doc-root (library) "APPY: a framework for writing end-user GUI
applications")))
Raco install in the appy directory reports no errors, the package is
installed locally, but the "manual.scrblr" does not show up and does not
seem to be compiled. I've changed the path to
"appy/scribblings/manual.scrbl" without effect.
What's the correct way to set up the documentation? Related to this,
will raco pkg install report an error if my scribbling doesn't compile?
Thanks in advance for any help!
Best,
Erich
--
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.
