Grokbase Groups Cayenne dev May 2009
FAQ

On 17/05/2009, at 10:31 AM, amaniatis@apache.org wrote:

URL: http://svn.apache.org/viewvc?rev=775573&view=rev
Log:
CAY-1167 Atttractive end user documentation for the schema.

I am unsure if this is the appropriate place to put these files, so
I'm open to other alternatives.
It makes sense that they belong with the actual schema documents,
but perhaps they should be excluded from building into the jar.
Gosh, that generated more html than I expected. Anyhow, now I've seen
the size of this I'm not sure my choice of location was the best. The
documentation is very attractive and easy to read, but should it:

* go away entirely since it requires a proprietary tool (Oxygen, which
I own a license for) to generate
* stay where it is since it is useful to live near the xsd file and go
up to the web site in the same location
* move to some other folder (I've actually just now noticed that we
already had a DTD file I never saw before in another location - anyhow
it looks a bit old and out of date, so this replacement of it is
probably useful).

I'm happy with any of the above, but unsure how best to have maven
exclude certain folders from the jar if we leave it where it is. I've
already got a script in place to upload the files to the web site.

Ari





-------------------------->
Aristedes Maniatis
phone +61 2 9660 9700
PGP fingerprint 08 57 20 4B 80 69 59 E2 A9 BF 2D 48 C2 20 0C C8

Search Discussions

  • Andrus Adamchik at May 17, 2009 at 11:50 am

    On May 17, 2009, at 3:36 AM, Aristedes Maniatis wrote:

    * go away entirely since it requires a proprietary tool (Oxygen,
    which I own a license for) to generate
    * stay where it is since it is useful to live near the xsd file and
    go up to the web site in the same location
    * move to some other folder (I've actually just now noticed that we
    already had a DTD file I never saw before in another location -
    anyhow it looks a bit old and out of date, so this replacement of it
    is probably useful).
    We definitely need to remove it from "cayenne-jdk1.5-unpublished" to
    avoid inclusion of this HTML in cayenne jars. "docs/doc/src/main/
    resources" seems like a better place (and then we need to figure out a
    way to sync it to the website).

    Using Oxygen is a smaller concern to me. We can just remove these docs
    if for some reason we are unable to use Oxygen in the future. One
    thing I'd check is what does the Oxygen license says about
    redistributing generated docs and XSD. I wouldn't imagine there are
    any strings attached, still worth a look.
    (I've actually just now noticed that we already had a DTD file I
    never saw before in another location - anyhow it looks a bit old and
    out of date, so this replacement of it is probably useful)
    It's been maintained till recently, but since we have a schema now, we
    should remove it.

    Andrus
  • Aristedes Maniatis at May 17, 2009 at 12:12 pm

    On 17/05/2009, at 9:49 PM, Andrus Adamchik wrote:

    We definitely need to remove it from "cayenne-jdk1.5-unpublished" to
    avoid inclusion of this HTML in cayenne jars. "docs/doc/src/main/
    resources" seems like a better place (and then we need to figure out
    a way to sync it to the website).
    Syncing it easy since I've already got a script which regenerates the
    javadocs each night, plus it uploads the schema XSD file at the same
    time. Just one more thing to do.

    I'll move the docs soon as I get a chance tonight. What about the xsd
    file? Do you prefer it where it is or should it move as well? I feel
    it makes sense to be inside the package.
    Using Oxygen is a smaller concern to me. We can just remove these
    docs if for some reason we are unable to use Oxygen in the future.
    One thing I'd check is what does the Oxygen license says about
    redistributing generated docs and XSD. I wouldn't imagine there are
    any strings attached, still worth a look.
    I looked but couldn't find anything. Since the whole point of the tool
    is to generate docs, I can't see a problem. Apache would qualify for a
    very cheap (about $60 instead of $300) license, but there isn't a free
    open source one. And there is no command line generator.
    (I've actually just now noticed that we already had a DTD file I
    never saw before in another location - anyhow it looks a bit old
    and out of date, so this replacement of it is probably useful)
    It's been maintained till recently, but since we have a schema now,
    we should remove it.
    I looked through it and it was a bit out of date in places. But it
    seems that some maven magic is putting it into the built jars in the
    manifest. Would you be able to do that for the XSD instead?


    Ari


    -------------------------->
    ish
    http://www.ish.com.au
    Level 1, 30 Wilson Street Newtown 2042 Australia
    phone +61 2 9550 5001 fax +61 2 9550 4001
    GPG fingerprint CBFB 84B4 738D 4E87 5E5C 5EFA EF6A 7D2E 3E49 102A
  • Andrus Adamchik at May 17, 2009 at 12:18 pm

    On May 17, 2009, at 3:11 PM, Aristedes Maniatis wrote:
    I'll move the docs soon as I get a chance tonight. What about the
    xsd file? Do you prefer it where it is or should it move as well? I
    feel it makes sense to be inside the package.
    Yeah, probably. If we are to validate the XML against the schema, we
    will need to have it on the CLASSPATH, as forcing an application to
    download it from the website is not a good idea.
    But it seems that some maven magic is putting it into the built jars
    in the manifest. Would you be able to do that for the XSD instead?
    Not sure what you mean. Could you elaborate on where did you find a
    DTD ref in the manifest?

    Andrus
  • Mike Kienenberger at May 18, 2009 at 1:52 am

    On Sun, May 17, 2009 at 7:49 AM, Andrus Adamchik wrote:
    Using Oxygen is a smaller concern to me. We can just remove these docs if
    for some reason we are unable to use Oxygen in the future. One thing I'd
    check is what does the Oxygen license says about redistributing generated
    docs and XSD. I wouldn't imagine there are any strings attached, still worth
    a look.
    Oxygen is (or was) just an xml editor. I haven't used it in a few
    years, but I doubt there are any strings attached. I still have a
    license for it (albeit for an old version) somewhere -- I never use it
    anymore.

Related Discussions

Discussion Navigation
viewthread | post
Discussion Overview
groupdev @
categoriescayenne
postedMay 17, '09 at 12:37a
activeMay 18, '09 at 1:52a
posts5
users4
websitecayenne.apache.org

People

Translate

site design / logo © 2022 Grokbase