Browse Source

Update README to reflect new functionality.

8.x-1.x 8.x-1.0-beta2
Alexander O'Neill 6 years ago
parent
commit
cb4bd4a37f
  1. 85
      README.md
  2. 162
      config/optional/views.view.workd_cited.yml

85
README.md

@ -6,7 +6,7 @@ Contents
* Introduction * Introduction
* Installation * Installation
* Configuration * Use
* Current Maintainers * Current Maintainers
Introduction Introduction
@ -19,44 +19,75 @@ and references.
Installation Installation
------------ ------------
Install and set up the Footnotes module as per its installation instructions, including ### Works Cited field
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.: 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 ```html
<a class href id> <div class id> <span class id> <ul class id type> <a class href id> <div class id> <span class id> <ol class id type>
<ol class id start type> <sup> <li class id> <sup> <li class id>
``` ```
Configuration Use
------------- ---
Add a field to a node type that is an Entity Reference field pointing to See the documentation for [Bibliography and Citation - Import][2] module for how to
Bibcite Reference entities. add citations exported from a citation management system like RefWorks or EndNote.
Go to Admin -> Configuration -> Content Authoring -> Text Formats and Editors. [2]: https://www.drupal.org/project/bibcite
Edit a Rich text format that will include reference footnotes. ### Adding a Works Cited item
Drag the Reference Footnotes button into the active set of buttons in the text format If Inline Entity Form is enabled, an author can create new citations or add references to
you want to use References in and save the settings. previously-imported or created references directly with the 'Add new reference' and
'Add existing reference' buttons.
You will then need to create or import one or more references using the Bibliography & With Inline Entity Form, newly-added citations are immediately selectable in the
Citations project. Those will then appear in a select list when you are editing a text area Reference Footnotes dialog.
and click on the Reference Footnote button.
Optionally you can install Inline Entity Form which allowes a user to If not using the inline entity form, you can select previously imported or created references
create new references directly in the node edit form.
Adding References to Content When you edit the node again, and you click on the Reference Footnote editor toolbar button,
---------------------------- a list of citations will be available to choose from.
If not using the inline entity form, select the references that appear in the ### Citation Formatting
list of referenced Bibcite reference types that should be available to the editor,
ten save the node.
When you edit the node again, and you click on the Reference Footnote button, The Works Cited field will use the Default style selected in the
a list of citaitons will be available to choose from. Bibliography & Citation administration pages at Administration > Configuration >
Bibliography & Citation > Settings in the Processing tab under Processor.'
Current Maintainers Current Maintainers
------------------- -------------------
@ -66,4 +97,4 @@ Current Maintainers
Sponsors Sponsors
-------- --------
* This work is supported by the [University of Prince Edward Island Robertson Librrary](https://library.upei.ca). * This work is supported by the [University of Prince Edward Island Robertson Library](https://library.upei.ca).

162
config/optional/views.view.workd_cited.yml

@ -1,162 +0,0 @@
langcode: en
status: true
dependencies:
config:
- core.entity_view_mode.bibcite_reference.citation
module:
- bibcite_entity
- node
id: workd_cited
label: 'Workd Cited'
module: views
description: 'List of references cited by an article'
tag: ''
base_table: bibcite_reference
base_field: id
core: 8.x
display:
default:
display_plugin: default
id: default
display_title: Master
position: 0
display_options:
access:
type: none
options: { }
cache:
type: tag
options: { }
query:
type: views_query
options:
disable_sql_rewrite: false
distinct: false
replica: false
query_comment: ''
query_tags: { }
exposed_form:
type: basic
options:
submit_button: Apply
reset_button: false
reset_button_label: Reset
exposed_sorts_label: 'Sort by'
expose_sort_order: true
sort_asc_label: Asc
sort_desc_label: Desc
pager:
type: none
options:
items_per_page: null
offset: 0
style:
type: default
row:
type: 'entity:bibcite_reference'
options:
relationship: none
view_mode: citation
fields:
title:
table: bibcite_reference
field: title
id: title
entity_type: null
entity_field: title
plugin_id: field
relationship: none
group_type: group
admin_label: ''
label: ''
exclude: false
alter:
alter_text: false
text: ''
make_link: false
path: ''
absolute: false
external: false
replace_spaces: false
path_case: none
trim_whitespace: false
alt: ''
rel: ''
link_class: ''
prefix: ''
suffix: ''
target: ''
nl2br: false
max_length: 0
word_boundary: true
ellipsis: true
more_link: false
more_link_text: ''
more_link_path: ''
strip_tags: false
trim: false
preserve_tags: ''
html: false
element_type: ''
element_class: ''
element_label_type: ''
element_label_class: ''
element_label_colon: true
element_wrapper_type: ''
element_wrapper_class: ''
element_default_classes: true
empty: ''
hide_empty: false
empty_zero: false
hide_alter_empty: true
click_sort_column: value
type: string
settings: { }
group_column: value
group_columns: { }
group_rows: true
delta_limit: 0
delta_offset: 0
delta_reversed: false
delta_first_last: false
multi_type: separator
separator: ', '
field_api_classes: false
filters: { }
sorts: { }
title: 'Workd Cited'
header: { }
footer: { }
empty: { }
relationships:
reverse__node__field_works_cited:
id: reverse__node__field_works_cited
table: bibcite_reference
field: reverse__node__field_works_cited
relationship: none
group_type: group
admin_label: field_works_cited
required: true
entity_type: bibcite_reference
plugin_id: entity_reverse
arguments: { }
display_extenders: { }
cache_metadata:
max-age: -1
contexts:
- 'languages:language_content'
- 'languages:language_interface'
tags: { }
block_1:
display_plugin: block
id: block_1
display_title: Block
position: 1
display_options:
display_extenders: { }
cache_metadata:
max-age: -1
contexts:
- 'languages:language_content'
- 'languages:language_interface'
tags: { }
Loading…
Cancel
Save