Updating documentation

[likemusic]

This library has some helpfull config options and methods that not covered in documentation ($cfg's 'ignore_filter_decoding_errors' and 'ignore_missing_filter_decoders' options, Page's getDataTm() and getTextXY() methods e.t.c.).

[k00ni]

That is on my TODO list for a while and I plan to propose some improvements in January 2022.

[Reqrefusion]

Hello, I also made some suggestions about documentation before. I thought it would be good to solve this problem with the wiki page. This is quite appropriate, especially considering the way the project is progressing. I invite you to contribute to the wiki.

[k00ni]

Thank you for your contributions here @Reqrefusion.

I personally don't like usage of our Wiki, because it can be changed by everyone (with no way to approve/decline changes). My suggestion would be to utilize Markdown-files (like DEVELOPER.md), because we can use pull requests.

Its sad that @smalot is off for a while again, because documentation at pdfparser.org's is also outdated and we should discuss a way how to organize documentation in general.

[Reqrefusion]

My pleasure, @k00ni

I personally hate github's wiki. It doesn't even have the most basic features that a wiki should have. In our previous discussion, I said that I see the wiki as a temporary place until I prepare an in-file documentation.

My suggestion is to use the wiki until you create a Markdown-file (like DEVELOPER.md) in January. While creating this file, you can easily benefit from the wiki and your job will be easier.

The current wiki is a good start to prepare a documentation. Considering its current length, I think that this documentation should be a single page and we should use the pages in the wiki as headings. If a title exceeds a certain number of characters, it can be made as a separate page. However, I don't think this will happen in the beginning.

[k00ni]

TODOs:

• Check new code from Make horizontal offset configurable #505 when updating documentation.
• Fix Base63 part in README.md: Here you will also find information about how to handle Base63 encoded PDFs.

[Reqrefusion]

• Preparing a more detailed briefing for the config.
  I found this necessary because @rubenvanerk provides solutions to some problems by using the config feature. He had already made an addition in this direction on the wiki page. I also added a table. But still work in process.

[rubenvanerk]

Maybe it's also an idea to have a 'Common problems' section with possible solutions.

[k00ni]

Thanks again for the work on the wiki folks.

After #500 is done (hopefully end of January) we should focus on documentation. Until then, is there anything "missing" in documentation and/or wiki which you would like to include?

Would it be sufficient to just "copy" the wiki and merge it into the README.md with a few style improvements?

[rubenvanerk]

A section with limitations would also be useful. Like parsing form fields.

Adding all the wiki documentation to the readme might be a bit much, but I think it could work.

[k00ni]

I haven't forgotten but I am very busy currently. If anyone want to propose something via pull request, feel free.

My approach would be to split (wiki) documentation into different files in doc folder. I would also remove some stuff from README.md and maybe update other info.