PDFBox and documentation

[Maruan Sahyoun <sa...@fileaffairs.de>]

Hi,

I have the infrastructure for enhancing our documentation nearly sorted (needed to learn a little more about the possibilities of the Apache CMS). Now WDYT would be the expectation for documenting how to use PDFBox for different use cases - code snippets or runnable examples?

BR
Maruan

Re: PDFBox and documentation

[Maruan Sahyoun <sa...@fileaffairs.de>]

that should be doable with some newer additions to the Apache CMS which allows to pull from svn and/or git. Will try something on that basis. If it works we can enhance the example package.

BR
Maruan

Am 05.07.2014 um 18:45 schrieb John Hewson <jo...@jahewson.com>:

> I'm for runnable examples in trunk on SVN, otherwise we'll end up with code that doesn't actually run. Some snippets from these examples could be put on the website but they should always link back to the example file in SVN viewvc - there's nothing more frustrating for a new user than incomplete examples, or having to copy and paste snippets together to recreate an example file.
> 
> Looking at the examples we have currently on SVN the coding conventions used are starting to look a bit dated, certainly far behind more recently written code.
> 
> -- John
> 
>> On 5 Jul 2014, at 04:46, Maruan Sahyoun <sa...@fileaffairs.de> wrote:
>> 
>> Hi,
>> 
>> I have the infrastructure for enhancing our documentation nearly sorted (needed to learn a little more about the possibilities of the Apache CMS). Now WDYT would be the expectation for documenting how to use PDFBox for different use cases - code snippets or runnable examples?
>> 
>> BR
>> Maruan

Re: PDFBox and documentation

[Tilman Hausherr <TH...@t-online.de>]

Am 05.07.2014 18:45, schrieb John Hewson:
> I'm for runnable examples in trunk on SVN, otherwise we'll end up with code that doesn't actually run. Some snippets from these examples could be put on the website but they should always link back to the example file in SVN viewvc - there's nothing more frustrating for a new user than incomplete examples, or having to copy and paste snippets together to recreate an example file.

Maybe the best is both. Sadly, I don't remember how I wrote my first 
pdfbox application - probably both from the pdfbox website and on 
stackoverflow. But I don't remember any pain.

One thing to improve in the documentation might be to tell that one 
could just download the app, instead of downloading pdfbox, fontbox and 
jempbox each time.

>
> Looking at the examples we have currently on SVN the coding conventions used are starting to look a bit dated, certainly far behind more recently written code.
>

Well, I thought I respect the conventions :-)

Tilman

Re: PDFBox and documentation

[John Hewson <jo...@jahewson.com>]

I'm for runnable examples in trunk on SVN, otherwise we'll end up with code that doesn't actually run. Some snippets from these examples could be put on the website but they should always link back to the example file in SVN viewvc - there's nothing more frustrating for a new user than incomplete examples, or having to copy and paste snippets together to recreate an example file.

Looking at the examples we have currently on SVN the coding conventions used are starting to look a bit dated, certainly far behind more recently written code.

-- John

> On 5 Jul 2014, at 04:46, Maruan Sahyoun <sa...@fileaffairs.de> wrote:
> 
> Hi,
> 
> I have the infrastructure for enhancing our documentation nearly sorted (needed to learn a little more about the possibilities of the Apache CMS). Now WDYT would be the expectation for documenting how to use PDFBox for different use cases - code snippets or runnable examples?
> 
> BR
> Maruan