Skip to content
Snippets Groups Projects
Commit d1671b83 authored by Neel Gopaul's avatar Neel Gopaul Committed by Sascha Grossenbacher
Browse files

Issue #2862099 by dhruveshdtripathi, neel24, neerajpandey, RenatoG: Update template for readme

parent 03e4fcb4
No related branches found
Tags 6.x-1.2-rc2
No related merge requests found
Flag for Drupal 8
=================
CONTENTS OF THIS FILE
---------------------
Contents:
* Introduction
* History and Maintainers
* Requirements
* Installation
* Configuration
* Support
* Themimg
* Support requests
* History and Maintainers
Introduction
INTRODUCTION
------------
The Flag module allows you to define a boolean toggle field and attach it to a
......@@ -17,82 +16,64 @@ node, comment, user, or any entity type. You may define as many of these 'flags'
as your site requires. By default, flags are per-user. This means any user with
the proper permission may chose to flag the entity.
One example use of Flag is to create a "read later" flag for content. Each user
may choose to mark the content as "read later". The site builder can create a
view that displays all the content the user has chosen to read later.
Other flag examples include:
* Favorite
* Mark as spam
* Friend (for users)
You may want to visit the handbook of this module, at:
http://drupal.org/handbook/modules/flag
* For a full description of the module, visit the project page:
https://www.drupal.org/project/flag
History and Maintainers
-----------------------
* To submit bug reports and feature suggestions, or track changes:
https://www.drupal.org/project/issues/flag
This module was formerly known as Views Bookmark, which was originally was
written by Earl Miles. Later versions of Flag were written by Nathan Haug and
Mooffie. Flag 8.x was written by socketwench.
REQUIREMENTS
------------
Current Flag Maintainers:
* Joachim
* Shabana Blackborder
* socketwench
No special requirements.
Installation
INSTALLATION
------------
Flag 8.x is installed like any other Drupal 8 module and requires brief
configuration prior to use.
* Install as you would normally install a contributed Drupal module. Visit
https://www.drupal.org/docs/8/extending-drupal-8/installing-drupal-8-modules
for further information.
1. Download the module to your DRUPAL_ROOT/modules directory, or where ever you
install contrib modules on your site.
2. Go to Admin > Extend and enable the module.
Configuration
CONFIGURATION
-------------
Configuration of Flag module involves creating one or more flags.
1. Go to Admin > Structure > Flags, and click "Add flag".
2. Select the target entity type, and click "Continue".
3. Enter the flag link text, link type, and any other options.
4. Click "Save Flag".
5. Under Admin > People, configure the permissions for each Flag.
1. Go to Admin > Structure > Flags, and click "Add flag".
Once you are finished creating flags, you may choose to use Views to leverage
your new flags.
2. Select the target entity type, and click "Continue".
Support
-------
3. Enter the flag link text, link type, and any other options.
If you experience a problem with flag or have a problem, file a request or
issue on the flag queue at http://drupal.org/project/issues/flag.
4. Click "Save Flag".
DO NOT POST IN THE FORUMS.
5. Under Admin > People, configure the permissions for each Flag.
Once you are finished creating flags, you may choose to use Views to leverage
your new flags.
Posting in the issue queues is a direct line of communication with the module
authors.
SUPPORT REQUESTS
----------------
No guarantee is provided with this software, no matter how critical your
information, module authors are not responsible for damage caused by this
software or obligated in any way to correct problems you may experience.
Before posting a support request, check Recent log entries at
admin/reports/dblog
Licensed under the GPL 2.0.
http://www.gnu.org/licenses/gpl-2.0.txt
Once you have done this, you can post a support request at module issue queue:
https://www.drupal.org/project/issues/flag
Theming
-------
When posting a support request, please inform what does the status report say
at admin/reports/dblog and if you were able to see any errors in
Recent log entries.
Like other modules, copy twig templates from the `templates/` subdirectory
into your theme. You can rename the file to be more or less specific:
HISTORY AND MAINTAINERS
-----------------------
* `flag.html.twig` -- all flag types and nodes.
* `flag--flagID.html.twig` -- flags with the type of *flagId*.
* `flag--flagID--nodeID.html.twig` -- flags with a type of *flagId* only for content with the given ID.
This module was formerly known as Views Bookmark, which was originally was
written by Earl Miles. Later versions of Flag were written by Nathan Haug and
Mooffie. Flag 8.x was written by socketwench.
Alternatively, Themers can also implement their own @ActionLinkType that can be used
for theming specific flags (for more info you can see the flag_count submodule).
Current Maintainers:
* Joachim Noreiko (joachim) - https://www.drupal.org/u/joachim
* Shabana Navas (shabana.navas) - https://www.drupal.org/u/shabananavas
* Tess (socketwench) - https://www.drupal.org/u/socketwench
* Berdir - https://www.drupal.org/u/berdir
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment