You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@pdfbox.apache.org by Kenneth D Weinert <ke...@quarter-flash.com> on 2008/08/14 21:59:07 UTC

The user guide

-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1

I've been looking at the user guide to provide some updates on
spelling and such and ran across a missing image.  In index.xml there
is a reference to the following:

<img src="/images/cos-pdmodel diagram.png" />

When I look in svn I see the image in there, but when looking at the
page in the incubator
(http://incubator.apache.org/pdfbox/userguide/index.html) the image is
missing.

I thought at first that it was because of the leading / on the url,
but then I took a look at http://incubator.apache.org/pdfbox/images
and that image isn't there.

Is there a build problem with the web site because the image name has
a space in it?

And let me ask one more question as long as I'm talking about updates.

What's the best way to get changes back in to svn?  I don't have
commit permission, should I post diffs?  I presume someone wants to
vet the changes before they get put into the repository.

If there's a document somewhere that I've overlooked that discusses
this a link to the documentation is more than acceptable.

Thanks.

BTW: from having transcribed the JAI-LICENSE into HTML I will note
that while I'm not a lawyer, the license looks extremely open source
hostile.

- --
Ken Weinert
http://quarter-flash.com
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.4.6 (GNU/Linux)
Comment: Using GnuPG with Mozilla - http://enigmail.mozdev.org

iD8DBQFIpI6KH0OpnUzq8fARAiZ6AKCciT33X8agrlW4vfe6HZePeIouqACgsVJK
X7xjg3HOZWw5eeQKeIZS/GY=
=X6PS
-----END PGP SIGNATURE-----


Re: The user guide

Posted by Jeremias Maerki <de...@jeremias-maerki.ch>.
On 15.08.2008 13:37:51 Kenneth D Weinert wrote:
> 
> Jeremias Maerki wrote:
> > Thanks a lot, Ken! I've applied your patch with small
> > modifications. I skipped adding the two license files to the
> > website as I found the files in the "licenses" directory and
> > there's less redundancy if we just link to the SVN repository. I
> > hope you approve.
> No problem, it works for me.
> >
> > http://svn.apache.org/viewvc?rev=686163&view=rev
> >
> > You might have missed a detail in my replies: Would you please
> > attach your future patches to a new JIRA issue? JIRA is better
> > suited to explicitely state your intention of making a contribution
> > (see the "Attachment license" option when you attach stuff) and to
> > track the status of the patch.
> Sorry about that - I had the impression I needed to submit the ICLA
> first. I've signed up to JIRA now and will submit future patches
> through there.

The ICLA is only required for substantial contributions. My mentioning
it was a precautionary measure. I consider a few fixes in some
documentation to be covered under section 5 of the ALv2. It's something
else if you start writing new features for PDFBox.

> Just out of curiosity, was there something aside from the license
> files that I should have done differently?  After all, submitting
> patches isn't supposed to make more work for you :)

What you did was just fine. Processing patches is always work but you do
it for the project and in the hope of recruiting new future committers.
I know there are a lot of little things that a new contributor has to
learn when he's starting so there's nothing wrong if something takes
another round-trip or so. Anyway, I think we've had a good kick-off here.
Keep them patches coming! :-)

> Thanks.
>  
> 
> - --
> Ken Weinert
> http://quarter-flash.com



Jeremias Maerki


Re: The user guide

Posted by Kenneth D Weinert <ke...@quarter-flash.com>.
-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1

Jeremias Maerki wrote:
> Thanks a lot, Ken! I've applied your patch with small
> modifications. I skipped adding the two license files to the
> website as I found the files in the "licenses" directory and
> there's less redundancy if we just link to the SVN repository. I
> hope you approve.
No problem, it works for me.
>
> http://svn.apache.org/viewvc?rev=686163&view=rev
>
> You might have missed a detail in my replies: Would you please
> attach your future patches to a new JIRA issue? JIRA is better
> suited to explicitely state your intention of making a contribution
> (see the "Attachment license" option when you attach stuff) and to
> track the status of the patch.
Sorry about that - I had the impression I needed to submit the ICLA
first. I've signed up to JIRA now and will submit future patches
through there.

Just out of curiosity, was there something aside from the license
files that I should have done differently?  After all, submitting
patches isn't supposed to make more work for you :)

Thanks.
 

- --
Ken Weinert
http://quarter-flash.com
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.4.6 (GNU/Linux)
Comment: Using GnuPG with Mozilla - http://enigmail.mozdev.org

iD8DBQFIpWqPH0OpnUzq8fARAnutAKCa2vNkiGNNfWvodNUKnxoK5K9b/gCgjk0/
SrpJ6CO9fVYCUIJWMh4YxcM=
=VnRo
-----END PGP SIGNATURE-----


