Motivated by a couple spelling errors and having remembered that it was really hard to understand the install/configuration procedures for Multilingual Support, I set out to contribute some improvements to the README.txt file for upcoming d6 release. I hope you find my changes useful.

Changes include:

  • Improved consistency in terminology:
    • "Simplenews" throughout, instead of "simplenews and Simplenews" except where necessary (eg, to denote lowercase folder name).
    • Standardized terminology between vocabulary and node representations of newsletters. Used "Newsletter issue" to represent a newsletter node, and "Newsletter" or "Newsletter series" (for added clarity where necessary).
  • Improved explanation, sentence structure, and duplicate info in the DESCRIPTION section.
  • Improved explanations in the MULTILINGUAL SUPPORT section.
  • Simplified the SENDING NEWSLETTERS WITH CRON section.
  • Improved explanations of how Simplenews uses the Taxonomy module.
  • Stripped trailing whitespace and converted tabs to spaces.
  • Enforced word wrap at 80 columns.
CommentFileSizeAuthor
#1 simplenews_documentation_improvements.patch11.75 KBjwilson3
simplenews_documentation_improvements.patch11.75 KBjwilson3

Comments

jwilson3’s picture

jwilson3
Primary language English
Location Ecuador
commented
StatusFileSize
new simplenews_documentation_improvements.patch11.75 KB

fixed a grammatical error in one of my additions, re-rolled the patch.

jwilson3’s picture

jwilson3
Primary language English
Location Ecuador
commented
Project: Akismet » Simplenews

Moved to the RIGHT module issue queue. sorry :/

sutharsan’s picture

sutharsan commented
Status: Active » Needs work

Your documentation contribution is very much appreciated, but you have made changes on a very old version. Readme has been completely reworked since. Could you please review and comment the latest dev.

jwilson3’s picture

jwilson3
Primary language English
Location Ecuador
commented

ok i'll have a look at latest dev readme

--message edited... made a mistake :/

sutharsan’s picture

sutharsan commented
Status: Needs work » Closed (fixed)

No activity, closing the issue. Feel free to re-open if you have contributions to the documentation (very much appreciated!).