Starting to add some documentation.

Starting to add some documentation.

This CL adds the beginnings of a Geting Started document for PDFium and adds
the navbar.md file to get navigation on the markdown files when rendered by
Gitiles.

Committed: https://pdfium.googlesource.com/pdfium/+/23863e4c86a99381c1bd83e76c9055b10a8bf6c4

[dsinclair, 2016-03-28 19:24:51]

dsinclair@chromium.org changed reviewers:
+ tsepez@chromium.org

[dsinclair, 2016-03-28 19:24:52]

PTAL. Started poking at some documentation. This is more skeleton then docs, but
it's a start (figuring out that link line was a serious pain, heh)

[Tom Sepez, 2016-03-28 20:28:18]

https://codereview.chromium.org/1840793002/diff/1/docs/getting-started.md
File docs/getting-started.md (right):

https://codereview.chromium.org/1840793002/diff/1/docs/getting-started.md#new...
docs/getting-started.md:12: You must compile PDFium without V8 or XFA support
for the examples here to work.
nit: without both V8 and XFA support

https://codereview.chromium.org/1840793002/diff/1/docs/getting-started.md#new...
docs/getting-started.md:16: V8 can be compiled out by providing `pdf_enable_v8=0
pdf_enable_xfa=0` to
nit:  move this up to line 13
GYP_DEFINES="pdf_enable_v8=0 pdf_enable_xfa=0" build/gyp_pdfium

https://codereview.chromium.org/1840793002/diff/1/docs/getting-started.md#new...
docs/getting-started.md:22: PDFium has been broken over several headers. You
only need to include the
PDFium's API has been broken up over

https://codereview.chromium.org/1840793002/diff/1/docs/getting-started.md#new...
docs/getting-started.md:23: headers for functionality you need in your
application. The full set of
functionality you use in your application.

https://codereview.chromium.org/1840793002/diff/1/docs/getting-started.md#new...
docs/getting-started.md:31: The first step to using PDFium is to initialize the
library. As well, you'll
Having done so, you'll then need to

https://codereview.chromium.org/1840793002/diff/1/docs/getting-started.md#new...
docs/getting-started.md:72: PDF_LIBS="-lpdfium -lfpdfapi -lfxge -lfpdfdoc
-lfxcrt -lfx_agg \
we really should consolidate our build down into fpdfcore, fpdfsdk, and xfa. 
Someday

[dsinclair, 2016-03-29 01:05:19]

https://codereview.chromium.org/1840793002/diff/1/docs/getting-started.md
File docs/getting-started.md (right):

https://codereview.chromium.org/1840793002/diff/1/docs/getting-started.md#new...
docs/getting-started.md:12: You must compile PDFium without V8 or XFA support
for the examples here to work.
On 2016/03/28 20:28:18, Tom Sepez wrote:
> nit: without both V8 and XFA support

Done.

https://codereview.chromium.org/1840793002/diff/1/docs/getting-started.md#new...
docs/getting-started.md:16: V8 can be compiled out by providing `pdf_enable_v8=0
pdf_enable_xfa=0` to
On 2016/03/28 20:28:18, Tom Sepez wrote:
> nit:  move this up to line 13
> GYP_DEFINES="pdf_enable_v8=0 pdf_enable_xfa=0" build/gyp_pdfium

Done.

https://codereview.chromium.org/1840793002/diff/1/docs/getting-started.md#new...
docs/getting-started.md:22: PDFium has been broken over several headers. You
only need to include the
On 2016/03/28 20:28:18, Tom Sepez wrote:
> PDFium's API has been broken up over

Done.

https://codereview.chromium.org/1840793002/diff/1/docs/getting-started.md#new...
docs/getting-started.md:23: headers for functionality you need in your
application. The full set of
On 2016/03/28 20:28:18, Tom Sepez wrote:
> functionality you use in your application.

Done.

https://codereview.chromium.org/1840793002/diff/1/docs/getting-started.md#new...
docs/getting-started.md:31: The first step to using PDFium is to initialize the
library. As well, you'll
On 2016/03/28 20:28:18, Tom Sepez wrote:
> Having done so, you'll then need to 

Done.

https://codereview.chromium.org/1840793002/diff/1/docs/getting-started.md#new...
docs/getting-started.md:72: PDF_LIBS="-lpdfium -lfpdfapi -lfxge -lfpdfdoc
-lfxcrt -lfx_agg \
On 2016/03/28 20:28:18, Tom Sepez wrote:
> we really should consolidate our build down into fpdfcore, fpdfsdk, and xfa. 
> Someday

I think we could just do pdfium and pdfium_xfa as you can't use core without
sdk, and both parts of those just make pdfium.
pdfium:451

