nitrc:User Guide - Tool/Resource Feature: Docs
From NITRC Wiki
 |  |
Submitting a New Document
Any tool/resource member may submit documents to the tool/resource document administrator for possible publication for that group. All registered users may submit documents to the NITRC moderator for possible publication for NITRC Community. To submit a document, click the tool/resource menu "Docs" link or NITRC Community menu "Documents" link to get to the main Documents page. There are three ways to submit a document from the main Documents page:
- Click "Submit New Document" at the top of the page. (In this option the document folder is preset to the Main Folder.)
- Click "Add New Document" above the list of documents and folders. (In this option the document folder is preset to the Main Folder.)
- Click the "Add a document" icon to the right of a document folder. (In this option the document folder is preset to the selected folder.)
On the Submit Document page, you may upload a new file, link to a Web site, provide a PubMed link, or compose a new text file. For each you must provide the following information:
Required Fields—indicated by a red asterisk (*) where you must enter data
- Document Title: The document title refers to the relatively brief subject of the document.
- Language: Indicates what language the document is written in. English is the default language.
- Document Folder: Allows you to categorize documents into folders. When a tool/resource registers with NITRC, the Main Folder, Application Publications, and Technical Publications folders are created. Additional folders can be created by a tool/resource administrator. If the document is general in nature for the tool/resource, file the document in the tool/resource Main Folder; otherwise, file the document in an appropriate folder. Counts of the number of approved documents in the Application Publications and Technical Publications folders are shown on the tool/resource Summary page at the bottom of the information box on the right.
- Description: A brief description of the document contents. (This field is not required when submitting a PubMed ID.)
Depending on the type of document you are submitting, you also need to submit one of the following:
- Upload File: Select the file to be uploaded. You can upload text files (.html, .txt) or binary files (.zip, .doc, .pdf).
- External URL: Enter the external site URL where the document can be found.
- PubMed ID: Enter the identifier assigned by PubMed for the document citation.
- Text: Enter your document text.
| Note: Special markup is allowed for text. A WYSIWYG editor is provided to make this easier for commonly used markup, but you may directly enter the special markup in the box. To edit the source code directly, click the "BBCode" button in the WYSIWYG editor.
Special markup for text:
|
| Note: If you choose "Quote" for the style in the WYSIWYG editor, the editor assumes a new paragraph when you press "Enter" on your keyboard and a new box is created. To stay in the same box and move to the next line, press "Shift" and "Enter" on your keyboard. |
Fill in the required fields for the type of document you are submitting and click the "Submit" button. If you have document administration privileges, your document will immediately be available for viewing. For all other users, the document will be placed in the Pending Submissions section of the Document Manager Admin page to be approved or rejected by a tool/resource document administrator or the NITRC moderator for NITRC Community documents. The document will not be viewable until the administrator has approved it.
Viewing Documents
Any user may view approved documents for a tool/resource or NITRC Community. Click the tool/resource menu "Docs" link or the NITRC Community menu "Documents" link to display a list of documents and document folders. Documents containing general information for the tool/resource are displayed first in the tool/resource Main Folder section, followed by a list of document folders that have been created for the tool/resource. Click a document folder to show any documents under that folder. You may click on a document name to view the document.
Deleting an Existing Document
Only members with document administration privileges can delete documents. Any user who notices an out-dated document should send a request to a tool/resource administrator to have the document removed.
