Upload
others
View
3
Download
0
Embed Size (px)
Citation preview
Managing Toynbee Prize WebsiteDocumentation
Release 1.0
Jeri Wieringa
May 14, 2014
Contents
i
ii
Managing Toynbee Prize Website Documentation, Release 1.0
Contents:
Contents 1
Managing Toynbee Prize Website Documentation, Release 1.0
2 Contents
CHAPTER 1
Project Vision and Goal
The current goal of the Toynbee website is to promote the publication of scholarship in Global History and to becomea central and respected source for current and developing scholarship in the field. This is being pursued in a couple ofdifferent ways.
First is the Global History Forum, which solicits thought pieces on Global History as well as interviews of scholars inthe field. The interviews are being conducted and edited by Timothy Nunan.
Second is the Global History Blog, which curates web content related to Global History. The GRA and the Editors atLarge are responsible for nominating and publishing this content. Ideally, the Blog can uncover growing conversationsin the field that can, in turn, generate more structured Forum contributions.
Third, the Forum serves to highlight the recipient of the Toynbee Prize and the conference panel on Global Historyat the AHA. This involves posting information about the current recipient and their talk, if available. In years of thepanel, one idea is to post about the panel topic early and invite conversation.
3
Managing Toynbee Prize Website Documentation, Release 1.0
4 Chapter 1. Project Vision and Goal
CHAPTER 2
GRA Responsibilities
2.1 Toynbee Prize
Primary responsibilities of the GRA are the maintenance of the site, maintenance of comments, the managing of theeditors at large, and the publishing of content on the blog.
See Managing Editors at Large and Managing ToynbeePrize for details on the editors and publishing content. SeeTheme Files and Setup - Twentyfourteen Child for info on managing the theme and plugins.
2.2 New Diplomatic History
GRA serves also as the web administrator for New Diplomatic History, adding users as requested and ensuring thatmaterial is being publicized as desired.
For more detailed information, see Managing New Diplomatic History
5
Managing Toynbee Prize Website Documentation, Release 1.0
6 Chapter 2. GRA Responsibilities
CHAPTER 3
Accounts
3.1 Servers:
• Dev server: http://toynbeeprize.chnm.org
• New Diplomatic History: http://newdiplomatichistory.org
• Toynbee: http://toynbeeprize.org
You will need both server access and WordPress accounts for these.
3.2 3rd Party Services:
See Basecamp for login information
• Read the Docs
• Google Analytics
• Zotero (Global History Group and New Diplomatic History Group)
• Facebook (?)
3.3 Email:
We have a Google for Non-Profit account for toynbeeprize.org.
To manage the email accounts and available apps, including docs and calendars, go to http://admin.google.com. Logininformation is in BaseCamp.
7
Managing Toynbee Prize Website Documentation, Release 1.0
8 Chapter 3. Accounts
CHAPTER 4
Outstanding Projects
4.1 Keeping Documentation Up-to-date
The documentation is under version control at https://github.com/ToynbeePrizeFoundation/toynbee_documentation.Remember to update the ReadtheDocs version (or research if this can automatically watch the repository...)
4.2 Navigating Archives
Currently, when on any post, the “next” and “previous” posts are by time. If we could filter these by category, thatwould make more sense for usability.
4.3 Resources Page
Goal is to have a page with Resources for students who are interested in studying Global History. The current conceptfor this page is a listing of programs, centers, and fellowships that support the study of Global History.
The list is currently under development. The items listed here are currently being created as Posts that are catego-rized as “Resources” and are tagged according to type of program. The Page is currently saved as “draft,” and oncecompleted, should be added to the Global History Menu and to the Main Menu, under Global History Initiatives.
4.4 Editors at Large
The PressForward Plugin is currently not operating on the site due to an unknown permissions problem. Once this isresolved, the feeds listed [?] need to be imported and the
In the Spring, the Editors at Large Corner needs to be activated. All the pages are currently saved as “drafts” and themenus have been created. In addition to publishing these pages, in “Widget Areas”, the “Editors at Large Sidebar”needs to be also activated for the “Scholars’ Network” and “Participate” pages. Also, on both the “Scholars’ Network”and “Participate” pages, the instructions for the Editors at Large need to be uncommented (viewable in “Text” viewonly), and ” Content for the Global History Blog is curated from the web with the help of our Editors at Large. All ofour Editors at Large <a href=”#editors”>are also listed below</a>.” should be added to the Scholars’ Network page.
Once in operation, the documentation for managing the editors at large needs to be completed.
9
Managing Toynbee Prize Website Documentation, Release 1.0
4.5 Content Tags
One of the goals is to have centers, people, and posts linked to each other through the use of descriptive tags. Acontrolled vocabulary needs to be created so that this can be done productively.
4.6 SEO
Theme needs to be enhanced with SEO information to get higher search result rankings.
4.7 Social Media Campaign
We need a concerted effort to increase followers to the blog and the twitter account. In addition, we need to inspiremore people to serve as editors at large and to contribute content to the blog.
4.8 Content Generation for the Forum
The GRA provides a support function to the generation of content for the Forum. In addition to Timothy’s interviewsand solicitations of material, possible sources include asking authors in the New Global History Journal to eitherexpand or write about new ideas inspired in the process of writing their published piece.
10 Chapter 4. Outstanding Projects
CHAPTER 5
Managing New Diplomatic History
5.1 Overview
Overall, New Diplomatic History requires very little support. Ken manages the posting of new content. The main roleis maintaining the site and plugins, and adding people to or editing the “Network”.
5.2 Theme
The theme on this site is a modified version of the first global history theme by Kim. The updated theme is underversion control at https://github.com/ToynbeePrizeFoundation/theme_newglobalhistory
5.3 Adding and Editing People
• Add new people to the network using @chnm.gmu.edu as the email address. The default password is stored inBasecamp.
• For people to appear in the network, enter “ndh-blog” in the blog tag.
• Add/Edit institutional affiliation in the “Biographical Info” box. This displays on the site under the name.
5.4 Twitter
• Tweets of posts sent through @toynbeeprize. This is managed by the WP to Twitter Plugin and is linked to the@toynbeeprize twitter account.
11
Managing Toynbee Prize Website Documentation, Release 1.0
12 Chapter 5. Managing New Diplomatic History
CHAPTER 6
Managing ToynbeePrize
6.1 Managing Site
6.1.1 Adding Users
Create user accounts for new Forum Contributors and new Editors at Large. For Blog authors, use the “Guest Author”function.
Forum Contributors and Interviewees
To date, the contributors have not edited their material within WordPress, so it is possible to create a pseudo accountfor them. Use the user information in BaseCamp. Forum Contributors should be added as “Authors” and should begiven institutional information in the “Bio” area.
Editors at Large
Editors at Large log into the Wordpress system in order to nominate content. These users require working accountswith their given email address and a default login. They should be added as “Contributors.” Their institutionalaffiliation should be added to the “Bio” area and the “Editors at Large” Members list should be checked.
Authors of Syndicated content
Syndicated authors can be added as Guest Authors using “Users -> Guest Authors”. This allows for a duplication ofthe author functionality without requiring the email address information (this can be added but is not required).
6.1.2 Adding Recent Publications
The bibliography is pulled from the “Current Publications” library within the Global History Group using ScholarPressResearcher. Add new citations to this Zotero Library for them to appear on the site.
6.1.3 Adding Resources
This section is currently in draft until we have gathered a critical mass of Resources to highlight.
13
Managing Toynbee Prize Website Documentation, Release 1.0
Creating Resources
• Resources are added as Posts, with category “Resources.” They will not appear in the feeds or on the homepage.
• Add tags to designate type of resource.
• Use the “Featured Image” to display a screen shot of the resource or program page.
Displaying Resources
Once live, use “Widgets on Pages” and “Recent Posts Extended” to display the resources posts.
6.2 Publishing Forum Content
6.2.1 Assign Category and Tags
• For Forum content, use the “Forum” Category.
• The tags should be descriptive and should adhere to a standard vocabulary to help people browse by topic areasacross forum posts, resources, and blog posts.
6.2.2 Set Authors
For submitted pieces, add the author (who has already been created as a user - see adding-users). For interviews, addboth the interviewer and the subject (both will display). If the post creator is different than the author, remove the postcreator.
6.2.3 Commenting
For Forum pieces, enable commenting.
6.2.4 Set Featured Image
The current default featured image is the tan map. To set a featured imaged for individual posts, use the “Set FeaturedImage” box in the lower right corner of the add posts page. The size of the featured image is restricted to thumbnailsize. This is controlled in the stylesheet.
And Publish.
6.3 Publishing Blog Content
6.3.1 Reviewing and Selecting Content via PressForward Plugin
Reviewing Content
All content coming in through the feeds is viewable in “All Content.” Use the right facing arrow to send items to“Under Review”. Editors at Large see the “All Content” page.
14 Chapter 6. Managing ToynbeePrize
Managing Toynbee Prize Website Documentation, Release 1.0
Selecting Content
From “Under Review”, the editor can see the number of nominations and the comments on any particular piece. Usethe double right facing arrows to create a draft of those pieces in “Posts”.
6.3.2 Title
Add Tag name to the beginning of the title to aid link recognition (Editors’ Choice for thought pieces; News area fornews pieces)
6.3.3 Linking Out
• Add link at bottom of post directing the reader back to the original content.
• For thought pieces, only include a short “snippet” of the content in order to respect copyright. Link out to theoriginal post for the whole piece.
6.3.4 Assign Category and Tags
• For Blog content, use the “Global History Blog” category.
• For new items, assign “Announcements”, “Conferences and CFPs”, “Jobs”, or “Funding and Opportunities”.
• For thought pieces, assign “Editors Choice” tag and added descriptive tags according to the Forum fixed vocab-ulary.
6.3.5 Set Authors
• For news items, set the Author to “Toynbee Editors” and remove the post creator.
• For thought pieces, use Guest User to create a display name that links to content. Set the Author to the corre-sponding Guest Author. (see adding-users)
6.3.6 Commenting
Turn off commenting for syndicated content.
6.3.7 Set Featured Image
Set unique featured image if desired.
And Publish.
6.3. Publishing Blog Content 15
Managing Toynbee Prize Website Documentation, Release 1.0
16 Chapter 6. Managing ToynbeePrize
CHAPTER 7
Managing Editors at Large
Editor at Large spreadsheets are managed under the [email protected] Google Drive account.
All of the spreadsheets and functions are set up for Toynbee.
17
Managing Toynbee Prize Website Documentation, Release 1.0
18 Chapter 7. Managing Editors at Large
CHAPTER 8
Theme Files and Setup - Twentyfourteen Child
8.1 Introduction
The Toynbee Prize site is using a child theme based on the Twentyfourteen theme. The child theme file only containsthose styles and functions that overwrite the Twentyfourteen defaults. Make all desired changes within the child themefiles.
The child theme developed for the Toynbee Prize website is under version control athttps://github.com/ToynbeePrizeFoundation/theme_twentyfourteen_child.
8.2 Theme Files
This section gives a brief description of the changes in the various files contained in the child theme.
8.2.1 category.php
Modified so as not to display the category name and description.
8.2.2 config.rb
Configuration files for using Compass to write SASS rather than CSS directly.
8.2.3 content.php
Modified to display excerpt rather than full posts for search results and tag archives.
[<?php if ( is_search() || is_tag() ) : ?><div class=”entry-summary”>]
8.2.4 content-with-author.php
Content template for displaying the Author on Pages. Was used for the “Perspectives on Global History” page, thoughcurrently not in use. Used with “single-with-author” page template.
19
Managing Toynbee Prize Website Documentation, Release 1.0
8.2.5 functions.php
Added 2 function: 1. Guest Author Function:
/* Add Guest Author Capabilities */
add_filter( ‘the_author’, ‘guest_author_name’ );add_filter( ‘get_the_author_display_name’, ‘guest_author_name’ );
function guest_author_name( $name ) {global $post;
$author = get_post_meta( $post->ID, ‘guest-author’, true );
if ( $author )$name = $author;
return $name;}
2. RSS icon to font-awesome
/* Add RSS Icon for Menu Bar */
add_filter( ‘storm_social_icons_networks’, ‘storm_social_icons_networks’);function storm_social_icons_networks( $networks ) {
$extra_icons = array (‘/feed’ => array( // Enable this icon for any URL | containing this text
‘name’ => ‘RSS’, // Default menu item label‘class’ => ‘rss’, // Custom class‘icon’ => ‘icon-rss’, // FontAwesome class
‘icon-sign’ => ‘icon-rss-sign’ // May not be available. Check FontAwesome.),
);
$extra_icons = array_merge( $networks, $extra_icons );return $extra_icons;
}
3. Add Function to display coauthors
function twentyfourteen_posted_on() {if ( is_sticky() && is_home() && ! is_paged() ) {
echo ‘<span class=”featured-post”>’ . __( ‘Sticky’, ‘twentyfourteen’ ) . ‘</span>’;}
20 Chapter 8. Theme Files and Setup - Twentyfourteen Child
Managing Toynbee Prize Website Documentation, Release 1.0
// Set up and print post meta information.printf( ‘<span class=”entry-date”><a href=”%1$s” rel=”bookmark”><time class=”entry-date”datetime=”%2$s”>%3$s</time></a></span>’,
esc_url( get_permalink() ),esc_attr( get_the_date( ‘c’ ) ),esc_html( get_the_date() )
);
// get the co-authorsif ( function_exists( ‘get_coauthors’ ) ) {
$authors = get_coauthors();}
// Fallback to WP usersif ( empty( $authors ) || ! is_array( $authors ) ) {
$authors = array( get_userdata( get_the_author_meta( ‘ID’ ) ) );}
foreach ( $authors as $author ) {$_args = apply_filters(
‘coauthors_posts_link’,array( ‘href’ => get_author_posts_url( intval( $author->ID ), $author->user_nicename ) )
);
printf(‘<span class=”byline”><span class=”author vcard”><a class=”url fn n” href=”%1$s”rel=”author”>%2$s</a></span></span>’,esc_url( $_args[’href’] ),esc_html( $author->display_name )
);}
|}
8.2.6 Gemfile
Support files for Compass
8.2.7 Gemfile.lock
Support files for Compass
8.2.8 header.php
Added link to google fonts for title
8.2. Theme Files 21
Managing Toynbee Prize Website Documentation, Release 1.0
[<link href=’http://fonts.googleapis.com/css?family=Crimson+Text:400,600‘ rel=’stylesheet’ type=’text/css’>]
8.2.9 sass
SASS files used to generate the style.css file. Make changes here to update the style.css file. To compile those changes,run “bundle exec compass compile” or “bundle exec compass watch.”
8.2.10 sidebar.php
Add logo image file above the navigation. Image stored in the WordPress media library.
8.2.11 style.css
Child theme styles. This is what makes the child theme work. Includes only those styles that have been modified fromthe original CSS file.
8.2.12 tag.php
Modified to not display the tag name or description.
8.3 Plugins
8.3.1 Akismet
Spam filtering for comments.
8.3.2 Co-Authors Plus
Allows multiple authors to be listed and linked to individual posts. Will be very useful for interview posts.
8.3.3 Default featured image
Theme looks better with images, so this fills in an image for all posts that do not have one explicitly set.
8.3.4 Display Authors Widget
Used with Widgets on Pages for list of Forum Authors on “Scholars’ Network” Page.
8.3.5 Google Analytics
Adds Google Analytics information to each page.
22 Chapter 8. Theme Files and Setup - Twentyfourteen Child
Managing Toynbee Prize Website Documentation, Release 1.0
8.3.6 Members List
Used to display set groups of authors. Also includes search and sorting functionality when authors are displayed on apage.
8.3.7 Menu Social Icons
Displays icons for common social media menu items. Used in header menu
8.3.8 PressForward
RSS reader and editorial workflow tool.
8.3.9 Recent Posts Widget Extended
Fancy listing of recent posts. Enables sorting by category or tag. Used to display Talks in the Toynbee section.
8.3.10 ScholarPress Researcher
Displays Zotero Library on Recent Scholarship Page.
8.3.11 Simple Page to Sidebar
Used to store officers and trustees in a post and yet display in Toynbee sidebar
8.3.12 Ultimate Category Excluder
Used to block “Resources” posts from front page and from feeds.
8.3.13 Widgets on Pages
Replaces “Add Widgets to Pages”. Used frequently to place widget content on pages. Titles are descriptive of thecontent they contain.
8.3.14 Widget Title Links
Makes widget titles links.
8.3.15 Woo Sidebars
Used to create and manage custom sidebars for different page types. This is how the different sidebars for the threecontent areas of the site are created and maintained.
8.3.16 WordPress to Twitter
Tweets Recent Posts.
8.3. Plugins 23
Managing Toynbee Prize Website Documentation, Release 1.0
8.4 Menus and Settings
The current design relies heavily on the use of Menus to provide navigation throughout the site. This gives a briefdescription of the different menu and where they are operating.
8.4.1 Quick Links
Appears on front page and unassigned pages. Gives links to top items:
• Forum
• Blog
• Toynbee Prize
• Scholar’s Network
• Participate
• About the Toynbee Prize Foundation
8.4.2 Header
Appears in the top row with the title. This is the contact menu
• RSS
• Participate
8.4.3 Main
Appears in left sidebar on all pages. This menu has subpages listed, but they do not display. This is so the “active” styling works when navigating around the site.
• The Toynbee Prize Foundation
– The Toynbee Prize
• Global History Forum (category)
– The Global History Forum (page)
• Global History Initiatives (category)
– Perspectives on Global History
– International Conferences Conferences
– New Global Studies Journal
– Recent Scholarship
– Resources
24 Chapter 8. Theme Files and Setup - Twentyfourteen Child
Managing Toynbee Prize Website Documentation, Release 1.0
8.4.4 Toynbee
Right sidebar menu for Toynbee pages. Title links back to main page.
• About the Toynbee Prize Foundation
• Past Prize Winners
8.4.5 Forum
Right sidebar Menu for Forum Pages.
• Global History Forum (category)
• About the Forum
• Scholars’ Network
• Participate
8.4.6 Global
Right sidebar menu for Global pages. Title links back to main page.
• Global History Blog (category)
• Perspectives on Global History
– Recent Scholarship
• New Global Studies Journal
• International Conferences on Global History
• Resources (To be added when ready)
• Scholar’s Network
• Participate
8.4.7 Editors at Large
Right sidebar menu for Editors at Large section. Title links to main page. Appears in the contribute page of the Global History section.
• Welcome
• Sign up
• Schedule
• Set-up Instructions
• Choosing Content
8.4. Menus and Settings 25
Managing Toynbee Prize Website Documentation, Release 1.0
8.5 Widget Areas
8.5.1 Primary Sidebar
Text for mission statement (no title): “The Toynbee Prize Foundation was chartered to contribute to the develop-ment of the social sciences, as defined from a broad historical view of human society and of human and socialproblems.”
Text for Sponsored Projects: Title: Sponsored by TPF Body: <a href=”http://newdiplomatichistory.org/“>The Net-work for New Diplomatic History</a>
<img src=”http://toynbeeprize.org/wp-content/uploads/2014/04/s219465661.jpg” style=”width:25px; margin-right:5px; float:left”><a href=”http://www.degruyter.com/view/j/ngs”> New Global Studies</a>
Text for CHNM: Title: In Collaboration With: Body: <img src=”http://toynbeeprize.org/wp-content/uploads/2014/04/chnm1.png“> <br> <img src=”http://toynbeeprize.org/wp-content/uploads/2014/04/pressforward1.png“>
8.5.2 Content Sidebar
Includes Quick Links Menu, Browse by Tags, and Recent Comments. Default menu
8.6 Custom Sidebars
Set up Sidebars in Appearance -> Widget Areas
8.6.1 Toynbee Sidebar
Includes Toynbee Menu and Simple Page to Sidebar (officers and trustees page)
Sidebar appears on Pages
• The Toynbee Prize Foundation
• The Toynbee Prize
8.6.2 Global Initiatives Sidebar
Includes Global Menu and Browse by Tags
Sidebar appears on Pages:
• Global History Initiatives
• International Conferences on Global History
• New Global Studies Journal
• Perspectives on Global History
• Recent Scholarship
• Resources (Draft)
• Global History Blog (Category)
26 Chapter 8. Theme Files and Setup - Twentyfourteen Child
Managing Toynbee Prize Website Documentation, Release 1.0
• All posts in “Global History Blog”
• Resources (Category)
• All posts in “Resources”
8.6.3 Editors at Large Sidebar
Includes Quick Links Menu and Editors at Large Menu
Sidebar appears on Pages:
• Editors at Large Corner (Draft)
• Choosing Content: What Should I look for? (Draft)
• Instructions for Reviewing and Nominating Content (Draft)
• Sign up to be an Editor-at-Large (Draft)
• Weekly Schedule (Draft)
• Participate (Needs to be added once Editors are relaunched)
8.6.4 Forum Sidebar
Includes Forum Menu and Browse by Tags
Sidebar appears on Pages:
• The Global History Forum
• Forum (Category)
• All posts in “Forum”
8.7 Widgets to Pages
Set up widget areas in “Settings -> Widgets on Pages”
8.7.1 Global Studies Journal-widgets-on-page
RSS feed for New Global Studies (http://www.degruyter.com/dg/rssalerts/$002fj$002fngs/New$0020Global$0020Studies/toc/NaN)
8.7.2 Authors-widgets-on-page
Display Authors widget for Authors.
8.7. Widgets to Pages 27