[dsinclair, 2016-03-29 01:55:29]

https://codereview.chromium.org/1840793002/diff/40001/docs/getting-started.md
File docs/getting-started.md (right):

https://codereview.chromium.org/1840793002/diff/40001/docs/getting-started.md...
docs/getting-started.md:87: ## Loading a Document
Added the start of a loading section.

[dsinclair, 2016-03-30 13:30:32]

ping.

[Tom Sepez, 2016-04-01 00:06:20]

https://codereview.chromium.org/1840793002/diff/40001/docs/getting-started.md
File docs/getting-started.md (right):

https://codereview.chromium.org/1840793002/diff/40001/docs/getting-started.md...
docs/getting-started.md:95: Loading an existing document is done in one of three
ways, loading from file,
three ways:

https://codereview.chromium.org/1840793002/diff/40001/docs/getting-started.md...
docs/getting-started.md:96: loading from memory and a custom loader. In all
three cases you'll provide a
memory, or loading via a custom loader.

https://codereview.chromium.org/1840793002/diff/40001/docs/getting-started.md...
docs/getting-started.md:98: If the file is not encrypted the password maybe
`NULL`.
can be

https://codereview.chromium.org/1840793002/diff/40001/docs/getting-started.md...
docs/getting-started.md:100: The two simplest methods are loading from disk and
from memory. To load from
"loading from file and loading from memory" 

we said "file" above, not disk, so s/disk/file/ throughout.

https://codereview.chromium.org/1840793002/diff/40001/docs/getting-started.md...
docs/getting-started.md:101: disk, provide the file to open, including
extension. For loading from memory
file, you'll provide the name of the file

https://codereview.chromium.org/1840793002/diff/40001/docs/getting-started.md...
docs/getting-started.md:102: provide the data buffer containing the PDF and the
length.
you'll provide a data buffer ... and its length.

https://codereview.chromium.org/1840793002/diff/40001/docs/getting-started.md...
docs/getting-started.md:117: document or the file was not found.
or that the file

https://codereview.chromium.org/1840793002/diff/40001/docs/getting-started.md...
docs/getting-started.md:174: The more interesting open is custom loading. Using
a custom loader it's possible
While the above are simple, the preferable technique is to use a custom loader. 
This makes it possible to load pieces of the document only as needed

[dsinclair, 2016-04-01 13:08:52]

https://codereview.chromium.org/1840793002/diff/40001/docs/getting-started.md
File docs/getting-started.md (right):

https://codereview.chromium.org/1840793002/diff/40001/docs/getting-started.md...
docs/getting-started.md:95: Loading an existing document is done in one of three
ways, loading from file,
On 2016/04/01 00:06:19, Tom Sepez wrote:
> three ways:

Done.

https://codereview.chromium.org/1840793002/diff/40001/docs/getting-started.md...
docs/getting-started.md:96: loading from memory and a custom loader. In all
three cases you'll provide a
On 2016/04/01 00:06:19, Tom Sepez wrote:
> memory, or loading via a custom loader.

Done.

https://codereview.chromium.org/1840793002/diff/40001/docs/getting-started.md...
docs/getting-started.md:98: If the file is not encrypted the password maybe
`NULL`.
On 2016/04/01 00:06:19, Tom Sepez wrote:
> can be

Done.

https://codereview.chromium.org/1840793002/diff/40001/docs/getting-started.md...
docs/getting-started.md:100: The two simplest methods are loading from disk and
from memory. To load from
On 2016/04/01 00:06:19, Tom Sepez wrote:
> "loading from file and loading from memory" 
> 
> we said "file" above, not disk, so s/disk/file/ throughout.
> 
> 

Done.

https://codereview.chromium.org/1840793002/diff/40001/docs/getting-started.md...
docs/getting-started.md:101: disk, provide the file to open, including
extension. For loading from memory
On 2016/04/01 00:06:19, Tom Sepez wrote:
> file, you'll provide the name of the file

Done.

https://codereview.chromium.org/1840793002/diff/40001/docs/getting-started.md...
docs/getting-started.md:102: provide the data buffer containing the PDF and the
length.
On 2016/04/01 00:06:19, Tom Sepez wrote:
> you'll provide a data buffer ... and its length.

Done.

https://codereview.chromium.org/1840793002/diff/40001/docs/getting-started.md...
docs/getting-started.md:117: document or the file was not found.
On 2016/04/01 00:06:20, Tom Sepez wrote:
> or that the file

Done.

https://codereview.chromium.org/1840793002/diff/40001/docs/getting-started.md...
docs/getting-started.md:174: The more interesting open is custom loading. Using
a custom loader it's possible
On 2016/04/01 00:06:19, Tom Sepez wrote:
> While the above are simple, the preferable technique is to use a custom
loader. 
> This makes it possible to load pieces of the document only as needed

