README.txt is missing

I have written a README.txt for the Dynamic Tag Cloud. Please review and give me the things I have to correct in the file.
Thank You.

Reviewed your readme patch, and I think it lacks sections Installation, Configuration, Requirements of a module and maybe even Troubleshooting section.As now you only have About section.See this template for reference.

Yes Sir. I ll work on it and send you the correct formatted document soon. Thank you for the guidance.

What can be given in the Configuration and Requirements section? I have no idea. Any help, please?

Well in the configuration section, you can add how to configure the module to work, add a link to configuration page or just a simple tutorial how to add this block... as in Requirements is usually list of modules that are required that this module can work ( you can see the list in the Extend -> Dynamic Tag Clouds -> Requires).

I am not able to open the Dynamic Tag Cloud module in Extend. What should I do.

Can you please let me know the requirements if that's not an issue for you. Thank you.

I have included the required sections as you have asked for. Please say if anything more is to be updated or to be changed. Thank you.

Thanks for reviewing the module.

Already, module is having README.md file. Hence closing this issue.

Sorry. I was looking at wrong place.

@manojapare , Thanks for the patch, But I think as per coding standard, there are some issues. You can make it correct by using this. Let me know if you have any query.
Please review my attached screenshot.

I have indented the content into less than 80 cols. And also I have removed the extra spaces at the bottom. Please review it. Thank you for the support.

@bhanuprakashnani, Thanks for your quick response, Your change work bit perfect. Still one more change is needed. Review my attached file for same.

Hi Riddhi

I would like to correct you here. Actually only one Line needed to be added where you've pointed the arrow. And one more line needs to be added before Installation. Likewise there should be two blank lines before each and every headings except the first one.

Thanks!

I've uploaded a patch that follows README template I think. Please review and let me know if any changes are needed.

Thanks!

Yeah. I understood. Thanks for the help. The changes look fine to me.

Are there any changes requires so that I can proceed with it.

@dhruveshdtripathi, Thanks for your quick response, Your changes look perfect. Still, one more change is needed. Review my attached file for same.

Agreed! I missed that. On it.

I think that we shouldn't mention the word localhost and replace it with page or site since it depends on what kind of environment drupal is installed ... also under requirements, I would delete it and just add it requires the token module to work.I would delete the configuration section since it just describes how to install the module which is what install section is for(also never use an absolute path in readme since it depends on environment).I would also replace the word clone with install(you can either clone the module with git or installed it with composer).

Thanks @nkoporec for pointing this out.

Suggest if any other changes are needed.

Thanks!

Attached interdiff for patches included in #21 and #25.

Are the changes sufficient or we have to work more on it?

Need to update Readme patch based on #2953492: Make use of Plugin Manager for extending tag cloud styles architecture change using Plugin Manager

I didn't get the thing u asked sir. Can u please elaborate it please ?

@bhanuprakashnani
In #2953492: Make use of Plugin Manager for extending tag cloud styles major architecture change has been committed. Need to add one more section Usage or Adding new tag cloud style plugin in Readme.txt file explaining how other modules can extend this module.

The usage of the module is already given in the introduction section. should I make the usage of the another section below?

Hi all,

As suggested on #30 , have added usage of new architectural changes.
please review and provide suggestions.

Thanks,

Nice patch @Girish-jerk. @RTBC tag can be given.

@bhanuprakashnani IMHO, Please don't copy paste content from some other sites and put it as an introduction for any module. Please try to put relevant content.

1-1 extra lines needed before "CREATE CUSTOM TAG CLOUD STYLE" and "TROUBLESHOOTING".

Also, Numbered lists should be indented 4 spaces. And Bullets denoted by asterisks (*) with hanging indents.

@manojapare
ok. i wnt do that gain. but it thought that comes under the defunition of the module. anyways next time i ll write by my own. thanks.

Some more nitpicks regarding patch in comment #34

1. +++ b/README.txt
   @@ -0,0 +1,72 @@
   +The Dynamic Tag Cloud module provides a Tag Cloud based searching of content. Module provides 2 styles of tag cloud.
   

   lines should wrap at 80 characters

2. +++ b/README.txt
   @@ -0,0 +1,72 @@
   +* Install as you would normally install a contributed Drupal module.
   

   Perhaps includes a link to install directions.
   Visit https://www.drupal.org/node/1897420

3. +++ b/README.txt
   @@ -0,0 +1,72 @@
   +Go to Admin >> Structure >> Block layout and place 'Tag cloud block' in desired region. In tag cloud block you can configure:
   

   line break at 80 characters

4. +++ b/README.txt
   @@ -0,0 +1,72 @@
   +  3. Redirect url - Set the redirection url, when user click on the tag. Token is enabled for this redirection url.
   

   line break at 80 characters

5. +++ b/README.txt
   @@ -0,0 +1,72 @@
   + 1. In your custom module, create new plugin for TagCloud which inherits TagCloudBase class. Or copy paste DefaultTagCloud.php to your custom module and rename it.
   

   line break at 80 characters

6. +++ b/README.txt
   @@ -0,0 +1,72 @@
   +  libraries - List of libraries name defined in your module libraries.yml file for your custom tag cloud style.
   

   line break at 80 characters

