| Both sides previous revisionPrevious revisionNext revision | Previous revisionNext revisionBoth sides next revision |
| to-do_list_after_install_-_for_the_project_manager [2015/12/14 20:52] – ↷ Links adapted because of a move operation demiankatz | administration:vufind_for_project_managers [2015/12/14 21:08] – ↷ Page moved and renamed from to-do_list_after_install_-_for_the_project_manager to administration:vufind_for_project_managers demiankatz |
|---|
| ====== Orientation and To-Do List for the Project Manager ====== | ====== VuFind for Project Managers ====== |
| |
| |
| It took my technical folks just a few hours to successfully install VuFind. Now what should you, the project manager, do? I am starting this page to help project managers form their initial "to-do" roadmap/list. Some project managers will have more tech. background, some less. I'm going for a middle-of-the-pack approach. I plan to keep working on this, but please feel free to edit / add your items! | It took my technical folks just a few hours to successfully install VuFind. Now what should you, the project manager, do? This page is designed to help project managers form their initial "to-do" roadmap/list. Some project managers will have more tech. background, some less. I'm going for a middle-of-the-pack approach, but please feel free to edit / add your items! |
| |
| ===== Install patches ===== | ===== Install patches ===== |
| |
| * If the VuFind release you installed has been around for a while, it is possible that there are known issues with it. Take a look at the [[http://www.vufind.org/jira|JIRA]] issue manager to get a feel for known issues. Perhaps your development team can fix some problems and contribute code back to the community. [[http://www.vufind.org/jira|JIRA]] also contains user-contributed patches that might not be universal enough for inclusion in the main code distribution but which might help solve some of your local needs. | * If the VuFind release you installed has been around for a while, it is possible that there are known issues with it. Take a look at the [[http://www.vufind.org/jira|JIRA]] issue manager and [[https://github.com/vufind-org/vufind/pulls|GitHub pull requests]] to get a feel for known issues and current work in progress. Perhaps your development team can fix some problems and contribute code back to the community. |
| |
| ===== Establish tracking practices for you and/or your team ===== | ===== Establish tracking practices for you and/or your team ===== |
| |
| * Keep track of your changes. This will become very important if you have to upgrade to a new version of VuFind in the future. If you are making a small number of changes, you could do something as simple as creating a Google Doc Spreadsheet to track directory, filename, date, changes made to file on that date, and a change reason. If you plan on making many complex changes, you should probably invest some time in learning about a change management package like [[development:recommended_tools:git|Git]]. | * Keep track of your changes. This will become very important if you have to upgrade to a new version of VuFind in the future. If you are making a small number of changes, you could do something as simple as creating a Google Doc Spreadsheet to track directory, filename, date, changes made to file on that date, and a change reason. If you plan on making many complex changes, you should probably invest some time in learning about a change management package like [[development:recommended_tools:git|Git]]. Also be sure to review the best practices on the [[development:architecture:customizing_vufind|Customizing VuFind]] page. |
| * Keep local documentation -- for example, a wiki is a good way to list steps like import procedures for your institution. | * Keep local documentation -- for example, a wiki is a good way to list steps like import procedures for your institution. |
| * Make sure everyone knows what tools to use. | * Make sure everyone knows what tools to use. |
| ===== Getting to know VuFind ===== | ===== Getting to know VuFind ===== |
| |
| * Set up your e-mail client to filter the VuFind-General and VuFind-Tech lists into a folder. There is an online search (http://sourceforge.net/search/?group_id=199442&type_of_search=mlists) available of archives, but I found having local copies to be convenient and faster. | * Set up your e-mail client to filter the VuFind-General and VuFind-Tech lists into a folder. There is an online search available of archives, and regular Google searching often turns up useful threads, but I found having local copies to be convenient and faster. |
| * Get to know SOLR, which contains the data for your VuFind installation. I liked the SOLR wiki: http://wiki.apache.org/solr/FAQ | * Get to know Solr, which contains the data for your VuFind installation. I liked the Solr wiki: http://wiki.apache.org/solr/FAQ |
| * Edit a few smarty templates to get the hang of how they work. See the [[legacy:vufind_1.x_developer_manual:user_interface_customization|user interface customization]] page for more details. I recommend trying small changes to \vufind\web\interface\themes\classic\Record.php such as adding a MARC field of your own. | * Edit a few view templates to get the hang of how they work. See the [[development:architecture:user_interface|user interface customization]] page for more details. Adding a new field to search results by following the [[development:howtos:displaying_a_custom_field|Displaying a Custom Field]] page might be a useful exercise. |
| |
| |
| ===== Customizing for your library ===== | ===== Customizing for your library ===== |
| |
| * Decide what order you want your facets to appear in and how you want them labelled, and edit the facets.ini file as described on the [[configuration:facets|customizing facets]] page. | * Decide what order you want your facets to appear in and how you want them labelled, and edit the [[:facets.ini]] file as described on the [[configuration:facets|customizing facets]] page. |
| * Decide whether you need to customize record display. If so, you may want to build a custom [[legacy:vufind_1.x_developer_manual:supporting_a_new_metadata_format#record_display|record driver]] or modify the templates of an existing one. | * Decide whether you need to customize record display. If so, you may want to build a custom [[development:plugins:record_drivers|record driver]] or modify the templates of an existing one. |
| * Decide if you want to tweak the relevance ranking. See the [[configuration:search_customization|search customization]] page for details on how to do this. If you like how another library's setup is working, just email them -- most VuFind users are willing to share their settings. | * Decide if you want to tweak the relevance ranking. See the [[configuration:search_customization|search customization]] page for details on how to do this. If you like how another library's setup is working, just email them -- most VuFind users are willing to share their settings. |
| * Clean up any functions you aren't going to use right away, for example, "text this", by hiding them or removing them from the appropriate Smarty template. It's often better to eliminate a feature completely than to offer a feature that doesn't work the way you want or expect it to. | * Clean up any functions you aren't going to use right away, for example, "text this", by turning them off in [[:config.ini]] or removing them from the appropriate template. It's often better to eliminate a feature completely than to offer a feature that doesn't work the way you want or expect it to. Also, be sure to customize the default footer, as this contains some dummy links that don't actually go anywhere. |
| |
| |
| ===== FAQs for Project Managers ===== | ===== FAQs for Project Managers ===== |
| |
| Q. Where can I see what's going on with SOLR/Jetty/PHP? | Q. Where can I see what's going on with Solr/Jetty/PHP? |
| |
| A. You can see what searches are being sent to SOLR in several ways: | A. You can see what searches are being sent to Solr in several ways: |
| |
| - Look in solr/jetty/logs and you should see a file for each day there have been searches, filled with the queries as-sent. | - Look in solr/jetty/logs or solr/logs (depending on your VuFind version) and you should see a file for each day there have been searches, filled with the queries as-sent. |
| - in web/conf/config.ini, edit the vufind config file to turn debug=true near the top. Now the queries will appear in your web browser as you search VuFind. | - in [[:config.ini]], turn debug=true near the top. Now the queries will appear in your web browser as you search VuFind. |
| |
| Q. How do I change XXXX about VuFind? | Q. How do I change XXXX about VuFind? |
| **Changing the web displays (i.e. HTML)** | **Changing the web displays (i.e. HTML)** |
| |
| See web/interface/themes/[your_theme_name] -- this contains the Smarty templates which are basically enhanced HTML for your web displays. For more details, see the [[legacy:vufind_1.x_developer_manual:user_interface_customization|User Interface Customization]] page. | See the [[development:architecture:user_interface|User Interface Customization]] page. |
| | |
| **Changing what data is available to each display** | |
| | |
| The web/services directory contains the PHP files behind each page in VuFind. For example, web/services/Search/Results.php (Home.php in 1.0RC1 and earlier) controls the main search-and-results page. Look in your browser's URL as you navigate VuFind and that will give you the filename you're looking for. Edits to these files usually also require a change to the similarly-named Smarty template file in web/interface/themes/[your_theme_name]. For more details on code layout, see the [[legacy:vufind_1.x_developer_manual|Developer Manual]]. | |
| |
| **Changing the relevance ranking** | **Changing the relevance ranking** |
