Guides

Visualizer

Visualizer: Tables and Charts Manager for WordPress plugin can be used to create, manage and embed interactive charts and tables into your posts and pages. This plugin is available upon request. Please email webdev@uconn.edu with your website URL to request for it.

Once enabled, you can click on the Add Media button on a new page or post, click on Visualizations on the left, and then Create New, select the type of the chart and start building it by one of the three ways:

  1. Import data from a CSV file
  2. Import data from a URL
  3. Manually enter data (check the Use text area editor instead checkbox)

Since charts are not accessible, you are required to add some text near the chart to describe the content on the chart and select one of the downloadable format (Advanced>Frontend Actions>Actions, select Print, CSV or Excel). Please follow the accessibility guidelines.

All the created charts are available under Media>Visualizer Library.

Print  CSV  Excel  Copy  
 

The above chart illustrates the number of sites on Aurora that are using the three central themes as of 8/1/2019:
1,462 (74.8%) sites are using Sherman
310 (15.9%) sites are using Hale 2015
183 (9.4%) sites are using Prudence 2018

Private Uploads

Adds visibility options to all uploaded media files with two varieties of control. One type of control allows you to set individual files as being private and also gives you control over the kinds of users that can have access. If you are familiar with the Private Sites plugin then you will notice that the options for the user types are the same.

The other type of control works in tandem with the Private Sites plugin. When you set a site as private, within Settings > Reading : Site Visibility, all files are made private. Individual file controls will not be visible when an entire site is made private.

A user is required to login to view private files and will be prompted to do so when accessing a file directly.
One thing to keep in mind while using this feature is that setting a file as private moves the file to a different folder on the server thus changing the URL.

Courses Plugin

Courses plugin can provide details to display UConn’s course offerings from the Student Administration System, with real-time enrollment and wait list space (if available) information.  This plugin is enabled upon request. Please email webdev@uconn.edu with your website URL to request for this plugin.

Once enabled, site administrators will see a Courses configuration page (Dashboard>Settings>Courses) with the instructions on how to set up the plugin. You can also select which fields to be displayed and reorder them from the configuration page. Using courses shortcodes, you can build a Course Directory, Course List by Subject or Class Details page.

Papercite