7. +++ b/README.txt
   @@ -0,0 +1,72 @@
   +    name - Module/Theme which defines the template. In your case it would be your module name.
   ...
   +  Set newly created tag cloud style in tag cloud block configuration and you are done !!!
   

   line break at 80 characters

8. +++ b/README.txt
   @@ -0,0 +1,72 @@
   +it again. or else try clearing the cache, and then try installing it.
   

   "in the list try deleting"
   should read:
   "in the list, try deleting"

   Capitalize the beginning of a sentence
   " or else try "
   should read
   " Or else try "

Thanks!

Checked the line breaks to less than 80 characters. Made the necessary changes. Please let me know if any more changes are to be made. Thank you for the guidance.

Hello again, Looks good. I appreciate your hard work at re-working these patches...it is difficult to get right the first few times.

Although now that you have wrapped at 80 characters and made the correct formatting to hang your indents, the rest of the hanging indents are inconsistent. I hadn't noticed in the last review, but the numbered list spacing is also inconsistent. I attached a screenshot for clarity.

Also - minor nitpicks and others can weigh in with opinions if they feel I am being too picky.

1. +++ b/README.txt
   @@ -1,9 +1,81 @@
   +* Install as you would normally install a contributed Drupal module.
   

   Perhaps includes a link to install directions.
   Visit https://www.drupal.org/node/1897420

2. +++ b/README.txt
   @@ -1,9 +1,81 @@
   +
   

   Add an additional line break before heading so the formatting is consistent throughout the file.

Took care of the changes u asked me to make. Please mention if something else is to be done. Thanks for the help.

Providing interdiff for patch #38 and #41 .

I have a suggestion for those people who have reviewed this patch previous to me.
I noticed that screenshot are taken and then annotated. May I suggest the use of the browser plugin "Dreditor"?

When Dreditor is installed it provides interface in the issue queue for patch review. A person can highlight code and make code comments easily and the patch is much easier to review as the extension also provides highlights to empty spaces and special characters such as carriage returns and tabs. Screenshot provided of a patch viewing it with and without Dreditor.

Perhaps this will help everybody and their team :)

Marking as needs work. I am sorry to be so nitpicky, but as we are learning it is sometimes best to be aware of all the mishaps, so we can learn from them. :)

Thanks for addressing the install link and the consistent indentation.

1. +++ b/README.txt
   @@ -1,9 +1,83 @@
   +* Install as you would normally install a contributed Drupal module.
   

   Wording is a bit funky.
   Maybe it should read;
   "Install the module as you would normally install a contributed Drupal module."

2. +++ b/README.txt
   @@ -1,9 +1,83 @@
   +     libraries - List of libraries name defined in your module libraries.yml file
   

   wrap at 80 characters and be sure to modify the next line with correct indentation

Checked the line break and the grammar mistake is corrected. Sorry for my silly mistakes. Will take care of them from now. Please review it and mention if any more changes are to be made.

ALmost there!!

1. +++ b/README.txt
   @@ -1,9 +1,83 @@
   +     TagCloudBase class. Or copy paste DefaultTagCloud.php to your custom ¶
   ...
   +     libraries - List of libraries name defined in your module libraries.yml ¶
   

   extra space or special character at the end of lines 54 and 60

2. +++ b/README.txt
   @@ -1,9 +1,83 @@
   +     file for your custom tag cloud style.
   

   should have hanging indent

Made the required changes. Please review it. Thank you.

Hi,

The patch is not getting applied. Error: README.txt no such file or directory. As there is no new mode specified in the patch.

Thanks!!

Hi,

please review the updated patch!!

Thanks!!

Patch is getting applied and looks fine.

Comitted to 8.x-dev. Thanks to all.

+++ b/README.txt
@@ -0,0 +1,82 @@
+ 1. Default - Where tag will be simple listed out with simple styling.
+ 2. Index - Where tag will be indexed, sorted and shown based index selected.
...
+  1. Vocabularies - Select which all vocabulary tags should be listed out.
+  2. Style - Style of tag cloud.
+  3. Redirect url - Set the redirection url, when user click on the tag. Token
+     is enabled for this redirection url.
...
+  1. In your custom module, create new plugin for TagCloud which inherits
+     TagCloudBase class. Or copy paste DefaultTagCloud.php to your custom
+     module and rename it.
+  2. Implement your logic in build() method.
+  3. Change the following in plugin annotation:

Numbered lists indented 4 spaces.

+++ b/README.txt
@@ -0,0 +1,82 @@
+* Install the module as you would normally install a contributed Drupal module.

Bulleted lists indented 1 space.

+++ b/README.txt
@@ -0,0 +1,82 @@
+     is enabled for this redirection url.
+
+CREATE CUSTOM TAG CLOUD STYLE
...
+are done !!!
+
+TROUBLESHOOTING

Two lines prior to headings (except the first one).

+++ b/README.txt
@@ -40,34 +40,36 @@ CONFIGURATION
+           type - template provider module/theme. In your case it would be 'module'
+           name - Module/Theme which defines the template. In your case it would be

Text manually word-wrapped within around 80 cols.

Everything else is good. Just this minor change in 2 lines. After making these small changes you can commit changes and mark it as fixed.

Thanks!

Great! Now I think it follows all the standards.

Committed to 8.x-dev