Issue #3047723 by jhodgdon, adevms, narnua, alonaoneill, Gayathri J, irenebreiner, Amber Himes Matz: Convert views, views_ui module hook_help() to topic(s)
Lee Rowlands
parent
f11d93fb90
commit
2651a4954f
|
|
@ -0,0 +1,30 @@
|
|||
---
|
||||
label: 'Managing content listings (views)'
|
||||
top_level: true
|
||||
related:
|
||||
- block.overview
|
||||
---
|
||||
<h2>{% trans %}What is a view?{% endtrans %}</h2>
|
||||
<p>{% trans %}A <em>view</em> is a listing of items on your site; for example, a block showing the most recent comments, a page listing news items, or a list of registered users. The listings can be formatted in a table, grid, list, calendar, RSS feed, and other formats (some output formats may require you to install additional contributed modules).{% endtrans %}</p>
|
||||
<h2>{% trans %}What are the components of a view?{% endtrans %}</h2>
|
||||
<p>{% trans %}When you first create a view, you will specify what type of <em>base data</em> is being displayed in the view, which cannot be changed. After choosing a base data type, you can edit the following components, which allow you to specify which data to output, in what order, and in what format:{% endtrans %}</p>
|
||||
<ul>
|
||||
<li>{% trans %}<em>Displays</em>: whether the output goes to a page, block, feed, etc.; a single view can have multiple displays, each with different settings.{% endtrans %}</li>
|
||||
<li>{% trans %}<em>Format</em>: the output style for each display, such as content item, grid, table, or HTML list.{% endtrans %}</li>
|
||||
<li>{% trans %}<em>Fields</em>: if the Format allows, the particular fields to display.{% endtrans %}</li>
|
||||
<li>{% trans %}<em>Filter criteria</em>: criteria to limit the data to output, such as whether the content is published, the type of content, etc. Filters can be <em>exposed</em> to let users choose how to filter the data.{% endtrans %}</li>
|
||||
<li>{% trans %}<em>Sort criteria</em>: how to order the data. Sorting can also be exposed to users.{% endtrans %}</li>
|
||||
<li>{% trans %}<em>Page settings</em>, <em>Block settings</em>, etc.: settings specific to the display type, such as the URL for a page display.{% endtrans %}</li>
|
||||
<li>{% trans %}<em>Header</em> and <em>Footer</em>: content to display at the top or bottom of the view display.{% endtrans %}</li>
|
||||
<li>{% trans %}<em>No results behavior</em>: what to do if the filter criteria result in having no data to display.{% endtrans %}</li>
|
||||
<li>{% trans %}<em>Pager</em>: how many items to display, and how to paginate if there are additional items to display.{% endtrans %}</li>
|
||||
<li>{% trans %}<em>Advanced</em> > <em>Contextual filters</em>: like regular filters, except the criteria come from the <em>context</em>, such as the current date, page the view is displayed on, etc.{% endtrans %}</li>
|
||||
<li>{% trans %}<em>Advanced</em> > <em>Relationships</em>: additional data to pull in and display, related in some way to the base data of the view (such as data about the user who created the content item).{% endtrans %}</li>
|
||||
<li>{% trans %}<em>Advanced</em> > <em>Exposed form</em>: if you have exposed filters or sorts, how to display the form to the user.{% endtrans %}</li>
|
||||
</ul>
|
||||
<h2>{% trans %}Managing views overview{% endtrans %}</h2>
|
||||
<p>{% trans %}The core Views module handles the display of views, and the core Views UI module allows you to create, edit, and delete views in the administrative interface. See the related topics listed below for specific tasks (if the Views UI module is installed).{% endtrans %}</p>
|
||||
<h2>{% trans %}Additional resources{% endtrans %}</h2>
|
||||
<ul>
|
||||
<li>{% trans %}<a href="https://www.drupal.org/docs/user_guide/en/views-chapter.html">Views chapter in the User Guide</a>{% endtrans %}</li>
|
||||
</ul>
|
||||
|
|
@ -0,0 +1,18 @@
|
|||
---
|
||||
label: 'Adding a new display to an existing view'
|
||||
related:
|
||||
- views.overview
|
||||
- views_ui.edit
|
||||
---
|
||||
{% set views = render_var(url('entity.view.collection')) %}
|
||||
{% set view_edit = render_var(url('help.help_topic', {'id': 'views_ui.edit'})) %}
|
||||
<h2>{% trans %}Goal{% endtrans %}</h2>
|
||||
<p>{% trans %}Add a new display to an existing view. This will allow you to display similar data to an existing view, using similar settings, in a new block, page, feed, etc.{% endtrans %}</p>
|
||||
<h2>{% trans %}Steps{% endtrans %}</h2>
|
||||
<ol>
|
||||
<li>{% trans %}If you are not already editing your view, in the <em>Manage</em> administrative menu, navigate to <em>Structure</em> > <a href="{{ views }}"><em>Views</em></a>. Find the view you want to edit, and click its <em>Edit</em> link.{% endtrans %}</li>
|
||||
<li>{% trans %}Under <em>Displays</em>, click <em>Add</em>.{% endtrans %}</li>
|
||||
<li>{% trans %}In the pop-up list, click the link for the type of display you want to add; the most common types are <em>Page</em> and <em>Block</em>. The new display will be added to your view, and you will be editing that display.{% endtrans %}</li>
|
||||
<li>{% trans %}Optionally, click the link next to <em>Display name</em> and enter a new name to be shown for this display in the administrative interface.{% endtrans %}</li>
|
||||
<li>{% trans %}Follow the steps in <a href="{{ view_edit }}">Editing an existing view display</a> to edit the other settings for the display.{% endtrans %}</li>
|
||||
</ol>
|
||||
|
|
@ -0,0 +1,19 @@
|
|||
---
|
||||
label: 'Creating a new view'
|
||||
related:
|
||||
- views.overview
|
||||
- views_ui.edit
|
||||
- views_ui.add_display
|
||||
---
|
||||
{% set views = render_var(url('entity.view.collection')) %}
|
||||
<h2>{% trans %}Goal{% endtrans %}</h2>
|
||||
<p>{% trans %}Create a new view to list content or other items on your site.{% endtrans %}</p>
|
||||
<h2>{% trans %}Steps{% endtrans %}</h2>
|
||||
<ol>
|
||||
<li>{% trans %}In the <em>Manage</em> administrative menu, navigate to <em>Structure</em> > <a href="{{ views }}"><em>Views</em></a>.{% endtrans %}</li>
|
||||
<li>{% trans %}Click <em>Add view</em>.{% endtrans %}</li>
|
||||
<li>{% trans %}In the <em>View name</em> field, enter a name for the view, which is how it will be listed in the administrative interface.{% endtrans %}</li>
|
||||
<li>{% trans %}In <em>View settings</em> > <em>Show</em>, select the base data type to display in your view. This cannot be changed later.{% endtrans %}</li>
|
||||
<li>{% trans %}Optionally, select or enter filtering, sorting, and page/block display settings; these can be added or changed later.{% endtrans %}</li>
|
||||
<li>{% trans %}Click <em>Save and edit</em>. Your view will be created; edit it following the steps in the related topics below.{% endtrans %}</li>
|
||||
</ol>
|
||||
|
|
@ -0,0 +1,24 @@
|
|||
---
|
||||
label: 'Editing an existing view display'
|
||||
related:
|
||||
- views.overview
|
||||
- views_ui.add_display
|
||||
---
|
||||
{% set views = render_var(url('entity.view.collection')) %}
|
||||
{% set overview = render_var(url('help.help_topic', {'id': 'views.overview'})) %}
|
||||
<h2>{% trans %}Goal{% endtrans %}</h2>
|
||||
<p>{% trans %}Edit an existing view display, to modify what data is displayed or how it is displayed.{% endtrans %}</p>
|
||||
<h2>{% trans %}Steps{% endtrans %}</h2>
|
||||
<ol>
|
||||
<li>{% trans %}If you are not already editing your view, in the <em>Manage</em> administrative menu, navigate to <em>Structure</em> > <a href="{{ views }}"><em>Views</em></a>. Find the view you want to edit, and click its <em>Edit</em> link.{% endtrans %}</li>
|
||||
<li>{% trans %}Under <em>Displays</em>, click the display you want to edit.{% endtrans %}</li>
|
||||
<li>{% trans %}Find the section whose settings you want to change, such as <em>Format</em> or <em>Filter criteria</em> (see <a href="{{ overview }}">Managing content listings (views)</a> for more information).{% endtrans %}</li>
|
||||
<li>{% trans %}For sections containing lists (such as <em>Fields</em> and <em>Filter criteria</em>), to modify or delete an existing item, click the name of the item. To add a new item, click <em>Add</em> in the drop-down list. To change the order of items, click <em>Rearrange</em> in the drop-down list.{% endtrans %}</li>
|
||||
<li>{% trans %}For sections containing individual settings (such as <em>Title</em> and <em>Format</em>), there are often two links for each setting. The first link shows the current value; click that link to change the value. If there is a second link called <em>Settings</em>, click that link to change the settings details. For example, if your <em>Format</em> is currently shown as <em>Unformatted list</em>, click <em>Unformatted list</em> to switch to using a <em>Grid</em> or <em>Table</em> format. Click <em>Settings</em> next to your format type to change the settings for your chosen format.{% endtrans %}</li>
|
||||
<li>{% trans %}When you have finished changing all the settings, verify that the display is correct by clicking <em>Update preview</em>. Return to editing settings if necessary.{% endtrans %}</li>
|
||||
<li>{% trans %}When you have verified the display, click <em>Save</em>. Alternatively, if you have made mistakes and want to discard your changes, click <em>Cancel</em>.{% endtrans %}</li>
|
||||
</ol>
|
||||
<h2>{% trans %}Additional resources{% endtrans %}</h2>
|
||||
<ul>
|
||||
<li>{% trans %}<a href="https://www.drupal.org/docs/user_guide/en/views-chapter.html">Views chapter in the User Guide</a>{% endtrans %}</li>
|
||||
</ul>
|
||||
Loading…
Reference in New Issue