.PDF Export Prototype ready for ODFW Review

[rhodges]

Have an example of PDF export for ODFW to use as shared language to tell us what they ACTUALLY want (in detail).

[pollardld]

Areas of current PDFs, example, that will not be replicable in generated PDFs

Content within a single text area

When content differs (pdf vs web) within a single text area. For example:

Ecoregions - PDF version has map included between what falls within a single text area in web version

PDF	Web

---

Posts do not include data for footer

example:

Oregon Conservation Strategy 2016: Ecoregions-86

---

~Strategy species on Ecoregion posts~

~strategy species are not referenced in ecoregion posts, so there is no way to know which species need to be included in each ecoregion~

~- Referenced in strategy species posts~

~Possible solutions:~

• ~direct query~
• ~new meta box for ecoregions to find strategy species~

SOLVED

• New shortcode created for [post_strategy_species]

Step 1:

• inside the KalinsPDF_callback class create function for new post meta in kalins-php-creation-station.php file
• loop through metadata array and output to a string variable
• return the output string
• see postStrategySpecies

Step 2:

• inside the function kalins_pdf_page_shortcode_replace create a new variable for the shortcode
• i.e.

  $str = preg_replace_callback('#\[ *post_strategy_species *(id=[\'|\"]([^\'\"]*)[\'|\"])? *\]#', array(&$postCallback, 'postStrategySpecies'), $str);

Step 3:

• add the new shortcode to the pdf file template you are createing in wordpress example:

  [post_strategy_species]

---

~ ### Conservation opportunity areas on Ecoregion posts~
~COAs are not referenced in ecoregion posts, so there is no way to know which COAs need to be included in each ecoregion~

~- Referenced in strategy species posts~

~Possible solutions:~

• ~direct query~
• ~new meta box for ecoregions to find strategy species~

SOLVED

• new shortcode created [post_eco_coa]

---

~### Limiting factors and recommended approaches~
~1. Where is content coming from?~ ~2. If content coming from post type, would need to know the maximum number a post could have. We have no way to loop through a list and need to be explicit for each factor and approach. The maximum number will work because there is no error thrown for missing factors and approaches~

~Solution~

• ~set loop count very high~

SOLVED

• New shortcode created for limiting factors [post_limiting_factors]

Step 1:

• inside the KalinsPDF_callback class create function for new post meta in kalins-php-creation-station.php file
• loop through metadata array and output to a string variable
• return the output string example:

  function postMetaLimitingFactors($matches) {
  $the_field = get_post_meta( get_the_ID(), 'factors_repeat_group', true );
  $s = '';
  foreach($the_field as $entries => $entry ) {
    $s = $s . apply_filters('the_content', $entry['ecoregion_meta_factor_title']) . apply_filters('the_content', $entry['ecoregion_meta_factor_description']) . apply_filters('the_content', $entry['ecoregion_meta_approach']);
  }
  return $s;
  }

  Step 2:

• inside the function kalins_pdf_page_shortcode_replace create a new variable for the shortcode example:

  $str = preg_replace_callback('#\[ *post_limiting_factors *(name=[\'|\"]([^\'\"]*)[\'|\"])? *\]#', array(&$postCallback, 'postMetaLimitingFactors'), $str);

Step 3:

• add the new shortcode to the pdf file template you are createing in wordpress example:

  [post_limiting_factors name="factors_repeat_group"]

---

~### Any brackets are outputted as a string~
~For any meta box that uses brackets ("[ ]"), which is handy for pulling wordpress content into a post, anything between the brackets will get outputted as a string~

PARTIALLY SOLVED
Added a preg_replace function that matches for [caption] brackets and replaces those with an empty string if found. Full function:

if (preg_match('/\[caption[^\]]*\]/', $str, $output)) {
    //remove all captions surrounding images and whatnot since tcpdf can't interpret them (but leave the images in place)
    $str = preg_replace('/\[caption[^\]]*\]/', '', $str);//replace all instances of the opening caption tag
    $str = preg_replace('/\[\/caption\]/', '', $str);//replace all instances of the closing caption tag
  }

Will need a new similar function for each shortcode we find. This is because shortcodes are named by the developer.

---

[pollardld]

Ready for review: ecoregions.pdf

[pollardld]

Review Feedback

Todo:

• [x] Character set (encoding): the apostrophe character being used is not being interpreted correctly:
  • For example: page 3 - "Oregon Conservation Strategy ecoregions provide information on each of Oregon’s nine ecoregions..."
  • I suspect much of the text content was written in a Word doc then copied into WordPress, preserving Microsoft's stylized special characters
  • See if you can't set the .PDF export to use Unicode or at least a set with more characters like Latin-1 to see if that fixes some issues
  • If not, see if you can't insert a pre-processor to detect the most common special characters and replace them with appropriate ASCII versions.
• [x] Photo Caption markup:
  • there's some lingering markup text that gets printed around photos and their captions
  • for example on pages 6-7 around photo of Middle Fork of John Day [caption id="attachment_5583" align="alignnone" width="492"] ... [/caption]
• [x] Random numbers:
  • Every few pages there's a random number sitting by itself
  • For example: Page 12, under "Limiting Factors And Approaches", the number "2544" shows up.
  • Do we know where this is coming from and/or why this is happening?
• [x] Add meta box for strategy species