8/10/2019 Top Tips for Authors

1/5

8/10/2019 Top Tips for Authors

2/5

2. SETTINGUPYOURPREFERENCESIN REVMAN5

WhenyoufirstbeginusingRevMan5,setupyourpreferences.Todothis,gotoTools>

Preferences.

o OntheGeneraltabfillinyournameintheUsersRealNameboxessoifyouuse

TrackChanges,

your

comments

will

be

linked

to

you

by

your

initials.

o

StillontheGeneraltab,intheMiscellaneousboxselectEverysessionforwhenyou

wanttoCheckforupdatestoRevMan.

o

TickthetopthreeboxesatthebottomofthesameMiscellaneousbox(two

warningsandonevalidationcheck).Thiswillassistyoutomaintainversioncontrol

byensuringyoudonottomixupthelatestversionandbackupcopiesofyour

review.

o NowgototheConnectiontabandenteryourArchieUserNameandPasswordand

ticktheboxnexttoSaveusernameandpasswordwhenRevManisclosedunless

youshare

your

computer

with

others,

in

which

case

you

would

not

want

to

do

this.

o StillontheConnectiontab,checkthattheServeraddressissettoArchieServerand

clickTesttochecktheconnection.

o Toprotectagainstaccidentaldataloss,RevManwillautomaticallysavealocal

backupofyourreviewatregularintervals.Thedefaultisevery10minutes,butthis

canbechangedinyourPreferences(Tools>Preferences:Filestab).Thebackupfile

issavedbydefaulttoyourcomputerstemporaryfolder,butyoucanspecifya

differentlocationonthesametab(Files)ofyourPreferences.

o Tip:Ifyourcomputer(orRevMan)crasheswhileyouareworkingonareview,you

willbe

given

the

option

to

open

the

latest

backup

of

the

review

the

next

time

you

openRevMan.

o Tip:IfaRevManupdatehasbeenreleased,andyouhavesetyourPreferencesas

indicatedabove,thenexttimeyouopenRevManitwillbringupaboxsaying'An

updatetoRevManisavailablefrom...' clickon'download'andfollowthe

installationprompts.

o

Tip:YoucanspecifythemaximumnumberofrecentfilestobelistedonunderTools

>Preferences:Filestab.

3.CHECKING

YOUR

REVIEW

OUT

FOR

EDITING

o Whenyouarereadytobeginworkonaneworexistingreview,youwillneedto

checkthereviewoutfromArchietoRevMan5.Todothis,gotoFile>MyReviews

orclicktheMyReviewsbuttononthemaintoolbar.IntheMyReviews window,

clickthereviewyouwanttoeditandclickOK.AConfirmActionwindowwillopen

clickCheckOuttoconfirmthatyouwanttocheckthereviewout.Thiswillprevent

othersfromaccessingthereviewwhileyouareworkingonit.

o

WerecommendthatyoucheckthereviewbackintoArchieattheendofeach

editingsessionbutyoucanalsosavethereviewlocallyinbetweeneditingsessions

(see6.

Saving

reviews

locally,

below).

8/10/2019 Top Tips for Authors

3/5

o Tip:Ifyoujustwanttoreadyourrevieworprintacopy(withoutediting),youdonot

needtocheckitouttoRevMan5(see7.Accessingyourreview,below).

4. CHECKINGADRAFT BACK INTOARCHIEBEFOREITISREADY FOR EDITORIAL

CONSIDERATION

o

TocheckareviewintoArchiefromwithinRevMan5,gotoFile>CheckInorclickthe

CheckInbuttononthemaintoolbartoactivatetheCheckinWizard.

o

Ifthedraftyouarecheckinginisnotyetreadyforeditorialconsideration,entera

VersionDescription(e.g.RoBtablesfinished,dataentered)onthefirstscreenof

theWizardsothatyouandyourcoauthorswillremember/knowwhatyoudid,then

clickFinish.Youshouldgetamessagesayingthedraftwassuccessfullycheckedin.If

thecheckinreportsuggeststherewasanyproblemwiththecheckin,please

contactyourManagingEditor.

o Tip:YouhavetheoptionofsubmittingthereviewforEditorialapprovalwhenyou

checkdrafts

into

Archie;

ifyou

are

intending

to

keep

the

review

available

for

you

andyourcoauthorstoaccess,youshouldnotselectthisoption.

5. CHECKINGADRAFT BACK INTOARCHIEFOR EDITORIALAPPROVAL

o IfyouarereadytocheckinthedrafttoyourReviewGroupforeditorialreview,in

RevMan5gotoFile>Reports>ValidationReportandcheckandfixalltheErrors

andasmanyWarningsyoucan.

o GotoFile>CheckInandenteraVersionDescription(seeaboveexample),thenclick

Next.Onthesecondscreen,ticktheboxSubmitforeditorialapprovalandclick

Next.Check

each

box

to

confirm

the

listed

tasks

have

been

completed

and

click

Next.

o YoucantypeamessageintheMessagebox,thusalleviatingtheneedtosenda

separateemailtotheReviewGroup,unlessyouhaveanattachmentyoualsowish

tosend.

o

Whenyouhavecompletedalltheabovesteps,clickFinish.

o Tip:YoucancheckadraftinforEditorialapprovalwithWarningsbutnotErrors.

Anysignificantmissinginformation(forexample,missinglinksforfigures)willbe