Done.

[Tom Sepez, 2016-04-01 16:44:01]

On 2016/04/01 13:08:52, dsinclair wrote:
> https://codereview.chromium.org/1840793002/diff/40001/docs/getting-started.md
> File docs/getting-started.md (right):
> 
>
https://codereview.chromium.org/1840793002/diff/40001/docs/getting-started.md...
> docs/getting-started.md:95: Loading an existing document is done in one of
three
> ways, loading from file,
> On 2016/04/01 00:06:19, Tom Sepez wrote:
> > three ways:
> 
> Done.
> 
>
https://codereview.chromium.org/1840793002/diff/40001/docs/getting-started.md...
> docs/getting-started.md:96: loading from memory and a custom loader. In all
> three cases you'll provide a
> On 2016/04/01 00:06:19, Tom Sepez wrote:
> > memory, or loading via a custom loader.
> 
> Done.
> 
>
https://codereview.chromium.org/1840793002/diff/40001/docs/getting-started.md...
> docs/getting-started.md:98: If the file is not encrypted the password maybe
> `NULL`.
> On 2016/04/01 00:06:19, Tom Sepez wrote:
> > can be
> 
> Done.
> 
>
https://codereview.chromium.org/1840793002/diff/40001/docs/getting-started.md...
> docs/getting-started.md:100: The two simplest methods are loading from disk
and
> from memory. To load from
> On 2016/04/01 00:06:19, Tom Sepez wrote:
> > "loading from file and loading from memory" 
> > 
> > we said "file" above, not disk, so s/disk/file/ throughout.
> > 
> > 
> 
> Done.
> 
>
https://codereview.chromium.org/1840793002/diff/40001/docs/getting-started.md...
> docs/getting-started.md:101: disk, provide the file to open, including
> extension. For loading from memory
> On 2016/04/01 00:06:19, Tom Sepez wrote:
> > file, you'll provide the name of the file
> 
> Done.
> 
>
https://codereview.chromium.org/1840793002/diff/40001/docs/getting-started.md...
> docs/getting-started.md:102: provide the data buffer containing the PDF and
the
> length.
> On 2016/04/01 00:06:19, Tom Sepez wrote:
> > you'll provide a data buffer ... and its length.
> 
> Done.
> 
>
https://codereview.chromium.org/1840793002/diff/40001/docs/getting-started.md...
> docs/getting-started.md:117: document or the file was not found.
> On 2016/04/01 00:06:20, Tom Sepez wrote:
> > or that the file
> 
> Done.
> 
>
https://codereview.chromium.org/1840793002/diff/40001/docs/getting-started.md...
> docs/getting-started.md:174: The more interesting open is custom loading.
Using
> a custom loader it's possible
> On 2016/04/01 00:06:19, Tom Sepez wrote:
> > While the above are simple, the preferable technique is to use a custom
> loader. 
> > This makes it possible to load pieces of the document only as needed
> 
> Done.

Ok, looks good so far, do you want to land this or keep on going?

[dsinclair, 2016-04-01 20:15:22]

On 2016/04/01 16:44:01, Tom Sepez wrote:
> Ok, looks good so far, do you want to land this or keep on going?


Land now, add on later I think. Getting the structure in place lets people start
expanding it.

[Tom Sepez, 2016-04-01 20:42:36]

The CQ bit was checked by tsepez@chromium.org

[Tom Sepez, 2016-04-01 20:42:37]

lgtm

[commit-bot: I haz the power, 2016-04-01 20:42:46]

CQ is trying da patch. Follow status at
 https://chromium-cq-status.appspot.com/patch-status/1840793002/60001
View timeline at
 https://chromium-cq-status.appspot.com/patch-timeline/1840793002/60001

[commit-bot: I haz the power, 2016-04-01 20:54:40]

Description was changed from

==========
Starting to add some documentation.

This CL adds the beginnings of a Geting Started document for PDFium and adds
the navbar.md file to get navigation on the markdown files when rendered by
Gitiles.
==========

to

==========
Starting to add some documentation.

This CL adds the beginnings of a Geting Started document for PDFium and adds
the navbar.md file to get navigation on the markdown files when rendered by
Gitiles.

Committed:
https://pdfium.googlesource.com/pdfium/+/23863e4c86a99381c1bd83e76c9055b10a8b...
==========

[commit-bot: I haz the power, 2016-04-01 20:54:41]

Committed patchset #4 (id:60001) as
https://pdfium.googlesource.com/pdfium/+/23863e4c86a99381c1bd83e76c9055b10a8b...