Download & Extend
Issues

[META] Document all views plugins types

Posted by dawehner on January 7, 2013 at 9:35pm
Project:Drupal core
Version:8.x-dev
Component:documentation
Category:task
Priority:normal
Assigned:Unassigned
Status:active
Issue tags:documentation, Novice, VDC

Issue Summary

Similar to #1871762: Add detailed documentation explaining the block system's architecture we want to document the available plugin types in views in all the base plugins.

This for sure could/should be done later, but just want to create an issue for it.

Login or register to post comments

Comments

#1

Posted by xjm on January 8, 2013 at 11:49am

This is sort of a duplicate of part of the scope defined in #1856544: [META] Views documentation improvements, but let's use it as a sub-issue. From that issue:

While views.api.php has been updated to Drupal 8, basic explanations for handler plugin types are missing.

All base plugins and handlers need significantly more documentation.

This is also the sort of docs issue that we can allow now, since it's critical documentation. (In fact "Basic API docs for all base plugins & important objects complete" is on our D8 goals chart for Feb. 18).

#2

Posted by xjm on January 8, 2013 at 12:12pm
Title:Document all views plugins types» [META] Document all views plugins types

Let's make this an easier novice task by creating sub-issues for each base plugin. To help with this issue:

  1. Look in the core/modules/views/lib/Drupal/views/Plugin/views directory.
  2. There is a sub-directory for each plugin type:
    • access
    • area
    • argument
    • argument_default
    • argument_validator
    • cache
    • display
    • display_extender
    • exposed_form
    • field
    • filter
    • join
    • pager
    • query
    • relationship
    • row
    • sort
    • style
    • wizard

    Pick one of these plugin types and create an issue for it. Link the issue here, in this issue's summary.

  3. In the directory for your plugin type, there will be a base plugin. Create a patch to add documentation to the documentation block for the class.
  4. See #1871762-3: Add detailed documentation explaining the block system's architecture for an example of how an abstract base plugin can be documented.
  5. Start by making a list of all the plugin annotation keys that are available. You can get an idea of what they are by looking at individual plugins within the same directory.
  6. Make sure the plugin has an @ingroup reference to the group for its plugin or handler type (defined on the base plugin), and that it is at the end of the class docblock.
  7. Try to add an explanation paragraph to the docblock above your list of annotation keys that explains how that plugin type can be used. See views.api.php for some starting point information. The VDC team can also help you with this part.

Two more advanced but very important tasks would be to add such documentation to PluginBase and HandlerBase.

#3

Posted by thsutton on February 9, 2013 at 5:57am
Issue tags:-Novice, -VDC

I've started work on the pager directory in #1912650: Document all views pager plugins types.

#4

Posted by thsutton on February 9, 2013 at 6:00am
Issue tags:+Novice, +VDC

How did I delete the tags?

#5

Posted by thsutton on February 9, 2013 at 6:23am

I've started work on the access directory in #1912658: Document views access plugins.

#6

Posted by dawehner on February 9, 2013 at 9:13am

@thsutton Thanks for working on that!!!!!!!!

nobody click here