Table of contents

  1. File data structure
  2. BibTex entries: how to store BibTeX entries, how special bibtex fields are used
  3. Attached files: how files associated to one bibtex entry can be detected
  4. Usage: describes the two ways to use papercite
  5. Options
    1. Global options
    2. Local options
    3. Formatting entries
    4. Grouping entries
    5. Sorting entries

    Data structure

    Using the Media Library

    It is possible to use the WordPress media library. In this case, the name of the file is controlled by the permalink. By default, the permalink is a processed version of the file name: the name is lowercased, extension is removed, etc. Due to WordPress limitations, it is necessary to attach the media file to a post before being able to edit the permalink.

    The matching process is determined by the papercite option page. See the help on attached files.

    Note that bibtex files are matched using the same process, with application/x-bibtex as the mime-type and no suffix.

    BibTex entries

    Location BibTeX entries


    BibTex files can be stored:

    • Anywhere on the Internet – papercite will download any file if the file begins by http://
    • As a custom field prefixed by papercite_. For example, the URL custom://data will use the data in the papercite_data custom field

    Attached files

    For each bibliographic entry, files can be automatically matched to retrieve e.g. the paper PDF, or the slides.

    First, the key of the bibtex entry is transformed – lowercased, and the characters : and / are replaced by -. The field determines the bibtex field that will be populated when matching. Then,

    WordPress media matching
    A file will match if its mime-type corresponds (or is empty) and its permalink name matches [key][suffix]

    The URL of the matched file will be stored in the field FIELD of the bibtex entry, and will be available by templates. For example, this can be inserted to display a link to a presentation:

        @?ppt@ <a href="@ppt@" title='Download PPT' class='papercite_pdf'<img src='@PAPERCITE_DATA_URL@/img/ppt.png' alt="[ppt]"/></a> @;@ 
    


    The FIELDFOLDEREXT and mime-type can all be set in the preferences. Papercite will process the list of such triplets, and will set the bibtex field to the last matched file (if any).

    Usages

    Bibliography mode

    This is my whole list of publications:
    [bibtex file=mypub.bib]
    This is my latest conference paper:
    [bibtex file=mypub.bib key=CGW2006]
    You can also have a list of keys to display more than one paper:
    [bibtex file=mypub.bib key=CGW2006,CGW2007]
    This is my bibliography maintained at citeulike.org
    [bibtex file=http://www.citeulike.org/bibtex/user/username]
    This is my bibliography maintained at bibsonomy.org
    [bibtex file=http://bibsonomy.org/bib/user/username?items=1000]
    This is a bibliography stored in the papercite_data custom field:
    [bibtex file=custom://data]

    Filtering mode

    The bibfilter command adds small html form where user can choose from authors and publication types. It does:

    • displays simple form
    • reads data from the form (what is selected)
    • alters parameters (author & type) according to data from the form in the original command
    • passes this modified command as “bibtex” for further processing

    Example of use:
    [bibfilter group=year group_order=desc author=Nahodil|Vítků allow=incollection,mastersthesis sortauthors=0]

    bibfilter uses the same parameters as bibtex command, with these modifications:

    • sortauthors=0/1: sort authors alphabetically in the form if equal to 1

    note: if no selection is made in form, bibtex parameters are not rewritten, this means that you can combine both commands as follows: -if no filter for type is made, bibtex command is called with e.g. type=INPROCEEDINGS|INCOLLECTIONS -the same for authors, the parameter “author” defines: -all authors for bibfilter menu -all authors for bibtex command

    Known limitations: sorting names in the form does not work with Czech diacritics very well, (e.g. Šafář, Řasa..)

    Citation mode

    The second way of using this plug-in (new to papercite), is to use bibcite and bibshow commands

    [bibshow file=mybib.bib] Here is one reference [bibcite key=key1] and some others [bibcite key=key2,key3]

    You can use [/bibshow] to end the bibshow section and print the list of references:

    [/bibshow]
    Remarks:
    • If the [/bibshow] shortcode is not present, then the bibliography is automatically displayed at the end of the page/post.
    • If the option is set, the [bibshow] tag can be automatically added when a [bibcite] is encountered. In this case, a default bibtex file should be given in the options.

    bibshow and bibtex options

    Here are the list of options that can be given to papercite.

    Global options

    • Bibtex parser (papercite >= 0.3.16): you can choose the pear parser (deprecated) or the OSBiB-based parser (default).
    • Database backend (papercite >= 0.4.0): The database backend is used to store the result of bibtex parsing in a database, allowing to speed up the processing of shortcodes when the BibTeX file is big.

    Local options

    Some of these options can be set at a global level (through preferences) and page/post level. These options are shown like this. To set options at the post/page level, use the papercite_options field with one line per option in the format:

        field_name = field_value
    

    First, some options are necessary to tell which bibtex file should be used:

    • file: The default bibtex URL(s) separated by commas (see what are the valid bibtex URLs).
    • timeout: The default time-out before reloading an external resource

    You can modify how publications are displayed using several options:

    • key_format: How to format the citing key of the publication
    • template: How to format the publication. At a global level, bibshow_template and bibcite_template are used to distinguish between the templates used respectively for bibshow and bibcite
    • format: Template used to format one BibTeX entry
    • show_links: Enable (1, default) or disable (0) use of hyperlinks from bibcite entries to the resulting list of publications
    • highlight: Highlight name(s) of specific author(s)

    Filtering options

    • The publication type can be fitered using allow and deny.
    • Publications can be filtered by author using the following syntax: author=nameauthor=name1|name2|name3, or author=name1&name2&name3. Filtering can match also authors whose name is substring of some other name (e.g. name “Su”). and is case sensitive in names which start with diacritics (e.g. Řehoř, Šimon..)
    • The number of items to be displayed can be limited with the limit argument. Its value, if greater than 0, gives the maximum number of items to be displayed

    Grouping and order options

    • group: How to group publications
    • group-order: Group sort order
    • sort: How to order publications within groups
    • order: Sort order within groups

    Each of these options are described next. Finally, the template language used to format entries is described on the bib2tpl site, with the following modifications:

    • @#field@ gives the number of entries in a field (author or editor)
    • Conditions can be more expressive, e.g. @?field=abc@ is true if the field is equal to abc (numeric comparisons are possible with > and <)

    Formatting

    Some options modify the bibtex processing:

    • process_titles can be set to 1 (normal BibTeX behaviour – lowercase everything which is not between braces) and 0 (no processing)

    You can modify the style of the citations by using the format For example,

    [bibtex file=mypub.bib format=ieee template=default-bibtex key_format=number]

    The key_format controls how a key is associated to a BibTeX entry. From within a entry template, the value of the key is given by @key@. The following values are accepted:

    • numeric (default) gives a unique increasing number to each entry (1, 2, …)
    • cite uses the bibtex key

    The format described how an entry is displayed. The following formats are currently available:

    • ieee (default)
    • apa
    • britishmedicaljournal
    • chicago
    • harvard
    • ieee
    • mla
    • turabian
    • plain

    Feel free to contribute new formats, but note that in the future the citation style might be written using the Citation Style Language (CSL).

    Eventually, the template option controls which template is used to format the entries. It is based on the tpl code. For the moment, the following templates are defined:

    • default-bibtex is the default template used for the bibtex command
    • av-bibtex is another template for the bibtex command. It adds support for abstract field (toggled like the bibtex entry), explicit doi: link and a Download PDF link for url field.
    • default-bibshow is the default template used for the bibshow command

    From a practical point of view, the final format follows bib2tpl. In order to create a bib2tpl template, templates and formats are merged: in the template, @#entry@ is replaced by the content of the format file. This This to decouple the formatting of entries with the formatting of the full bibliography.

    With respect to the bib2tpl code, some extra variables are defined:

    • @WP_PLUGIN_URL@ will be replaced by the plugin URL.
    • @papercite_id@ is a unique id within the page/post
    • @key@ is a the key as formatted with key_format.
    • @pdf@ is the URL to the auto-detected PDF (or to the URL specified in the PDF field).

    Here are some more general modifications:

    • More generally, @#fieldname prints the number of entries in the field name (works with authors, editor and pages)
    • A general if-then-else structure can be encoded by @?condition@ ... @:@ ... @;@, where the “else” and “end if” can be used in a short version (no need to specify the condition), and where the condition can be more elaborate than in bib2tpl: you can use the operators ><= and || with the same semantics as in main programming languages.

    CSS can be used to customize the display of entries. Again, do not customize directly papercite files, this would be overwritten with plugin updates. The best solution is to use a plugin such as Simple custom CSS that allows custom CSS to be written and stored within the WordPress database.

    In the default templates, the following classes are used:

    • papercite for headers like the h3 header for grouping key display
    • papercite_entry for a single bibtex
    • papercite_bibtex for the bibtex code
    • papercite_pdf for the PDF link
    • papercite_doi for the DOI link

    The highlight option can be used to highlight specific parts of an author or editor list (see here for an example). You can specify arbitrary regular expressions. Each match of the regular expression will then be highlighted. For example,

    [bibtex highlight="M. Mouse"]

    will highlight all occurences of M. Mouse. Similarly,

    [bibtex highlight="M. Mouse|D. Duck"]

    will highlight all occurences of M. Mouse or D. Duck.

    Grouping

    You can group the citations using the group option with values none (by default), firstauthorentrytype or any other valid bibtex field. You can order the groups using the group_order option which can take values among ascdesc or none (none by default).

    Example:

    [bibtex file=mypub.bib group=year group_order=desc]

    The grouping is defined by the group value (yearfirstauthorentrytype or none). Group are sorted depending on the group_order value:

    • none: No order
    • asc: Ascendant order
    • desc: Descendant order

    Sorting

    You can sort the citations using the sort option together by a description of the sorting key. Note that the sort

    [bibtex file=mypub.bib sort=year order=asc]

    Entries (within groups) are sorted depending on the sort key (see grouping for the list of possible keys). The ordering is also influenced by the order value.

    • none: No order
    • asc: Ascendant order
    • desc: Descendant order

Prudence 2018

Prudence 2018Prudence 2018 was a theme released in January 2018 as a part of Aurora Update 11. Similar to Hale 2015, Prudence 2018 adapted the Prudence design and kept the powerful features of Sherman. A child of the Cornerstone theme, Prudence 2018 will continue to benefit from all new features added to Aurora for years to come.

Moving from Prudence to Prudence 2018

If your site currently uses the Prudence theme, and you would like to switch to Prudence 2018, there are a few things to keep in mind. First, review the guide to Changing Themes. In addition, note the following changes:

Homepage

The homepage options have changed dramatically. You should now build the homepage (and any other page) using Page Builder. See Homepage Customization tools.

Using LaTex Formats

LaTeX is widely used in academia for the communication and publication of scientific documents in many fields, including mathematics, statistics, computer science, engineering, chemistry, physics, economics, quantitative psychology, philosophy, and political science. This typsetting language allows users to display properly formatted complicated formulas.

You may embed latex using a variety of different syntaxes. The shortcode syntax is preferred by adding the [ latex] [/latex] tag.
Additionally, you can use native mathjax syntax by surrounding the formula with double dollar signs $$ . Enter the latex code into the Text editor (not Visual editor).

Sample Code:

[latex] E=mc^2 [/latex]

$$ i\hbar\frac{\partial}{\partial t}\left|\Psi(t)\right>=H\left|\Psi(t)\right> $$

will display as

\(E=mc^2\)
$$ i\hbar\frac{\partial}{\partial t}\left|\Psi(t)\right>=H\left|\Psi(t)\right>$$

For more documentation on how to use LaTex, please refer to https://www.latex-project.org

Facebook

Facebook offers Social Plugins for integrating into websites. You can use embed codes for adding content already published on Facebook, and you can enable the Facebook's SDK to enable more features on your site.

Using Embed Codes

Facebook uses iframes to embed content. To add content, you will need to include the iframe code in the text editor of the page you are editing. You can also embed the iframe in a Text Widget. To learn more about using iframes in Aurora, visit the IFrame Guide

To find the Embed code to use, open the menu in the upper right hand of the Facebook content, and select Embed.

Embed Example

 

Embed Example 2

Embedded Post

Embedded Posts are a simple way to put public posts - by a Page or a person on Facebook - into the content of your web site or web page. Only public posts from Facebook Pages and profiles can be embedded.

<iframe style="border: none; overflow: hidden;" 
src="https://www.facebook.com/plugins/post.php?href=https%3A%2F%2Fwww.facebook.com%2FUConn%2Fposts%2F1724631187547128&width=500" 
width="500" height="475" frameborder="0" scrolling="no"></iframe>

Embedded Video

With the embedded video player you can easily add Facebook videos and Facebook live videos to your website. You can use any public video post by a Page or a person as video or live video source.

<iframe style="border: none; overflow: hidden;" 
src="https://www.facebook.com/plugins/video.php?href=https%3A%2F%2Fwww.facebook.com%2FUConn%2Fvideos%2F1688010137875900%2F&show_text=0&width=560" 
width="560" height="311" frameborder="0" scrolling="no" allowfullscreen="allowfullscreen"></iframe>

Embedded Comment

Embedded comments are a simple way to put public post comments - by a Page or a person on Facebook - into the content of your web site or web page. Only public comments from Facebook Pages and profiles can be embedded.

<iframe style="border: none; overflow: hidden;" src="https://www.facebook.com/plugins/comment_embed.php?href=https%3A%2F%2Fwww.facebook.com%2FUConn%2Fposts%2F1713005015376412%3Fcomment_id%3D1713032468707000&include_parent=false" width="560" height="181" frameborder="0" scrolling="no"></iframe>

Using Facebook SDK

Aurora has included an option to add additional Facebook Social Plugins under Settings > General > Enable Facebook SDK

For users comfortable with customizing html, Facebook Social Plugins online documentation has many options for configuring settings. Please be aware that if you use the Get Code button from the Code Configurators in the online documentation, you will not need to follow Step 1 or Step 2. Aurora will do these steps for you when the Enable Facebook SDK setting is enabled. You will only follow Step 3 to copy the configurated plugin to your site.

To add the following plugins configure your code and include it into the text editor of the wordpress page.

Like Button

A single click on the Like button will 'like' pieces of content on the web and share them on Facebook. You can also display a Share button next to the Like button to let people add a personal message and customize who they share with.

<div class="fb-like" 
data-href="http://aurora.uconn.edu/2017/08/08/facebook/" data-layout="standard" 
data-action="like" data-size="small" data-show-faces="true" data-share="true"></div>

Share Button

The Share button lets people add a personalized message to links before sharing on their timeline, in groups, or to their friends via a Facebook Message.

<div class="fb-share-button" data-href="http://aurora.uconn.edu/2017/08/08/facebook/" data-layout="button_count"></div>

Send Button

The Send button lets people privately send content on your site to one or more friends in a Facebook message.

<div class="fb-send" data-href="http://aurora.uconn.edu/2017/08/08/facebook/"></div>

Save Button

The Save button lets people save items or services to a private list on Facebook, share it with friends, and receive relevant notifications. For example, a person can save an item of clothing, trip, or link that they're thinking about and go back to that list for future consumption, or get notified when that item or trip has a promotional deal.

<div class="fb-save" data-uri="http://aurora.uconn.edu"></div>

Follow Button

The Follow button lets people subscribe to the public updates of others on Facebook. Learn more about configuring the Follow Button here.

<div class="fb-follow" data-href="https://www.facebook.com/UConn" data-layout="standard" data-size="small" data-show-faces="true"></div>

Additional Social Plugins

Facebook has the following plugins also available when the SDK is enabled.

Page Plugin

The Page Plugin lets you easily embed and promote any Facebook Page on your website. Just like on Facebook, your visitors can like and share the Page without leaving your site. There are many available settings available to configure this plugin. You will have to enable the Facebook SDK from the admin panel and use an IFrame.
Visit Facebook's Guide to Page Plugins to learn more.

<iframe style="border: none; overflow: hidden;" 
src="https://www.facebook.com/plugins/page.php?href=https%3A%2F%2Fwww.facebook.com%2Fpg%2FUConn&tabs=timeline&width=340&height=500&small_header=false&adapt_container_width=true&hide_cover=false&show_facepile=true" 
width="340" height="500" frameborder="0" scrolling="no"></iframe>

Quote

The quote plugin lets people select text on your page and add it to their share, so they can tell a more expressive story. Highlight any text on this page to see the Quote popup. To add this feature to your page, include the following html to the bottom of your page's content.

<div class="fb-quote"></div>

Comments

The option to allow a Facebook comment thread on your post is available. It is recommended that comment moderating is set up before implementing this feature. Check out Facebook's Guide to Comment Moderation.

<div class="fb-comments" 
data-href="http://aurora.uconn.edu/2017/08/08/facebook/" 
data-numposts="3"></div>