diff --git a/Repositories/otago_eprints/otago_eprints/cfg/static/en/help/index.xpage b/Repositories/otago_eprints/otago_eprints/cfg/static/en/help/index.xpage index 9811ddd..9168595 100755 --- a/Repositories/otago_eprints/otago_eprints/cfg/static/en/help/index.xpage +++ b/Repositories/otago_eprints/otago_eprints/cfg/static/en/help/index.xpage @@ -9,32 +9,34 @@
  • Registering
  • -
  • Depositing Records
  • +
  • Depositing Items -
  • Depositing Process
  • +
  • Your User Record
  • +
  • Managing Your Repository Items
  • + +
  • The Depositing Process +
  • Deposit Type
  • +
  • Succession/Commentary
  • +
  • Bibliographic Information
  • +
  • Affiliations and Subject Categories
  • +
  • Document Storage Formats
  • +
  • Document File Upload
  • +
  • Deposit Verification
  • + -

    Browsing

    +

    Browsing

    Browsing is a good way to access documents if you don't have a specific idea of what you're looking for. There are several ways to browse the repository, including by subject, by year, by publication @@ -48,28 +50,33 @@

    You will be presented with a list of possible values; select one of these and you will be given a list of references to documents in the repository (if any) that match this value. To access a paper, simply -click on its reference in the display.

    +click on its reference in the display.

    On the abstract page, you should be able to see what subjects and affiliations are pertinent to the current document. Clicking on one of -these will take you back to the appropriate browse view.

    +these will take you back to the appropriate browse view.

    -

    Searching

    The repository offers -two levels of searching, simple and advanced. They are similar, but the -advanced form lets you perform a finer-grained search using more fields. -Access the simple search using the More -options link on the front page, or using the navigation bar at the -top of the screen. To perform an advanced search, use either the Advanced search link on the front page, -or at the top of the simple search page.

    + +

    Searching

    -

    Text Search Fields

    +

    The repository offers two levels of searching, simple and advanced. +They are similar, but the advanced form lets you perform a finer-grained +search using more fields. Access the simple search using the More options link on the front page, or +using the navigation bar at the top of the screen. To perform an +advanced search, use either the Advanced +search link on the front page, or at the top of the simple search +page.

    + + +

    Text Search Fields

    +

    These are used to search fields like abstract or author. These are the fields where there is a text entry area, and a popup menu just to the right of it. Type your search terms into the box. You can decide how the system will use your search terms by selecting one of the options from the popup menu just to the right of the input box. For example, -suppose that you have entered the search terms "patient care":

    +suppose that you have entered the search terms "patient care":

    @@ -91,15 +98,17 @@
    -

    Lists of Values

    + +

    Lists of Values

    +

    With these you can select one or more search values from a list. If no value in the list is selected, the system will ignore this field -(i.e., it will retrieve records with any value of this field.)

    +(i.e., it will retrieve records with any value of this field.)

    In cases where an individual record may have more than one value from the list, you can also change the search behaviour by selecting "Any of these" or "All of these" from the popup menu on the right of -the list.

    +the list.

    @@ -114,9 +123,11 @@
    -

    Years

    + +

    Years

    +

    When you're searching a year field, you can specify a single year or -range of years that you're interested in, for example:

    +range of years that you're interested in, for example:

    @@ -137,12 +148,14 @@
    -

    Yes/No Fields

    + +

    Yes/No Fields

    +

    Some fields can have the value yes or no, for example the "Refereed" field. In this case, the search field lets you specify whether you want retrieved records to have the value yes or no for this field, or whether you have no preference, in which case the field isn't used to find -records.

    +records.

    @@ -156,11 +169,12 @@ (alerting) and --> document depositing services. When you register with the system, you can register a username, email address and password which must be confirmed. The system will email you a confirmation URL to -visit to enable the password.

    Before you can start uploading -items, you need to provide some -personal details; the registration e-mail will contain instruction -on how to do this. The same form is used to change user details once -registered.

    +visit to enable the password.

    + +

    Before you can start uploading items, you need to provide some personal details; the +registration e-mail will contain instruction on how to do this. The same +form is used to change user details once registered.

    Depositing Items

    @@ -171,7 +185,7 @@ href="&userhome;">Registered Users Area. You can also change your user details at any time by selecting the "View/change your user record" option in the Registered Users Area. The user -record form is described below.

    +record form is described below.

    Once you've correctly filled out your user record, the registered users page will show a number of options and any any items that you are @@ -179,9 +193,10 @@ editor. The options are described below. Note that the options and information that appear may vary slightly, depending on whether you are in the process of depositing any papers and -whether you have any papers pending entry into the main repository.

    +whether you have any papers pending entry into the main repository.

    -

    Your User Record

    + +

    Your User Record

    Your user record is used to hold contact information about you. Some of this information will be associated with eprints that you upload; some of it is @@ -189,22 +204,22 @@ address and e-mail address are public, so it's inadvisable to put down a home address. (Usually a postal address isn't required.) Information about your operating system is purely to help the repository administrators help -you if you encounter problems.

    +you if you encounter problems.

    Enter the relevant information in the form. A red asterisk (*) indicates a required field that you must -fill out before you can deposit papers in to the repository.

    +fill out before you can deposit papers in to the repository.

    Note that you cannot change your e-mail address here. This is deliberate; if you inadvertently enter an incorrect e-mail address, the site will have no way of contacting you. Instructions for changing your e-mail address can be found in the Registered Users -Area.

    +Area.

    Rather than clicking in each box before you enter something into it, you may find that your browser will let you use the tab key to move the cursor between the boxes, allowing you to enter the information much -more quickly.

    +more quickly.

    When you've entered the relevant information, click on the Update Record button at the bottom of the form. If the @@ -212,8 +227,9 @@ href="&userhome;">Registered Users Area. If there's a problem with the form, the form will be presented to you again with a description of what's wrong. Correct the error and click on Update -Record again.

    +Record again.

    +

    Managing Your Repository Items

    At the top of the Registered Users Area, you @@ -226,7 +242,7 @@ undeposited items list and allow you to start editing it. Note that you can wait until later before completing the submission, and start on another paper. Submissions that you are in the process of uploading are -kept in your undeposited items list.

    +kept in your undeposited items list.

    If there are papers in your undeposited items list, you will see a list of those papers with some options. The title of each paper @@ -237,7 +253,7 @@ Edit: If you select this option, you will be able to continue - depositing the paper. + depositing the paper. Deposit: @@ -304,24 +320,25 @@ -

    The Depositing Process

    +

    The Depositing Process

    The depositing process is divided into a number of stages. You can move between these stages by using the Back and Next buttons at the bottom of each screen. This should be familiar to those accustomed to using the "wizard" style of interface -popular on many modern operating systems.

    +popular on many modern operating systems.

    Don't worry about losing information you've entered when you press the Back button on a form: the system will store everything you've entered when you press it. However, you should not use your browser's "back" button when you are depositing -papers.

    +papers.

    -

    Each stage of the process is described in the following sections.

    +

    Each stage of the process is described in the following sections.

    -

    Deposit Type

    + +

    Deposit Type

    In this screen, you should select the one option on the list that best describes your paper, for example "conference or workshop item" or @@ -330,22 +347,23 @@

    After selecting the deposit type, click on the Next -button.

    +button.

    -

    Succession/Commentary

    + +

    Succession/Commentary

    The repository can link together different versions of the same paper, as well as commentaries and responses to commentaries. These enable a reader to move easily around those versions, commentaries and -responses.

    +responses.

    If the paper you are depositing is a later version of a paper you previously deposited in the repository, enter its ID code into the Later Version Of field. If you used the Use as template option on the Review Items page, then this box will have already been filled out for you, but it can be -overwritten.

    +overwritten.

    To find the ID of a document, use the repository's search feature to find the item. You @@ -356,35 +374,36 @@

    If you are depositing a commentary on a paper in the repository, enter its ID code in the Commentary On field. If you are responding to a commentary, enter the ID code of the commentary you -are responding to in this field.

    +are responding to in this field.

    You can make sure that you've entered the correct ID codes by clicking on the Verify ID's button. The system will then show you what papers the ID codes relate to, so you can ensure that you've entered the right codes. Note that the system will not let you -proceed with the deposit if either ID code is invalid.

    +proceed with the deposit if either ID code is invalid.

    You can of course leave either field empty if your paper is not a later version of another, a commentary or a response. Click on the Next button when you're sure the information you've -entered is correct.

    +entered is correct.

    Note that you cannot deposit a later version of a paper that has been -submitted by someone else.

    +submitted by someone else.

    -

    Bibliographic Information

    + +

    Bibliographic Information

    Next you will be asked to enter bibliographic information about your paper. The exact details that are required will vary depending on the -deposit type you selected in the first stage.

    +deposit type you selected in the first stage.

    Above each input field will be a short explanation of what should be entered into the field. To the left of each input field is the field name. If the field name has a ref asterisk (*), then the field must be filled out before -the paper can be deposited; all other fields are optional.

    +the paper can be deposited; all other fields are optional.

    -

    The following are the types of input field that you may see:

    +

    The following are the types of input field that you may see:

    @@ -430,14 +449,15 @@

    Once you've entered the requested information, click on the Next button. If there are any omissions from the data, the system will explain what is wrong and re-display the form so that -you can fix the problems.

    +you can fix the problems.

    As with user records, most browsers will allow you to use the tab key to move between the input fields, allowing you to enter the information -quickly.

    +quickly.

    -

    Affiliations and Subject Categories

    + +

    Affiliations and Subject Categories

    In the affiliations stage, you should select all of the organisational unit(s) within the University with which your paper is @@ -452,7 +472,7 @@ subjects from the list that best represent the content of your paper. Please try and be as accurate as possible here, and please don't just select lots of categories if you're unsure, just pick the categories -that you are sure of.

    +that you are sure of.

    Once you've selected your subject categories, click on the -Next button.

    +Next button.

    -

    Document Storage Formats

    + +

    Document Storage Formats

    This stage allows you to upload files in various formats and attach them to your deposit. You may upload as many files as required, @@ -479,10 +500,11 @@

    Click the Add a Format to this Item button to start uploading files. You will be presented with a list of possible document formats; choose the one that most closely matches the physical format of -the file that you are uploading (for example, if you are uploading the -slides of a presentation in PDF format, select "PDF" rather than -"Presentation"). If there is no entry for the file format that you want -to upload, select "Other".

    +the file(s) that you are uploading. For example, if you are uploading +the slides of a presentation in PDF format, select "PDF" rather than +"Presentation" (but note that "HTML" can include image and other +supporting files of various formats, as necessary). If there is no entry +for the file format that you want to upload, select "Other".

    You can enter a brief comment about the file format if you wish (this is mandatory if you select a format of "Other"). This is strongly @@ -498,158 +520,181 @@

    This page shows you an overview of the document files you have uploaded to the repository. The table shows the list of formats that you have uploaded on the left, and the number of files you have uploaded in -that format in the middle column.

    +that format in the middle column.

    If you want to upload some files for a format, or remove some files you've already uploaded for a format, click on the relevant "Upload/Edit" button. When you do this, you'll be presented with the -"Document file upload" screen described in the next section.

    +"Document file upload" screen described in the next section.

    To remove all of the files for a format completely, click on the -relevant "Remove" button.

    +relevant "Remove" button.

    Note that you must upload files for at least one of the formats shown -in bold type.

    +in bold type.

    The "Other" format allows you to upload the document in any other format you think may be useful. For example, you may wish to upload a -Microsoft Word document.

    +Microsoft Word document.

    When you're happy that you've uploaded all of the document files, click on the "Finished" button. Later, you'll have a chance to make sure that the uploads have all worked, and to come back and fix anything that's -amiss.

    +amiss.

    Once you've clicked the "finished" button on this page, you'll be taken to the "Deposit Verification" page described in a later -section.

    +section.

    --> -

    Document File Upload

    + +

    Document File Upload

    You will now be presented with an upload page from which you can -select how you'd like to upload files to the repository.

    +select how you'd like to upload files to the repository (described +below).

    -

    Single file

    +

    When you have finished uploading files, click the +Finished button, and you will be taken back to the +Documents Attached to Item page, which will now display +a list of the formats attached to your deposit, and the number of files +for each format. Use the Edit button to change the +files for a format, or the Remove button to completely +delete a format and all its attached files.

    -

    Choose this option if you want to upload a single file from your -computer as-is. For example, if you have a PDF file on your hard disk, you -would choose this option. If you have to upload more than one file using -this method (for instance, an HTML file and a corresponding .gif figure -image file,) then type the number of files you wish to upload into the -"Number of files to upload" box. From an existing Web site. -

    - -

    If your paper is up on the Web already, this option will let you -specify the URL of that paper. The repository software will copy your paper -from that Web site. You should be careful with this option, though; and -read the "uploading from an existing Web site" section below. -As a ZIP archive/Compressed TAR archive.

    - -

    Your paper may be stored in several separate files. This is often the -case if your paper is stored in HTML format and contains figures. These -two options let you use the ZIP tool (available on all operating -systems) or the "tar" and "compress" tools (commonly used on UNIX -systems) to collect all of those files into one compacted file. -Now click on the "Upload" button. -

    - -

    If you selected "plain files" or are uploading a compressed file, you -will be presented with a screen where you can either type in the full -filename and path of the document file or compressed file into the text -field, or (recommended) click on the "Browse..." button, and select the -relevant file using the file selector1. If you're uploading more than one -file, there will be a corresponding number of these fields to fill -out.

    +

    Click the Add another Format to this Item button to +attach more files, or click the Next button if you have +finished uploading files.

    -

    If you selected "from an existing Web site," enter the full URL of -the first page of the actual document; don't just enter the URL of the Web -site the document appears in or the URL of an index or contents page. See -the section "uploading from an existing Web site" below.

    +

    Upload Files from Your PC

    -

    When you've entered the filenames or URLs, click on the "Upload" -button. You'll then be taken back to the "Document File Upload" -screen.

    +

    Choose this option if the file(s) associated with this format are +somewhere on your PC's hard disk. To upload a file, click on the +Choose File button, and find the file using the file +browser that appears. Then click the Upload to upload +the file to into the system.

    + +

    A list of all the files that you have uploaded so far for this format +appears near the top of the page. You can remove an uploaded file by +clicking on the Delete option next to the file. +Delete all files will wipe the slate clean (for this +document storage format only) so that you can start again.

    + +

    Your paper may comprise a single file (such as a PDF), or it may be +stored in several separate but interconnected files. This is often the +case if your paper is stored in HTML format and contains figures. +EPrints can take all of these related files and treat them like a single +attachment, rather than as several distinct attachments. (Note that if +you want to attach several files in the same format, such as the data +files used in your experiments, you should either upload these as +separate attachments, or combine them all into a single compressed +archive and attach that).

    + +

    You have three options for uploading files into the system:

    + +
    + + + + + + + + + + + + +
    Single file:Choose this option if you want to upload a single + file from your computer as-is. For example, if you have a PDF + file on your hard disk, you would choose this option. If you + have more than one file to upload, you will need to repeat the + upload process for each file.
    Multiple files (.ZIP):This option lets you use a ZIP tool (available on + all operating systems) to collect all of the files for your + deposit into one compressed archive. When you upload this file + into the system, it will automatically expand the archive and + attach the individual files to your deposit.
    Multiple files (.tar.gz):This is identical to the previous option, except + that it uses the tar and gzip tools (commonly used on UNIX + systems).
    + +

    Note that if you want to attach a compressed archive file (such as a +.ZIP file) to your deposit as-is, you should use the Single +file option. However, if you get it wrong, it is easy to remove +the attached files.

    At least one file needs to be shown first. In many cases (e.g. PDF, -Postscript) there will only be one file; if you've uploaded many files you -will need to select the one to be shown first. This should be the first -file in the document that a reader should be presented with; the .html -file if your document is in HTML format, or the contents page if your -document is spread over several uploaded several HTML documents. Use the -"Show First" button to tell the system which file should be shown -first.

    - -

    The "Delete" buttons on the right of the table can be used to remove -individual files that you've uploaded in error. "Delete all files" will -wipe the slate clean (for this document storage format only) so you can -start again.

    - -

    You can continue to upload more files as before. If you've uploaded all -necessary files, click on "Finished". This will take you back to the -"Document Storage Format" page.

    - -

    Uploading From an Existing Web Site

    - -

    When you give the repository a URL to retrieve your document from, the -repository stores a copy of the file stored at that URL. If the URL is an -HTML file, the repository will also copy the images associated with that HTML -file, and other HTML files linked to it.

    - -

    You must supply the URL of the first page of document itself: NOT the -URL of the whole Web site, or the URL of any contents page listing -multiple documents, index page or abstract page.

    +PostScript) there will only be one file, but if you've uploaded many +files for this format you will need to select the one to be shown first. +This should be the first file in the document that a reader should be +presented with; the main .html file if your document is in HTML +format, or the contents page if your document is spread over several +linked documents. Use the Make Primary option to tell +the system which file should be shown first.

    +

    Capturing Files from a URL

    -

    http://www.myinstitution.edu/~myhomepage/paper.html +

    If your paper is already available elsewhere on the Web, this option +will let you specify the URL of that paper. The repository software will +then copy your paper from that Web site. If the URL points to an HTML +file, the repository will also copy the images associated with that HTML +file, and any other HTML files directly linked to it.

    -And NOT +

    You must supply the URL of the first page of the actual document +itself, NOT the top-level URL of the web site that the +document appears on, nor the URL of a contents page listing multiple +documents, an index page or an abstract page. For example:

    -www.myinstitution.edu/~myhomepage/

    +

    http://www.myinstitution.edu/~myhomepage/paper.html (CORRECT)
    +www.myinstitution.edu/~myhomepage/ (INCORRECT)

    In order to prevent the repository from trying to copy the whole World Wide Web by following every single link, some rules are applied when the -system collects your document:

    +system collects your document:

    -

    Only files reached by "relative" links are retrieved. For example, if -the HTML contains a link to node1.html then node1.html will be copied. If -the link points to http://somewebsite.edu/bar.html, then that URL will not -be copied.

    +

    This method of uploading papers cannot have a guaranteed 100% success -rate. However we have been using it here at Southampton for a number of -months and it usually works very well.

    +rate. However it has been used at Southampton University for quite some +time and usually works very well. If something does go wrong, it's +normally best to select Delete All Files from the +Document File Upload screen, and try a different +uploading method.

    -

    If something does go wrong, it's normally best to select "delete all -files" from the "Document File Upload" screen, and try another -uploading method.

    + +

    Deposit Verification

    -

    Deposit Verification

    - -

    This page will display the abstract page for your document as it will -appear in the repository. You should carefully check that all information has -been uploaded correctly. Note that your paper will not appear in the -"available versions" or "commentary/response" lists at the bottom of -the page; this is normal.

    - +

    This page displays the abstract page for your document as it will +appear in the repository. You should carefully check that all +information has been uploaded correctly. Note that your paper will not +appear in the "available versions" or "commentary/response" lists at the +bottom of the page; this is normal.

    You should also check that the document files have been uploaded correctly, including any associated figures and links. If you spot a -mistake, you can use forms' "back" buttons (not the browser's "back" -button) to cycle back through the depositing process and fix any -mistakes.

    +mistake, you can use the Back buttons (not the +browser's "back" button) to cycle back through the depositing process +and fix any mistakes.

    If you're satisfied that everything is correct and has been uploaded correctly, and have read, understood and complied with the agreement at -the bottom of the page, click on the "Deposit" button to deposit your -paper in the repository. It will then be put in the editorial -buffer.

    +the bottom of the page, click on the Deposit button to +deposit your paper in the repository. It will then be put in the +editorial buffer.