<!DOCTYPE html>
<html>
<head>
<meta content="text/html; charset=UTF-8" http-equiv="Content-Type">
<title>DMPonline4 Documentation</title>
<link type="text/css" media="screen" href="./rdoc.css" rel="stylesheet">
<script type="text/javascript">
var rdoc_rel_prefix = "./";
</script>
<script type="text/javascript" charset="utf-8" src="./js/jquery.js"></script>
<script type="text/javascript" charset="utf-8" src="./js/navigation.js"></script>
<script type="text/javascript" charset="utf-8" src="./js/search_index.js"></script>
<script type="text/javascript" charset="utf-8" src="./js/search.js"></script>
<script type="text/javascript" charset="utf-8" src="./js/searcher.js"></script>
<script type="text/javascript" charset="utf-8" src="./js/darkfish.js"></script>
<body>
<nav id="metadata">
<nav id="home-section" class="section">
<h3 class="section-header">
<a href="./index.html">Home</a>
<a href="./table_of_contents.html#classes">Classes</a>
<a href="./table_of_contents.html#methods">Methods</a>
</h3>
</nav>
<nav id="search-section" class="section project-section" class="initially-hidden">
<form action="#" method="get" accept-charset="utf-8">
<h3 class="section-header">
<input type="text" name="search" placeholder="Search" id="search-field"
title="Type to search, Up and Down to navigate, Enter to load">
</h3>
</form>
<ul id="search-results" class="initially-hidden"></ul>
</nav>
<div id="project-metadata">
<nav id="fileindex-section" class="section project-section">
<h3 class="section-header">Pages</h3>
<ul>
<li class="file"><a href="./README_rdoc.html">README</a>
</ul>
</nav>
<nav id="classindex-section" class="section project-section">
<h3 class="section-header">Class and Module Index</h3>
<ul class="link-list">
<li><a href="./Settings.html">Settings</a>
<li><a href="./Settings/Dmptemplate.html">Settings::Dmptemplate</a>
<li><a href="./Settings/PlanList.html">Settings::PlanList</a>
<li><a href="./Settings/PlansController.html">Settings::PlansController</a>
<li><a href="./Settings/ProjectsController.html">Settings::ProjectsController</a>
<li><a href="./Settings/SettingsController.html">Settings::SettingsController</a>
<li><a href="./ActiveAdmin.html">ActiveAdmin</a>
<li><a href="./ActiveAdmin/Views.html">ActiveAdmin::Views</a>
<li><a href="./ActiveAdmin/Views/Pages.html">ActiveAdmin::Views::Pages</a>
<li><a href="./ActiveAdmin/Views/Pages/Base.html">ActiveAdmin::Views::Pages::Base</a>
<li><a href="./Users.html">Users</a>
<li><a href="./Users/OmniauthCallbacksController.html">Users::OmniauthCallbacksController</a>
<li><a href="./Users/OmniauthShibbolethRequestController.html">Users::OmniauthShibbolethRequestController</a>
<li><a href="./DMPonline4.html">DMPonline4</a>
<li><a href="./DMPonline4/Application.html">DMPonline4::Application</a>
<li><a href="./Ability.html">Ability</a>
<li><a href="./Answer.html">Answer</a>
<li><a href="./AnswersController.html">AnswersController</a>
<li><a href="./ApplicationController.html">ApplicationController</a>
<li><a href="./ApplicationHelper.html">ApplicationHelper</a>
<li><a href="./Comment.html">Comment</a>
<li><a href="./CommentsController.html">CommentsController</a>
<li><a href="./ConfirmationsController.html">ConfirmationsController</a>
<li><a href="./ContactsController.html">ContactsController</a>
<li><a href="./CustomFailure.html">CustomFailure</a>
<li><a href="./Dmptemplate.html">Dmptemplate</a>
<li><a href="./DmptemplatesController.html">DmptemplatesController</a>
<li><a href="./ExistingUsersController.html">ExistingUsersController</a>
<li><a href="./ExportedPlan.html">ExportedPlan</a>
<li><a href="./FileType.html">FileType</a>
<li><a href="./FileUpload.html">FileUpload</a>
<li><a href="./Guidance.html">Guidance</a>
<li><a href="./GuidanceGroup.html">GuidanceGroup</a>
<li><a href="./GuidanceGroupsController.html">GuidanceGroupsController</a>
<li><a href="./GuidancesController.html">GuidancesController</a>
<li><a href="./HomeController.html">HomeController</a>
<li><a href="./Object.html">Object</a>
<li><a href="./Option.html">Option</a>
<li><a href="./OptionWarning.html">OptionWarning</a>
<li><a href="./Organisation.html">Organisation</a>
<li><a href="./OrganisationType.html">OrganisationType</a>
<li><a href="./OrganisationUsersController.html">OrganisationUsersController</a>
<li><a href="./OrganisationsController.html">OrganisationsController</a>
<li><a href="./PasswordsController.html">PasswordsController</a>
<li><a href="./Phase.html">Phase</a>
<li><a href="./Plan.html">Plan</a>
<li><a href="./PlanSection.html">PlanSection</a>
<li><a href="./PlansController.html">PlansController</a>
<li><a href="./PlansHelper.html">PlansHelper</a>
<li><a href="./Project.html">Project</a>
<li><a href="./ProjectGroup.html">ProjectGroup</a>
<li><a href="./ProjectGroupsController.html">ProjectGroupsController</a>
<li><a href="./ProjectPartner.html">ProjectPartner</a>
<li><a href="./ProjectsController.html">ProjectsController</a>
<li><a href="./Question.html">Question</a>
<li><a href="./QuestionFormat.html">QuestionFormat</a>
<li><a href="./RegistrationsController.html">RegistrationsController</a>
<li><a href="./Role.html">Role</a>
<li><a href="./Section.html">Section</a>
<li><a href="./SessionsController.html">SessionsController</a>
<li><a href="./SplashLog.html">SplashLog</a>
<li><a href="./SplashLogsController.html">SplashLogsController</a>
<li><a href="./StaticPagesController.html">StaticPagesController</a>
<li><a href="./SuggestedAnswer.html">SuggestedAnswer</a>
<li><a href="./Theme.html">Theme</a>
<li><a href="./ThemesController.html">ThemesController</a>
<li><a href="./User.html">User</a>
<li><a href="./UserMailer.html">UserMailer</a>
<li><a href="./UserOrgRole.html">UserOrgRole</a>
<li><a href="./UserOrgRolesController.html">UserOrgRolesController</a>
<li><a href="./UserRoleType.html">UserRoleType</a>
<li><a href="./UserRoleTypesController.html">UserRoleTypesController</a>
<li><a href="./UserStatus.html">UserStatus</a>
<li><a href="./UserStatusesController.html">UserStatusesController</a>
<li><a href="./UserType.html">UserType</a>
<li><a href="./UserTypesController.html">UserTypesController</a>
<li><a href="./UsersController.html">UsersController</a>
<li><a href="./Version.html">Version</a>
</ul>
</nav>
</div>
</nav>
<div id="documentation" class="description">
<h1 id="label-DMPonline+v4">DMPonline v4</h1>
<p>DMPonline is the DCC's data management planning tool, available at <a
href="https://dmponline.dcc.ac.uk">dmponline.dcc.ac.uk</a></p>
<p>Development of the DMPonline by the Digital Curation Centre has been funded
by JISC. JISC inspires UK colleges and universities in the innovative use
of digital technologies, helping to maintain the UK's position as a
global leader in education. <a
href="http://www.jisc.ac.uk">www.jisc.ac.uk</a></p>
<p>This is just the application code, the accompanying question data available
at <a href="https://dmponline.dcc.ac.uk">dmponline.dcc.ac.uk</a> is not
included.</p>
<p>The tool has four main functions</p>
<ol><li>
<p>To help create and maintain different versions of Data Management Plans;</p>
</li><li>
<p>To provide useful guidance on data management issues and how to meet
research funders' requirements;</p>
</li><li>
<p>To export attractive and useful plans in a variety of formats;</p>
</li><li>
<p>To allow collaborative work when creating Data Management Plans.</p>
</li></ol>
<h2 id="label-Documentation+%26+Support">Documentation & Support</h2>
<ul><li>
<p>You can contact us by email, dmponline@dcc.ac.uk, but we can only provide
limited support for your installation</p>
</li></ul>
<h2 id="label-Bugs+%26+Feature+Requests">Bugs & Feature Requests</h2>
<ul><li>
<p>Bug Reports & Feature Requests: <a
href="https://github.com/DigitalCurationCentre/DMPonline_v4/issues">github.com/DigitalCurationCentre/DMPonline_v4/issues</a></p>
</li></ul>
<h2 id="label-Prerequisites">Prerequisites</h2>
<p>DMPonline is a Ruby on Rails application and you will need to have Ruby
2.0.0p247 or greater installed on your server and a MySQL server v5.0 or
greater.</p>
<p>Further details on how to install Ruby on Rails applications are available
from the Ruby on Rails site, <a
href="http://rubyonrails.org">rubyonrails.org</a></p>
<p>You may also find the following resources handy:</p>
<ul><li>
<p>The Getting Started Guide: <a
href="http://guides.rubyonrails.org/getting_started.html">guides.rubyonrails.org/getting_started.html</a></p>
</li><li>
<p>Ruby on Rails Tutorial Book: <a
href="http://www.railstutorial.org/">www.railstutorial.org/</a></p>
</li></ul>
<h2 id="label-Copyright">Copyright</h2>
<p>Copyright © 2013 Digital Curation Centre, University of Edinburgh.</p>
<p>This program is free software: you can redistribute it and/or modify it
under the terms of the GNU Affero General Public License as published by
the Free Software Foundation, either version 3 of the License, or (at your
option) any later version.</p>
<p>This program is distributed in the hope that it will be useful, but WITHOUT
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License
for more details.</p>
<p>You should have received a copy of the GNU Affero General Public License
along with this program. If not, see <a
href="http://www.gnu.org/licenses.">www.gnu.org/licenses.</a></p>
</div>
<footer id="validator-badges">
<p><a href="http://validator.w3.org/check/referer">[Validate]</a>
<p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 3.12.2.
<p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3.
</footer>
Marta Ribeiro