GithubHelp home page GithubHelp logo

digitalcarleton / omekafootnotesjs Goto Github PK

View Code? Open in Web Editor NEW
3.0 6.0 0.0 1.67 MB

An Omeka plugin to add interactive JavaScript footnotes to exhibit pages and simple pages by extending the TinyMCE wysiwyg HTML editor.

PHP 1.25% JavaScript 39.06% CSS 22.54% SCSS 37.14%
omeka-plugin

omekafootnotesjs's Introduction

OmekaFootnotesJS

Summary

An Omeka plugin to add interactive JavaScript footnotes to exhibit pages and simple pages by extending the TinyMCE wysiwyg HTML editor.

This plugin uses Bigfoot.js version 2.1.4

Footnotes in action:

Footnote being activated

Installation

  1. Make sure you have ExhibitBuilder and SimplePages installed in your Omeka site

  2. Install the OmekaFootnotesJS plugin

  3. Add '*.id' to Allowed HTML Attributes in Omeka security settings and save changes.

Add *.id to allowed HTML Attributes field

Use Instructions

1. To add/edit footnotes:

a. Position your cursor in the place you'd like to add a footnote, then press the "Add Footnote" button on the toolbar. A footnote link will be inserted at that point, and a footnote text snippet will appear at the end of the text block.

b. To change the content of the footnote, edit the text snippet at the bottom of the editor that corresponds to your numbered footnote. If citing a source, best practice is to do so in a standard bibliographic format for your discipline and apply a link if it can be accessed online.

c. Refer to (3) to update the order of your footnotes if necessary (in most cases, this should be handled automatically).

Add Footnote Image

2. To remove a footnote:

a. Highlight the footnote link in the text. You may highlight multiple footnotes at the same time, but note that all footnotes you highlight will be deleted.

b. Press the "Delete Selected Footnotes" button on the toolbar. The footnotes you selected, along with their associated text snippets, will be removed.

c. Refer to (3) to update the order of your footnotes if necessary (in most cases, this should be handled automatically).

Delete Footnote Image

3. To reorder footnotes:

a. Press the "Update Footnotes" button on the toolbar. This will reorder your footnotes in order of appearance.

Update Footnote Image

License

This plugin is published under GNU/GPL.

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.

Contact

Maintained by Digital Humanities @ Carleton College

omekafootnotesjs's People

Contributors

alexanderlewis99 avatar apjmason avatar padillac avatar zhangshyue avatar

Stargazers

 avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar

omekafootnotesjs's Issues

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.