Getting Started 2.0

From SubjectsPlus
Revision as of 13:34, 8 August 2015 by Agdarby (Talk | contribs) (Created page with "==Public vs. Admin Views== ===Public View=== The public view, obviously, is what the public sees. Your local webmaster-type should be able to customize it however you want....")

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

Public vs. Admin Views

Public View

The public view, obviously, is what the public sees. Your local webmaster-type should be able to customize it however you want. Minimally, they might change the header to match your institution's header, but really, the can make it look however you want if you bug them enough. If you go to the root of your SubjectsPlus installation (by default something like you will see a listing of the public pages are available "out of the box." I list them here for your delectation:

  • Subject Guide splash page
  • A-Z List of Databases page
  • FAQs splash page
  • Staff Listing page
  • TalkBack page
  • Delicious Feed (You pass parameters into this page, it spits out results from your delicious feed--as if it were just a regular old page from your website!)

Admin View


File:All tabs.png

This is where library staff create the content that is then displayed through the public interface. You will see different tabs depending on what permissions the SubjectsPlus overall administrator has assigned you. The full complement of possible tabs are:

  • Records -- add/modify/delete (maybe) a record
  • Guides -- add/modify/delete (maybe) a guide -- manage your uploaded files -- create a page of delicious links
  • FAQs -- add/modify/delete (maybe) a faq
  • TalkBack -- respond to a user-submitted TalkBack. Modify a response.
  • Admin -- secret admin stuff, including managing users and permissions; adding new departments, sources and FAQ collections

Personal Details

You can also manage some personal details here.

  • Update your password -- choose something good or else get blamed if the server is hacked!
  • Update your biographical details -- which show up on the staff details listing
  • Update your headshot -- the wee picture that will show up in your subject guide (if you drag in the "Subject Specialist" box--see below) or the staff list (if your institution is using the super-handsome SubjectsPlus auto-generated staff list). Note: Sometimes you need to refresh the page to see your new headshot--sometimes the nasty web server will cache the old image file, making you think it didn't take, like, maybe that picture wasn't good enough and you should try another?
  • Log out -- you probably didn't notice, but if you hover over the Hello, [your name] in the far right, you'll see a logout link. Closing your browser will also log you out.


Finally, use the awesome search. If you are in one of the tabs, it will autosearch the contents of that tab; otherwise, it will take you to search results across all content.


There are a couple of different background patterns available by default. This just shows up when you log into the admin. Your admin could add more patterns if they felt inspired.


tip: Clicking on the SubjectsPlus logo will take you to the admin splash page.

Records & Guides

You may use the Record tab to add a new record to SubjectsPlus. This makes that content available throughout SubsPlus, so that you can edit once update everywhere. Additionally, all the records associated with a subject can be used to quickly generate the "All Items by Source" content of a guide.

Ways You Might Use a Record

  • It could appear on the Databases A-Z List if your eres admin so chooses
  • It could appear in your subject guide in one of two ways:
    • You insert all linked records via the "All Items by Source" box
    • You insert a specific record via the WYSIWYG editor in a basic "Editable Box"

File:Add record options.png

(This image is from the Edit Guide screen)

Adding/Editing a Record

File:Select record tab.png

From the Admin view, select "New Record" from the Records dropdown. Or if you want to see if that record already exists, either use the search box or select "Browse Records" from the same dropdown. The new record screen looks something like this:

File:Record screen.png

Let me explain:

1. The description field is a WYSIWYG editor (FCKeditor to be precise). Your admin can customize which buttons appear here, by default a limited set is shown. You can add hyperlinks and boldness and italicness and so on. If something looks weird, like the font has changed, you've probably cut'n'pasted and gotten some bonus code. To see what sorts of hidden code might lurk beneath your record, click the "source" tab. OMG, all sorts of MSXML junk--MS Word likes to add that. Try using the "Paste from Word" button in future, or better yet the "Past as Plain Text" one.

