![]()
![]()
![]()
![]()
![]()
![]()
![]()
![]()
![]()
Papers Page Documentation
Main Directories, Scripts and Content
- Papers Template
- Papers
- best-5-pubs.shtml
- condensed.shtml
- Grant Directory
- help.shtml
- index.html
- index-all.html
- Lab Papers
- links.html
- Medline.txt
- NCBIData.xml
- new.html
- papers-020128.shtml
- Papers before 1997
- before97.shtml
- before97-simple.html
- papers-before-1997.xml
- papers-endnote.html
- papers-ids.htm
- papers-research.shtml
- papers-simple.html
- papers-tags.htm
- papers.xml
- Skel Directory
- Subject Directory
- E-print
- Details of Updating Papers Process
Papers Template
Password-protected directory on the server containing scripts for generating the papers site.
Important Files
- downloadXML.cgi
- importEprint.sh
- papers.cgi
- papers.pl
- rollback.cgi
Update Grid and Forms
Other Files
- editform.html
- formupdate.cgi
- grid.html
- grid.pl
- Individual Directory
- indvupdate.cgi
- update.cgi
- downloadMEDLINE.cgi
- test.cgi
- edit.cgi
- wgetxml.pl
downloadMEDLINE.cgi
- To get the huge ugly URL from Medline
- Output to file Medline.txt
See also: downloadXML.cgi.
downloadXML.cgi
- Obtains a complete listing of publications from PubMed. This is a non-trivial task (and currently relies on the NCBI not changing any aspect of their site).
- This script should be invoked whenever a new paper is published.
- The downloaded file is /web/papers/NCBIData.xml.
See Also: NCBIData.xml.
edit.cgi
- Old cgi file to edit citation files from website
Update Grid and Forms
Contains:
- Individual Directory
- indvupdate.cgi
- editform.html
- formupdate.cgi
- grid.html
- grid.pl
- update.cgi
The Update Grid and Forms are made to update the papers page from the papers website.
- The Update Grid displays the LabID, Author, Journal, Title of individual papers and allows for individual updates to grants and subjects. The form calls update.cgi and updates the grant and subject tags in the individual citation files in /web/e-print.
- The Create New E-print form allows for the creation of a new paper. The form calls formupdate.cgi and creates a new e-print directory and citation.xml file in /web/e-print.
- The Individual Update forms allows for the update of individual citation files. The form calls indvupdate.cgi which updates the individual citation files in /web/e-print.
See also: editform.html, formupdate.cgi, grid.html, Individual Directory, indvupdate.cgi, and update.cgi.
editform.html
Form to Create a new E-print. Calls formupdate.cgi See also: editform.html, formupdate.cgi, grid.html, Individual Directory, indvupdate.cgi, and update.cgi.
formupdate.cgi
- Called from editform.html
- Creates new folder in the e-print directory named [labid] with a citation.xml.
- Creates new folder in the e-print directory named [labid] with citation.xml. (This is so the grid can regenerate with the new paper)
See also: editform.html, formupdate.cgi, grid.html, Individual Directory, indvupdate.cgi, and update.cgi.
grid.html
- The Update Grid displays the LabID, Author, Journal, Title of individual papers and allows for individual updates to grants and subjects. The form calls update.cgi and updates the grant and subject tags in the individual citation files in /web/e-print.
See also: editform.html, formupdate.cgi, grid.html, Individual Directory, indvupdate.cgi, and update.cgi.
grid.pl
- Called from each update cgi file to regenerate grid.
- Generates grid,html from the skel directory.
- Generates individual files named [labid].html in the "individual" folder that show information in the [labid]'s citation file. This form is used to edit the existing citation files.
See also: editform.html, formupdate.cgi, grid.html, Individual Directory, indvupdate.cgi, and update.cgi.
Individual Directory
- Contains individual files named [labid].html in the "individual" folder that show information in the individual citation file. This form calls the script indvupdate.cgi to edit existing individual citation files in the /web/e-print directory.
See also: editform.html, formupdate.cgi, grid.html, Individual Directory, indvupdate.cgi, and update.cgi.
indvupdate.cgi
- Called from /web/papers/individual/[labid].html.
- Updates existing e-print citation.xml files with information from individual forms in "individual" directory.
See also: editform.html, formupdate.cgi, grid.html, Individual Directory, indvupdate.cgi, and update.cgi.
update.cgi
- Called from grid.html.
- Updates the citation.xml files of all files with the "update" checkbox checked ("update" checkboxes are automatically checked if any changes are made to the "grants" or "subjects" checkboxes of the individual [labid] on the grid).
See also: editform.html, formupdate.cgi, grid.html, Individual Directory, indvupdate.cgi, and update.cgi.
importEprint.sh
- Called from papers.cgi
- Creates the directory /web/papers/skel and copies over all citation files from e-print directory.
- Backs up the existing copy of /web/papers to /web/papers_template/backup/skel_DATE.tar.gz, which can later be recovered.
See also: papers.cgi and skel
papers.cgi
Most important papers people will use, simply invokes other scripts.
- Creates copies of help folders, citation examples, copy of scripts in /web/papers
- Copies /web/papers_template/html and .xml files in papers_template to /web/papers
- Copies /web/papers_template/scripts and /web/papers_template/helpto /web/papers/xml
- Calls ImportEprint.sh : /web/papers_template/ImportEprint.sh
- Calls papers.pl : /web/papers_template/papers.pl
See also: papers.pl and importEprint.sh
papers.pl
NOTE: DownloadXML.cgi : /web/papers_template/DownloadXML.cgi must be run at least once before running this script
- papers.pl is a script that takes a main XML file containing a list of articles in NCBI format, and collects information contained in the copies citation.xml files found in /web/papers/skel which specify supplimental information for the articles in the main file. It will add any papers not in the list downloaded from the NCBI to the overall list, which is saved in the file /web/papers/papers.xml. The following files are produced by this script:
/web/papers/index.html
/web/papers/paper-tags.htm
/web/papers/paper-ids.htm
/web/papers/papers-simple.html
/web/papers/papers.xml
/web/papers/[labid]/index.html
/web/papers/grant/index.html
/web/papers/subject/index.htmlDetails of papers.pl (In order performed):
Function generateDOM: Creates papers.xml from NCBIData.xml (Papers.xml is basically in the format of the citation files.)
##################################
#---------- MAIN INDEX ----------#
##################################
Creates index.html : /web/index.html- Print header
- Print Paper Total, each year total
- For each paper:
- Print paper using &printPaper()
- Make subdirectory : /web/papers/"labid
- Create Index.html : /web/papers/"labid"/index.html
- Create index-all.html : /web/papers/"labid"/index-all.html
########################################
#---------- SIMPLIFIED INDEX ----------#
########################################
Creates papers-simple.html : /web/papers/papers-simple.html a text version of papers pageCreates before97-simple.html : /web/papers/before97-simple.html a text version of he before97 papers page
- Print Paper Total, each year total
- For each Paper:
- print paper using &printNARCitation()
- Creates before97-simple.html and prints text version of papers before 1997
###########################################
#---------- INDEX WITH XML TAGS ----------#
###########################################
Creates papers-tags.htm : /web/papers/papers-tags.htm a tag version of the papers pageCreates papers-ids.htm : /web/papers/papers-ids.htm a table displaying all papers linked to from "other"
- Print tags of each Paper manually to papers-tags.htm
- Creates table and adds each paper manually to papers-ids.htm
###################################
#---------- GRANT PAGES ----------#
###################################
Note: Grants are created by creating a new directory in /web/papers/grant with an info.xml file and a description.html file.Creates index.html for Grants page : /web/papers/[grant]/ from info.xml
- Calls function &createGrantPage()
- Creates grant index page using info.xml and variable in program that holds the content of papers.xml
- Includes description.html
- Prints papers associated with grant using &printPaper()
###################################
#--------- SUBJECT PAGES ---------#
###################################
Note: Subjects are created by creating a new directory in /web/papers/subject with an info.xml file and a description.html file.Creates index.html for Subjects page : /web/papers/[subject]/ from info.xml
- Calls function &createSubjectPage()
- Creates subject index page using info.xml and variable in program that holds the content of papers.xml
- Includes description.html
- Prints papers associated with subject using &printPaper()
See also: papers-tags.htm, papers-ids.htm, papers.xml, Grants, Subjects and papers-simple.html
rollback.cgi
- Recovers an earlier version of the papers page from the last backup found in /web/papers_template/backup
Papers
Contains:
See also: Grant Directory, Subject Directory, skel Directory, papers-simple.htm, papers-tags.htm, and update.cgi.
- Grant Directory
- Subject Directory
- Skel Directory
- All lab paper directories each containing:
- index.html
- index-all.html
- All files generated by papers scripts
Grant Directory
- Directory containing a folder [grantid] for each grant, each containing:
used to generate the grant page.
- info.xml
- description.html
See also: Subject Directory
index.html
- Redirects to the front page
index-all.html
- Redirects to the front page
Lab Papers
Individual directories [labid] that contain an index.html file and an index-all.html file. The index.html file is short version of the index-all.html file, displaying the Title, Authors, and links to the website, pre-print, and medline. The index-all.html file displays the contents of the paper's citation file as well the information from the index.html file.
links.html
- Contains links to the Lists of Papers, Pre-prints, Xml Dumps, Zip Archives, and Medline Queries
NCBIData.xml
- A complete listing of the lab's publications downloaded from PubMed.
Papers before 1997
- The html, xml, and simple html file for papers before 1997.
papers-ids.htm
- A table containing all papers: LabId, Author, PubMed, Website, Title, and Journal.
papers-simple.html
- A text version of the papers page
papers-tags.htm
A compilation of all citation files.
papers.xml
- Xml file generated by papers.pl that contains citation information from NCBIData.xml and the "skel" directory. This xml file is used to generate the papers page.
Skel Directory
A directory containing folders [labid] each with a citation.xml file. This is used to generate papers.xml in papers.pl as well as the update grid.
Subject Directory
- Directory containing a folder [subjectid] for each subject, each containing:
used to generate the grant page.
- info.xml
- description.html
E-print
- Directories for all papers
- Each directory has 1) citation.xml 2) preprint or reprint files (optional) 3) extra figures or documents (optional)
Details of the Updating papers process
Root directory: /web/papers
In order performed:
-------------------------------------------------------------------------------------------------------------
Update Papers Calls : Papers.cgi: /web/papers_template/papers.cgi
-------------------------------------------------------------------------------------------------------------
Creates copies of help folders, citation examples, copy of scripts in /web/papers
-------------------------------------------------------------------------------------------------------------- Copies 1) /web/papers_template/html 2) .xml files in papers_template to /web/papers
- Copies 1) /web/papers_template/scripts 2) /web/papers_template/helpto /web/papers/xml
-------------------------------------------------------------------------------------------------------------
Calls ImportEprint.sh : /web/papers_template/ImportEprint.sh
-------------------------------------------------------------------------------------------------------------
ImportEprint.sh backs up the old skel directory containing the citation.xml files, and copies the updated files from the e-print directory to the skel directory-Deletes old skel directory
- Creates new skel directory and Copies over all citation files from e-print directory-------------------------------------------------------------------------------------------------------------
Calls papers.pl : /web/papers_template/papers.pl
-------------------------------------------------------------------------------------------------------------NOTE: DownloadXML.cgi : /web/papers_template/DownloadXML.cgi must be run at least once before running this script
In order performed:
- Function generateDOM: Creates papers.xml from NCBIData.xml (Papers.xml is basically in the format of the citation files.)
##################################
#---------- MAIN INDEX ----------#
##################################
Creates index.html : /web/index.html- Print header
- Print Paper Total, each year total
- For each paper:
-Print paper using &printPaper()
- Make subdirectory : /web/papers/"labid
- Create Index.html : /web/papers/"labid"/index.html
- Create index-all.html : /web/papers/"labid"/index-all.html########################################
#---------- SIMPLIFIED INDEX ----------#
########################################
Creates papers-simple.html : /web/papers/papers-simple.html a text version of papers pageCreates before97-simple.html : /web/papers/before97-simple.html a text version of he before97 papers page
- Print Paper Total, each year total
- For each Paper:
- print paper using &printNARCitation()
- Creates before97-simple.html and prints text version of papers before 1997###########################################
#---------- INDEX WITH XML TAGS ----------#
###########################################
Creates papers-tags.htm : /web/papers/papers-tags.htm a tag version of the papers pageCreates papers-ids.htm : /web/papers/papers-ids.htm a table displaying all papers linked to from "other"
- Print tags of each Paper manually to papers-tags.htm
- Creates table and adds each paper manually to papers-ids.htm###################################
#---------- GRANT PAGES ----------#
###################################
Note: Grants are created by creating a new directory in /web/papers/grant with an info.xml file and a description.html file.Creates index.html for Grants page : /web/papers/grant/ from info.xml
- Calls function &createGrantPage()
- Creates grant index page using info.xml and variable in program that holds the content of papers.xml
- Includes description.html
- Prints papers associated with grant using &printPaper()###################################
#--------- SUBJECT PAGES ---------#
###################################
Note: Subjects are created by creating a new directory in /web/papers/subject with an info.xml file and a description.html file.Creates index.html for Subjects page : /web/papers/subject/ from info.xml
- Calls function &createSubjectPage()
- Creates subject index page using info.xml and variable in program that holds the content of papers.xml
- Includes description.html
- Prints papers associated with subject using &printPaper()