You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@pdfbox.apache.org by "Maruan Sahyoun (JIRA)" <ji...@apache.org> on 2014/10/16 22:54:33 UTC

[jira] [Comment Edited] (PDFBOX-2340) Overhaul PDFBox Documentation

    [ https://issues.apache.org/jira/browse/PDFBOX-2340?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=14174215#comment-14174215 ] 

Maruan Sahyoun edited comment on PDFBOX-2340 at 10/16/14 8:54 PM:
------------------------------------------------------------------

now with pdfbox-docs in place I’ll start putting some content in which will then be used in a second step to be populated into our website (but shall also be readable standalone). I’m looking to have the content broken up in chapters for typical uses case of the software such as acrofoms, signing, text extraction.

Are there chapters you would like to see? 

First part will be the Cookbook - likely that this will point to GitHub pdfbox-docs initially until the population process has been established. 


was (Author: msahyoun):
now with pdfbox-docs in place I’ll start putting some content in which will then be used in a second step to be populated into our website (but shall also be readable standalone). I’m looking to have the content broken up in chapters for typical uses case of the software such as acrofoms, signing, text extraction.

Are there chapters you would like to see? 

> Overhaul PDFBox Documentation
> -----------------------------
>
>                 Key: PDFBOX-2340
>                 URL: https://issues.apache.org/jira/browse/PDFBOX-2340
>             Project: PDFBox
>          Issue Type: Improvement
>          Components: Documentation
>    Affects Versions: 2.0.0
>            Reporter: Maruan Sahyoun
>            Priority: Critical
>             Fix For: 2.0.0
>
>         Attachments: Mockup-20140912.png, Mockup_Documentation.png
>
>
> In oder to make it easier for users of PDFBox to work with the library there shall be an enhanced documentation consisting of an introduction, API references and more well documented examples and code snippets (Cookbook).
> In order to make it easier to contribute the Cookbook shall be build automatically from the examples/snippet ‚repository‘.



--
This message was sent by Atlassian JIRA
(v6.3.4#6332)