2. This location should ordinarily be a full URL (like, WITHOUT an ezproxy prefix. But see #4 below.

3. The life preserver, if all works well, should test a URL to see if it looks okay. This is still pretty beta.

4. Format. By default, this has the following dropdown options:

  • URL
  • Print
  • Print w/ URL

If you change the dropdown option, it will change the location field above. If you choose URL, stick in a URL. If print, stick in a call number. If Print w/ URL stick in both a location (i.e., link to the catalog record) and call number.


5. Access Restrictions. Default options are:

  • None
  • Restricted
  • On Campus Only
  • Rest-No Proxy

The key one is the second--choose that and the proxy string will be automatically added to the URL. Your SubsPlus admin will set this in their config file.

The "restricted--no proxy" option WON'T prefix with the proxy string, but will show the little restricted icon.

6. Click this to make the record appear on your A-Z list of Databases. Note: Only an admin or a person with the "eresource_mgr" permission will have this option.

7. Display Note. E.g., something like "2 Simultaneous users" or "Available on cd-rom only." Note: Only an admin or a person with the "eresource_mgr" permission will have this option.

8. Delete this Location. If you have more than one location, you may delete one. But you need one location, sorry!

9. Add another Location. To add another location for the record. Say it has both a print and an online version. It happens.

10. Default Source Type. This just means that when you add a new subject (see 11 below), it will be of that source type by default. If a record has multiple subjects, the default source type will be computed. If it's a new record, it will just show the alphabetically first source type. You can change the source type later.

11. Subjects. Select a subject from the dropdown, and through the magic of technology, your record is now associated with it. What does this mean? It means that if you select "All Items by Source" when you are creating a guide, it will insert a sorted list of all the records listing that particular subject. This is legacy functionality, since this was how SubjectsPlus <= 0.7 worked (you tagged records, your subject guide was created. kinda lame. Soooo 2004.). Here's an example of a record with subject attached:


a. Click the X to remove this subject association b. Click the little linkie icon to overrid the default source type association. If it's green, that means an override is in effect. Click to modify. c. Note override. Use this is you want to have a different description appear than that which shows in the main description field. I.e., you want to write something more subject-specific.

12. Don't forget to save your record. Right below, it will show the last person to have modified this record.

Creating/Updating a Guide

First step in creating a guide is using the Guides tab--hover over it and select "New Guide." This will pull up a screen something like this:

File:Guide meta.png

This page generates the initial metadata about your guide. Notes:

1. The full name of your guide

2. The short form will appear in the URL, so don't put spaces or punctuation or what-have-you. If you use a shortform of biology, your guide url will be something like

These short forms MUST BE UNIQUE. You should be prompted to choose something different if your short form is already in use.

3. Type of Guide. There are three types of guides by default: Subject, Course, Topic. The concept is:

  • Subject is for a broad area that maps to a discipline
  • Course maps to a specific course
  • Topic is anything else

Now, your administrator can set up any sort of divisions you want by modifying the config file.

4. A published guide shows up in the list of guides on the guide splash page. People can still navigate to an unpublished guide if they know the URL. But why would they?!?

5. The slider lets you adjust the width of the two columns in your guide. 70% for the main column has been scientifically proven to be a good width for the main column. (I just made this up, but it works for me.)

6. A guide must have a librarian associated with it. The person who creates the guide will appear by default. You may add other librarians. Adding allows a librarian to modify the guide (otherwise, only an admin can modify a guide they aren't assigned to). The librarians associated with a guide will also appear if you drag in the Subject Specialist box (see below)

7. Don't forget to save.

File:Saved metadata.png

Once you have successfully saved your metadata, the guide is available to use. You can click the link in the little purple feedback bar, and the new guide will now show up in your list of guides if you click the Guides tab or link. It will be empty now, however:

File:Blank guide.png

Now you need to add content to your guide. The basic idea is you either drag in content from the New Box button, or you add in existing content via the Find button (this content is an unlinked copy may then be modified). Here's the quick rundown of the options in a blank guide. More detail later.

1. This toggles the header (the main navigation) to visible/invisible. It starts invisible by default. This annoys some.

2. New box. Hover over this to see the options for the content that may be dragged in. They used to be called pluslets, but someone suggested boxes was a better label. I'm still not convinced. See the section New Box Types below.

3. Find box. Use this to insert a content block that exists in another subject guide.

4. New Record. This is just a quick way to create a new Record. It's the same as going over to the Record tab and hitting new Record. Except you don't need to leave the comfort of your guide.

5. Metadata. Another shortcut to modify your guide's metadata. If you change the column size, you will need to refresh the page to see the new size. Be sure to save your work first.

6. The title of your guide. Click the link to have the public version of your guide pop up in a new tab.

7. The drop zones. Drag your box (from New Box) over to one of these drop zones and when it lights up pinkypurple, let go. It should appear in teh appropriate column, at the top. Depending on the box type, you will have editing options. Once you have saved the new box, you may drag it around and rearrange the page layout.

New Box Types

File:New box types.png

When you hover over New Box, you should see all the available box types. Here's a rundown:

Editable Box

The default basic box. Your friend. This creates a new WYSIWYG box with a title field above.

File:Editable box.png

So, this is what an editable box looks like when you first plunk it into a page. Basically, you give it a title and put some content in the body and you're done. But some things merit explanation:

1. The title. Shouldn't be blank, although maybe you'll be allowed to leave it blank, I dunno.

2. Options. You can use these to get some help of dubious helpfulness, toggle the body visible/invisible, delete the box, and, if you aren't in editing mode, edit the box (pencil icon; not shown above)

3. Your usual WYSIWYG buttons. It's a subset of all possible icons, your SubsPlus admin can add other ones.

4. Custom buttons. These allow you to do more stuff:

File:Custom buttons.png

  • Insert database link. Use this to locate and insert the token for an item stored in the Records tab.
  • Insert or Upload Document. Use if you want to load a file to the server and link to it. Not the same as, say, embedding an image. Do that with the regular WYSIYWG image icon.
  • Insert FAQs. Allows you to insert a specific FAQ. If you want to insert ALL the FAQs associated with this subject, use the FAQs box instead
  • Insert Link to Catalog Record. For those times when you want to link to a record in the catalog. It just creates a useable string; if your catalog has persistent URLs, I'd just add a link using the WYSIWYG option.

Each of these adds a "token" of confusing code, like this:

 {{faq},{81,82,83}} -- which shows faqs with those #s in the database

5. Box's body. Type in stuff here. Mark it up with the buttons in the toolbar above.


A heading is just the title part of a box, if you want to have a heading to divide up the content on your page. It is slightly narrower than the regular box width, and is just the title bar, with no body.


Allows you to insert a content feed--for the delicious feed, enter your username and the tag you want to display; for the others, just enter the entire RSS feed.

Find Box