On some production sites the README.txt file is removed or the permissions make it not readable. This causes warning messages and the printer-friendly pages help is not available.

Print is only one of a handful of modules that uses the README.txt file for help information.

I will attach a patch to provide help when the README.txt file is not readable.

The other advantage is that the help is translatable.

Personally, I think it is better to provide help this way rather than displaying the README.txt as help info.

The patch supports both displaying the README.txt to be backwards compatible and help without the README.txt file.

Comments

izmeez created an issue. See original summary.

izmeez’s picture

Status: Active » Needs review
StatusFileSize
new4.87 KB

Attached is a patch for review.

izmeez’s picture

Title: Provide help when README.txt file not readable » Provide PF help when README.txt file not readable
izmeez’s picture

Title: Provide PF help when README.txt file not readable » Provide print module help when README.txt file not readable
StatusFileSize
new4.85 KB

Attached is a re-roll of the patch in comment #2 against the latest 7.x-2.x-dev for review.

izmeez’s picture

Issue summary: View changes
jcnventura’s picture

Status: Needs review » Needs work

I'd rather get rid of embedding the README.txt file.

izmeez’s picture

@jcnventura Sorry, I do not understand what it is you would rather like to see. I simply used what is currently provided as help. Maybe, you can be more explicit as to what you would like to see. Thanks.

jcnventura’s picture

Remove the if (is_readable($readme)) block and condition, and just use the help code you created.

  • jcnventura committed bcaf5a3 on 7.x-2.x
    Issue #2787263 by izmeez, jcnventura: Provide print module help when...
jcnventura’s picture

Status: Needs work » Fixed

Thanks!

Status: Fixed » Closed (fixed)

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