There is no help page for the module. It would be helpful if we implement help page.

Issue fork paragraphs-2854168

Command icon Show commands

Start within a Git clone of the project using the version control instructions.

Or, if you do not have SSH keys set up on git.drupalcode.org:

Support from Acquia helps fund testing for Drupal Acquia logo

Comments

Munavijayalakshmi created an issue. See original summary.

Munavijayalakshmi’s picture

Status: Active » Needs review
FileSize
1.14 KB
johnchque’s picture

Status: Needs review » Needs work
+++ b/paragraphs.module
@@ -1455,4 +1455,22 @@ function paragraphs_modules_uninstalled($modules) {
+function paragraphs_help($path, $arg) {
+    switch ($path) {

Please check indentation, it should be 2 spaces.

Munavijayalakshmi’s picture

Status: Needs work » Needs review
FileSize
1.1 KB
toncic’s picture

Status: Needs review » Needs work

You forgot to upload interdiff.

Munavijayalakshmi’s picture

Status: Needs work » Needs review
FileSize
1.89 KB
Munavijayalakshmi’s picture

Assigned: Munavijayalakshmi » Unassigned
dhruveshdtripathi’s picture

Status: Needs review » Needs work

According to standards, Help text should have About and Uses. Uses is not there in the last patch.

dhruveshdtripathi’s picture

Status: Needs work » Needs review
FileSize
2.44 KB
tduong’s picture

Status: Needs review » Needs work
  1. +++ b/paragraphs.module
    @@ -34,6 +34,35 @@ require_once dirname(__FILE__) . '/paragraphs.field_widget.inc';
    +      $output .= '<p>' . t('Paragraph is a module to create paragraphs in your content. You can create bundles(with own display and fields) as paragraph types. When you add a paragraph field to your node/entity, you can select the allowed bundles, and when using the field, you can select a paragraph type from the allowed bundles to use different fields/display per paragraph.') . '</p>';
    

    Missing space.
    Actually I'm not sure if 'bundle(s)' is fine/clear to the end-user that reads this, or we should use "paragraph type(s)" instead...

  2. +++ b/paragraphs.module
    @@ -34,6 +34,35 @@ require_once dirname(__FILE__) . '/paragraphs.field_widget.inc';
    +      $output .= '<p><dt>' . t('Enable the Paragraph module.') . '</dt></p>';
    +      $output .= '<p><dt>' . t('Add new languages for the translation in Configuration » Languages.') . '</dt></p>';
    +      $output .= '<p><dt>' . t('Enable any custom content type with a paragraph field to be translatable in Configuration » Content language and translation:') . '</dt></p>';
    +      $output .= '<p><dd>' . t('Under Custom language settings check Content.') . '</dd></p>';
    +      $output .= '<p><dd>' . t('Under Content check the content type with a paragraph field.') . '</dd></p>';
    +      $output .= '<p><dd>' . t('Make sure that the paragraph field is set to NOT translatable.') . '</dd></p>';
    +      $output .= '<p><dd>' . t('Set the fields of each paragraph type to translatable as required.') . '</dd></p>';
    +      $output .= '<p><dt>' . t('Check Paragraphs as the embedded reference in Configuration » Translation Management settings.') . '</dt></p>';
    +      $output .= '<p><dt>' . t('Create a new content - Paragraphed article and translate it.') . '</dt></p>';
    

    The chapter label for this part should be "Configuration" instead of "Uses".
    Noticed that it is a copy/paste from the README.md file (the 8.x-1.x version actually).

    Also I'm not sure how "»" looks on the UI, so maybe ">" (?), but.. fine.

shalini_jha made their first commit to this issue’s fork.

akshaydalvi212’s picture

Assigned: Unassigned » akshaydalvi212

I will work on another approach for implementing hook_help().

akshaydalvi212’s picture

Assigned: akshaydalvi212 » Unassigned
Status: Needs work » Needs review
FileSize
3.65 KB
102.34 KB

Implemented the hook_help() with README file.
patch #9 was not getting applied(screenshot is provided for reference).
kindly review the new patch.