File Structure

From SubjectsPlus

Inside the subjectsplus zip (currently in a folder called "sp") you will find:

[note: files in bold are ones you will/might need to edit]

• assets (shared files, including user (i.e., staff) files)
  • css
    • admin_styles.css -- admin stylesheet. Moi, I wouldn't fiddle with this
    • default.css -- default public stylesheet
    • guide.css -- some style info specific to the guide tab in the admin
    • images (some images used by jQuery plugins) -- need to doublecheck
    • print.css
    • styles.css
    • styles2.css
    • ui.datepicker-red.css -- this and the next file are used by a jquery plugin
    • ui.datepicker.css
  • fixed_pluslets -- storage of custom widgets (or pluslets in local parlance)
    • all_items.php -- displays all items associated with that subject (as set through the Records tab)
    • catalogsearch.php -- generates the catalog search pluslet
    • legend.php -- generates the legend pluslet
    • relatedguides.php -- just a test at this point
  • images
  • jquery
  • js -- some legacy non-jQuery JavaScript
  • lang -- first steps towards internationalization
    • fr.php -- French translation file. Name of these must match setting in config.php
    • forms-en.php -- English (default) version of forms used in Admin
    • forms-fr.php -- French version of forms used in Admin
    • popup_help.php -- some popup help for the Guides tab. Will need to be translated, but retain this file name
  • users -- storage of user uploaded files + staff pictures. When a new user is created through the admin tab of the control panel, a folder for that user will be created here (form of underscore + username in front of @ sign in email address, i.e., _adarby for adarby@ithaca.edu) with a single file in it, called headshot.jpg, that is a blank image for a user. You will replace this with the user's own image as time and inclination permits . . . .
    • _someone -- this is the default dummy user's folder

• control (files for the admin website. Except for "includes", you shouldn't need to mess with these.)
  • admin
    • associations.php
    • departments.php
    • index.php
    • password.php
    • set_picture.php
    • sources.php
  • faq
    • add_faqpage.php
    • browse_faq.php
    • index.php
  • guides (this folder manages the subject guide arrangements)
    • ajax_mod.php
    • data2.php
    • display_pluslet.php
    • fck_get_assets.php
    • fck_get_cat.php
    • fck_get_faqs.php
    • fck_get_tokens.php
    • feedme.php
    • find_pluslets.php
    • find_revisions.php
    • get_pluslets.php
    • guide.php
    • guide_functions.php
    • index.php
    • local.js
    • manage.php
    • manage_items.php
    • manage_more.php
    • migrate.php
    • new.php
    • organize.php
    • popup_help.php
    • save_guide.php
  • includes
    • config.php -- This is the one file you will need to edit!
    • feeder.php -- parses RSS feeds (calls either lastRSS.php or PGFeed.php)
    • footer.php
    • functions.php -- functions used throughout
    • header.php -- you might need to change the paths at the top of this file!!!
    • lastRSS.php -- helper file for parsing RSS feeds (not preferred)
    • PGFeed.php -- helper file for parsing RSS feeds (preferred)
  • records (this is for the Records tab in the admin)
    • assoc_subs.php
    • browse.php
    • delete.php
    • edit_functions.php
    • index.php
    • new.php
    • new_added.php
    • quick_delete.php
    • record.php
  • staff
    • index.php
  • talkback
    • index.php

• fckeditor (a 3rd party plugin for rich text editing; includes some subsplus plugins. There are a billion files in here; the only relevant ones are shown)
  • • fckconfig.js -- here you can tweak what icons appear in the rich text boxes
    • editor/plugins/subsplus_asset (plugin to upload or add files to user folder)
    • editor/plugins/subsplus_cat_link (plugin to link to catalog search results)
    • editor/plugins/subsplus_faq (plugin to link to FAQs (stored in FAQ tab))
    • editor/plugins/subsplus_resource (plugin to link to items stored in Record tab)
    • editor/filemanager/connectors/php/config.php -- here the $Config['UserFilesPath'] variable is set to point to the location where uploaded files go. If you change the default directory structure, you'll need to change this, too.

• subjects (files for the public website)
  • .htaccess -- for mod_rewrite actions to create "pretty" URLs
  • about.php
  • aboutrbys.php
  • databases.php
  • faq.php
  • guide.php
  • includes
    • feedme.php -- handles RSS feeds
    • footer.php -- you may need to edit this file
    • get_sources.php
    • header.php -- you will need to edit this to add your library's header at a minimum
    • index_sidebar.php -- The content that appears in the sidebar of the Subject Guide splash page
    • subject_sidebar.php -- legacy file -- check if it should be deleted
  • index.php -- you will probably need to edit the includes/header.php file instead
  • recommend.php
  • requirements.php
  • search.php
  • staff-classic.php
  • staff.php
  • staff_details.php
  • talkback.php