From cb4bd4a37fd1c25778eb34afad058ac5271bab1d Mon Sep 17 00:00:00 2001 From: Alexander O'Neill Date: Fri, 12 Apr 2019 05:06:12 -0300 Subject: [PATCH] Update README to reflect new functionality. --- README.md | 85 +++++++---- config/optional/views.view.workd_cited.yml | 162 --------------------- 2 files changed, 58 insertions(+), 189 deletions(-) delete mode 100644 config/optional/views.view.workd_cited.yml diff --git a/README.md b/README.md index 7c0fe1d..aa61306 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ Contents * Introduction * Installation - * Configuration + * Use * Current Maintainers Introduction @@ -19,44 +19,75 @@ and references. Installation ------------ -Install and set up the Footnotes module as per its installation instructions, including -enabling and configuring the Footnotes text filter. If the 'Allowed HTML tags' filter is enabled -you will need to add the following HTML tags for the reference footnotes to display properly.: +### Works Cited field + +1. Go to Administration > Structure > Content Types and edit the type that will include Reference Footnotes +2. In the Manage Fields tab, press Add Field. +3. In "Re-use an existing field" select "Entity reference: field_bibcite_fn_works_cited". +4. Enter an appropriate label and press 'Save and continue'. +5. On the next page select all the items in "Reference type" that should be available to choose from as footnotes. +6. Customize the field under "Manage form display" and "Manage display", typically you'll want to + place the Works Cited field directly under the Body field. See below for configuring with + Inline Entity Form. +7. In "Manage display", select "Rendered entity" in the Format drop-down for the Works Cited field. +8. Press the Settings icon and under "View mode" choose "Citation" - a new view mode created + by this module. + +#### Inline Enity Form + +It's recommended to also install [Inline Entity Form][1] which allowes a user to +create new references directly in the node edit form. + +1. In "Entity Form Display", select ''Inline Entity Form - complex". +2. Press the settings button in the rightmost column. +3. Enabling "Allow users to add new reference entities" and + "Allow users to add existing reference entities" is recommended. + +[1]: https://www.drupal.org/project/inline_entity_form + +### CKEditor filter and toolbar button + +1. Enable the module. +2. Go to Administration > Configuration > Content authoring > Text formats and editors. + 3. Edit the text format you want to add Reference Footnotes to +4. Enable the Reference Footnotes Filter +5. Drag the Reference Footnotes button into the active buttons toolbar. +6. Configure the options for the Reference Footnotes Filter. + +If the 'Allowed HTML tags' filter is enabled add these HTML tags to the allowed list: ```html -