Re: The user guide

Posted by Jeremias Maerki <de...@jeremias-maerki.ch>.
Thanks a lot, Ken! I've applied your patch with small modifications. I
skipped adding the two license files to the website as I found the files
in the "licenses" directory and there's less redundancy if we just link
to the SVN repository. I hope you approve.

http://svn.apache.org/viewvc?rev=686163&view=rev

You might have missed a detail in my replies: Would you please attach
your future patches to a new JIRA issue? JIRA is better suited to
explicitely state your intention of making a contribution (see the
"Attachment license" option when you attach stuff) and to track the
status of the patch.

On 14.08.2008 23:22:56 Kenneth D Weinert wrote:
> 
> OK, here's my first set of patches.
> 
> The userguide.patch was created from svn diff in the userguide directory.
> 
> There are three things accomplished in this patch
>     1) typos/grammer fixed
>     2) "Building" page refers to the incubator instead of sourceforge
>     3) on the redistribution page the component names are now links to
> the licenses.
> 
> The .zip file has an HTMLized version of the JAI license that I found.
> I understand that this might not be the latest one, but it's all I
> could find. I also copied a file name MustRead.html from the Adobe AFM
> distribution and renamed it to AdobeAFMLicense.html.
> 
> The redistribution page links directly to those to names for those two
> components. This is unlikely to be how it ends up but I thought I'd
> put the  anchor code in and let the folks that know adjust the path info.
> 
> Hope this meets your expectations.
> 
> Jeremias Maerki wrote:
> > On 14.08.2008 21:59:07 Kenneth D Weinert wrote:
> >> I've been looking at the user guide to provide some updates on
> >> spelling and such and ran across a missing image.  In index.xml
> >> there is a reference to the following:
> >>
> >> <img src="/images/cos-pdmodel diagram.png" />
> >>
> >> When I look in svn I see the image in there, but when looking at
> >> the page in the incubator
> >> (http://incubator.apache.org/pdfbox/userguide/index.html) the
> >> image is missing.
> >>
> >> I thought at first that it was because of the leading / on the
> >> url, but then I took a look at
> >> http://incubator.apache.org/pdfbox/images and that image isn't
> >> there.
> >>
> >> Is there a build problem with the web site because the image name
> >> has a space in it?
> >
> > Yes, the page contained an absolute path to the image instead of a
> > relative one. Since PDFBox is not deployed at the root level of a
> > subdomain, the path wasn't found. Fixed now:
> > http://svn.apache.org/viewvc?rev=686031&view=rev
> >
> >> And let me ask one more question as long as I'm talking about
> >> updates.
> >>
> >> What's the best way to get changes back in to svn?  I don't have
> >> commit permission, should I post diffs?  I presume someone wants
> >> to vet the changes before they get put into the repository.
> >
> > As mentioned in my previous post, you should submit your changes as
> > SVN Diffs. When we're tired of always reviewing and applying your
> > great patches *g*, you'll be voted in as a committer and get write
> > access.
> >
> > http://apache.org/foundation/how-it-works.html#roles
> >
> >> If there's a document somewhere that I've overlooked that
> >> discusses this a link to the documentation is more than
> >> acceptable.
> >>
> >> Thanks.
> >>
> >> BTW: from having transcribed the JAI-LICENSE into HTML I will
> >> note that while I'm not a lawyer, the license looks extremely
> >> open source hostile.
> >
> > I was under the impression that the JAI license has changed at some
> >  point. We'll look into it as we do the legal review of the whole
> > thing. It's one of the top priorities.
> >
> >> - -- Ken Weinert http://quarter-flash.com
> >
> >
> > Looking forward to your patches!
> >
> >
> > Jeremias Maerki
> >
> 
> - --
> Ken Weinert
> http://quarter-flash.com



Jeremias Maerki


Re: The user guide

Posted by Kenneth D Weinert <ke...@quarter-flash.com>.
-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1

OK, here's my first set of patches.

The userguide.patch was created from svn diff in the userguide directory.

There are three things accomplished in this patch
    1) typos/grammer fixed
    2) "Building" page refers to the incubator instead of sourceforge
    3) on the redistribution page the component names are now links to
the licenses.

The .zip file has an HTMLized version of the JAI license that I found.
I understand that this might not be the latest one, but it's all I
could find. I also copied a file name MustRead.html from the Adobe AFM
distribution and renamed it to AdobeAFMLicense.html.

The redistribution page links directly to those to names for those two
components. This is unlikely to be how it ends up but I thought I'd
put the  anchor code in and let the folks that know adjust the path info.

Hope this meets your expectations.

Jeremias Maerki wrote:
> On 14.08.2008 21:59:07 Kenneth D Weinert wrote:
>> I've been looking at the user guide to provide some updates on
>> spelling and such and ran across a missing image.  In index.xml
>> there is a reference to the following:
>>
>> <img src="/images/cos-pdmodel diagram.png" />
>>
>> When I look in svn I see the image in there, but when looking at
>> the page in the incubator
>> (http://incubator.apache.org/pdfbox/userguide/index.html) the
>> image is missing.
>>
>> I thought at first that it was because of the leading / on the
>> url, but then I took a look at
>> http://incubator.apache.org/pdfbox/images and that image isn't
>> there.
>>
>> Is there a build problem with the web site because the image name
>> has a space in it?
>
> Yes, the page contained an absolute path to the image instead of a
> relative one. Since PDFBox is not deployed at the root level of a
> subdomain, the path wasn't found. Fixed now:
> http://svn.apache.org/viewvc?rev=686031&view=rev
>
>> And let me ask one more question as long as I'm talking about
>> updates.
>>
>> What's the best way to get changes back in to svn?  I don't have
>> commit permission, should I post diffs?  I presume someone wants
>> to vet the changes before they get put into the repository.
>
> As mentioned in my previous post, you should submit your changes as
> SVN Diffs. When we're tired of always reviewing and applying your
> great patches *g*, you'll be voted in as a committer and get write
> access.
>
> http://apache.org/foundation/how-it-works.html#roles
>
>> If there's a document somewhere that I've overlooked that
>> discusses this a link to the documentation is more than
>> acceptable.
>>
>> Thanks.
>>
>> BTW: from having transcribed the JAI-LICENSE into HTML I will
>> note that while I'm not a lawyer, the license looks extremely
>> open source hostile.
>
> I was under the impression that the JAI license has changed at some
>  point. We'll look into it as we do the legal review of the whole
> thing. It's one of the top priorities.
>
>> - -- Ken Weinert http://quarter-flash.com
>
>
> Looking forward to your patches!
>
>
> Jeremias Maerki
>

- --
Ken Weinert
http://quarter-flash.com
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.4.6 (GNU/Linux)
Comment: Using GnuPG with Mozilla - http://enigmail.mozdev.org

iD8DBQFIpKIwH0OpnUzq8fARAsWMAKDMMnVFOjDxC42USQI/rwwcRq7HOACghmGx
/KJalpGFrKKg6eLDM8i4b+A=
=TgOP
-----END PGP SIGNATURE-----


Re: The user guide

Posted by Jeremias Maerki <de...@jeremias-maerki.ch>.
On 14.08.2008 21:59:07 Kenneth D Weinert wrote:
> 
> I've been looking at the user guide to provide some updates on
> spelling and such and ran across a missing image.  In index.xml there
> is a reference to the following:
> 
> <img src="/images/cos-pdmodel diagram.png" />
> 
> When I look in svn I see the image in there, but when looking at the
> page in the incubator
> (http://incubator.apache.org/pdfbox/userguide/index.html) the image is
> missing.
> 
> I thought at first that it was because of the leading / on the url,
> but then I took a look at http://incubator.apache.org/pdfbox/images
> and that image isn't there.
> 
> Is there a build problem with the web site because the image name has
> a space in it?

Yes, the page contained an absolute path to the image instead of a
relative one. Since PDFBox is not deployed at the root level of a
subdomain, the path wasn't found. Fixed now: http://svn.apache.org/viewvc?rev=686031&view=rev

> And let me ask one more question as long as I'm talking about updates.
> 
> What's the best way to get changes back in to svn?  I don't have
> commit permission, should I post diffs?  I presume someone wants to
> vet the changes before they get put into the repository.

As mentioned in my previous post, you should submit your changes as SVN
Diffs. When we're tired of always reviewing and applying your great
patches *g*, you'll be voted in as a committer and get write access.

http://apache.org/foundation/how-it-works.html#roles

> If there's a document somewhere that I've overlooked that discusses
> this a link to the documentation is more than acceptable.
> 
> Thanks.
> 
> BTW: from having transcribed the JAI-LICENSE into HTML I will note
> that while I'm not a lawyer, the license looks extremely open source
> hostile.

I was under the impression that the JAI license has changed at some
point. We'll look into it as we do the legal review of the whole thing.
It's one of the top priorities.

> - --
> Ken Weinert
> http://quarter-flash.com


Looking forward to your patches!


Jeremias Maerki