Many new features have come about since the handbook page was conceived, and documentation for these features is scattered throughout the issue queue. Time to bring the handbook page up to date!

I think I want to split it up as well into task-based sections...but first I need to update the content and let things flow from there.

CommentFileSizeAuthor
#4 fillpdf_docs.patch1.72 KBliam morland
#2 fillpdf_docs.patch1.4 KBliam morland

Comments

wizonesolutions’s picture

wizonesolutions
he/him
Primary language English
Location Norway
commented

I've made significant improvements to the documentation.

I still have to document:

  • the download and flatten query string parameters
  • the $access_check_bypass argument to fillpdf_merge_pdf (and that it is a security risk if used improperly)
  • the save as file setting
  • exporting and importing field mappings (a.k.a. "how to update your PDF without losing your field-mapping work")
liam morland’s picture

liam morland
Primary language English
Location Ontario, CA 🇨🇦
commented
Status: Active » Needs review
StatusFileSize
new fillpdf_docs.patch1.4 KB
  1. I have divided the handbook documentation into new pages for Installation and Usage.
  2. On the Usage page, I documented all the query string parameters, including download and flatten.
  3. The attached patch documents all the parameters to fillpdf_merge_pdf(), including $access_check_bypass. At some point, perhaps there should be a handbook page for developers who will be calling these functions directly. A good start would be just to document the functions in the source code.
  4. On the Usage page, I documented how to update your PDF.

I don't know what needs to be documented for "save as file"; that seems to be covered in the text in the UI.

wizonesolutions’s picture

wizonesolutions
he/him
Primary language English
Location Norway
commented
Version: 7.x-1.x-dev » 6.x-1.x-dev
Status: Needs review » Patch (to be ported)

Committed as 450e6ad. Needs backport to 6.x.

liam morland’s picture

liam morland
Primary language English
Location Ontario, CA 🇨🇦
commented
Status: Patch (to be ported) » Needs review
StatusFileSize
new fillpdf_docs.patch1.72 KB

D6 patch attached.

wizonesolutions’s picture

wizonesolutions
he/him
Primary language English
Location Norway
commented
Status: Needs review » Fixed

Committed in 50d8ce9.

Status: Fixed » Closed (fixed)

Automatically closed -- issue fixed for 2 weeks with no activity.

  • Commit 450e6ad on 7.x-1.x, 7.x-2.x, 7.x-2.x-tests1, 7.x-1.x-ubercartbackporttest authored by Liam Morland, committed by wizonesolutions: 
    Issue #1402154: Document fillpdf_parse_uri() better.
wizonesolutions’s picture

wizonesolutions
he/him
Primary language English
Location Norway
commented
Assigned: wizonesolutions » Unassigned
Issue summary: View changes