flaggedasanErrorandwillpreventthereviewfrombeingcheckedinforEditorial

approval.

o Tip:OnceadrafthasbeencheckedinforEditorialapprovalyouwillnotbeableto

checkthereviewbackoutagainuntiltheReviewGrouphascompleteditseditorial

review.

6. SAVINGREVIEWSLOCALLY

WerecommendthatyoucheckreviewsbackintoArchieattheendofeveryediting

session,buttheremaybesituationswherethisisimpossibleorunnecessary;forexample,

youmaybeunabletoaccesstheInternetwhileyouareworkingonareview,oryoumaybe

certain

that

no

one

else

will

need

to

access

the

review

for

some

time.

In

such

cases,

saving

yourRevManfilestoyourcomputerisanoption.

8/10/2019 Top Tips for Authors

4/5

o TosaveareviewlocallyfromwithinRevMan,useFile>SaveorclicktheSave

buttononthemaintoolbar.Ifthisisthefirsttimeyouhavesavedthereview,a

Savedialogwillopenaskingyoutoconfirm:(a)thedirectoryonyourcomputer

wherethefileshouldbesaved;and(b)thefilename.Ifyouhavepreviouslysaved

thereview,resavingwillautomaticallyoverwritetheexistingfileinthesame

location.Toresavetoadifferentlocation,orusingadifferentfilename,useFile>

SaveAs,andchangethesuggestedoption(s)asdesired.Whenyouarefinished

withyoureditingsession,savethefileandthenclicktheXintheupperrightcorner

ofthereviewwindowtoclosethereview.

o Toopenafilesavedtoyourcomputerforfurtherediting,useFile>Open,orFile>

RecentFiles.

o Tip:Closingthereviewwithoutsavingwillmeanthatyouwillloseallchangessince

yourlastsaveorthelastautomaticlocalbackup.

o Tip:Unlessabsolutelynecessary,dontstoreyourreviewforalongtimeonyour

computer.CheckitbackintoArchiesothemostrecentversionisalwaysstored

there.

7. ACCESSINGYOURREVIEWFROMWITHINREVMAN VERSUSBYLOGGINGIN

TOARCHIE

o YouneedtocheckyourreviewouttoRevManfromArchieonlyifyouplantomake

changestoit.

o Doyoujustwanttohavealookatyourreviewwithouteditingit?Ifso,youcanread

itdirectlyinArchiebyloggingintoArchie(http://archie.cochrane.org),rightclicking

thetitleintheResourcesfolderview,andselectingViewtoreadthelatestor

publishedversion.Youcansave,printorproduceaPDFoftheversionyouare

viewingbyclickingtheappropriatebuttonintheupperleftofthedocumentviewer.

o

Otherwise,youcandownloada(readonly)copyofyourreviewfromwithin

RevMan.Todothis,gotoFile>CheckOutorclicktheCheckOutbuttononthemain

toolbar.IntheCheckOutwindow,clickthereviewyouwanttodownloadandtick

theboxmarkedDownloadacopyofthereviewwithoutlockingitforothers(notfor

editing)(bottomlefthandcorneroftheCheckOutwindow).

o

YoudonthavetologintoArchietoaccessyourreview.Aslongasyouhave

Internetaccess,fromRevMan5onyourcomputeryoucan:

o CheckoutyourreviewfromArchie

o

Edityourreview

o

CheckyourreviewbackintoArchie

o Downloadareadonlycopyofyourreview

o YouonlyneedtogointoArchietocheckandchangeyourcontactdetails,toread

earlierversionsofyourreview,tocomparedifferentversionsofyourreview,orto

accessaPDF

version

of

your

review.

8/10/2019 Top Tips for Authors

5/5

o Tip:Onceyou(oranyoneelse)havecheckedoutareview,nooneelsecanaccessit

untilyoucheckitbackintoArchieagain.Checkingoutthereviewlocksitonthe

server,preventinganyonefrommakingchangestothedocumentuntilyouhave

checkedthereviewbackin.

o

Tip:

If

you

checked

out

a

review

from

Archie

then

decided

you

didn't

have

to

make

anyedits,youdonothavetocheckitbackintoArchieinordertounlockitallow

otherstoaccessit.Instead,youcanundothecheckoutbyexitingRevMan(File>

Exit)orclosethereviewinRevMan5byclickingontheClosebuttonontheright

handsideofthescreenoppositethereviewtitle.Youwillthenbepromptedto

'ConfirmUndoCheckout'andshouldanswer'Yes'.Alternatively,youcanundothe

checkoutinArchie(rightclickonthereviewtitle>Undocheckout).

8. HELPULDOCUMENTSANDRESOURCES

o

ArchieHelpfile

o

RevMan5Help

file

o RevMan5Tutorial

o

RevMan5FAQ(http://ims.cochrane.org/revman/documentation/faq)

o RevMan5QuickstartforAuthors(http://ims.cochrane.org/support/authors)or

(http://ims.cochrane.org/archie/documentation/QuickstartforAuthors.pdf)

o

RevMan5installationandconnectionsettings

(http://ims.cochrane.org/revman/support/RevMan5installationand

connection.pdf)

o

Informationand

links

to

software

related

resources

relevant

for

Cochrane

authors

(http://ims.cochrane.org/support/authors)

o IntroductorypresentationonArchieforAuthorsandeditors(PowerPoint

presentation)(http://ims.cochrane.org/support/authors)