Difference: LHCbDocs (1 vs. 36)

Revision 362019-08-23 - PatrickSKoppenburg

Line: 1 to 1
 

Version-controlled LaTeX documents in LHCb

This is about git-based solutions. svn is being retired on 21 February 2019. The obsolete documentation for svn can be found here.

Line: 22 to 22
 Overleaf is a commercial wysiwyg LaTeX interface supported by CERN. It recently bought ShareLaTeX and the merger of the two platforms resulted in overleaf v2. You can put any kind of LaTeX document there. The Editorial Board (EB) will request you to put your paper there during the EB process.
  • Get an account at overleaf/cern. PK logs in via ORCID id, which works well. Your user name is your e-mail address.
  • Create a new project
Changed:
<
<
    • You can either share a project with a defined set of users, or with anyone who has the link. While not ideal (overleaf is working on implementing CERN sign-on), we consider this safe enough. I allows all EB members and reviewers to peek at the paper.
>
>
    • You can either share a project with a defined set of users, or with anyone who has the link. While not ideal (overleaf is working on implementing CERN sign-on), we consider this safe enough. It allows all EB members and reviewers to peek at the paper.
 
    • Since beginning of 2019, overleaf v2 projects can be directly git-cloned. You will need your overleaf username and password.
    • Do not export a project to dropbox! doing so destroys the history and may overwrite comments from EB members.
  • Overleaf can be used to comment directly on the paper.
Changed:
<
<
    • Comments can be added in the source. Click on "Review" to view them. The project owner should tick "track changes" at the top of the comments column.
>
>
    • Comments can be added in the source. Click on "Review" to view them. Track The project owner should tick "track changes" at the top of the comments column and allow them for everyone.
 
    • Comments can also be made on pdf with the packages described here. See an example. However the two kinds of comments are not the same, unfortunately.
  • EB members and reviewers may also fix obvious mistakes directly.
    • Tagged versions can be compared in History & Revisions mode and undone. It is therefore recommended proponents and EB members tag versions frequently.
Added:
>
>
  • Please make sure the draft you send compiles. Overleaf will happily produce a pdf even if there are errors. Watch out for the red flag next to "Recompile". bad good
 

lhcb-docs group on gitlab

Line: 59 to 61
 -- PatrickSKoppenburg - 2018-12-21

META FILEATTACHMENT attachment="LHCbDocs.jpg" attr="" comment="" date="1287573919" name="LHCbDocs.jpg" path="LHCbDocs.jpg" size="81352" stream="LHCbDocs.jpg" tmpFilename="/usr/tmp/CGItemp10321" user="tskwarni" version="1"
Added:
>
>
META FILEATTACHMENT attachment="bad.png" attr="" comment="Compilation errors in overleaf" date="1566547109" name="bad.png" path="bad.png" size="3289" user="pkoppenb" version="1"
META FILEATTACHMENT attachment="good.png" attr="" comment="Compilation errors in overleaf" date="1566547109" name="good.png" path="good.png" size="3455" user="pkoppenb" version="1"
META FILEATTACHMENT attachment="Track.png" attr="" comment="" date="1566547575" name="Track.png" path="Track.png" size="31425" user="pkoppenb" version="1"

Revision 352019-04-29 - PatrickSKoppenburg

Line: 1 to 1
 

Version-controlled LaTeX documents in LHCb

This is about git-based solutions. svn is being retired on 21 February 2019. The obsolete documentation for svn can be found here.

Line: 26 to 26
 
    • Since beginning of 2019, overleaf v2 projects can be directly git-cloned. You will need your overleaf username and password.
    • Do not export a project to dropbox! doing so destroys the history and may overwrite comments from EB members.
  • Overleaf can be used to comment directly on the paper.
Changed:
<
<
    • Comments can be added in the source. They will appear as small windows on the tex file in rich text mode, or commented blocks in source mode.
>
>
    • Comments can be added in the source. Click on "Review" to view them. The project owner should tick "track changes" at the top of the comments column.
 
    • Comments can also be made on pdf with the packages described here. See an example. However the two kinds of comments are not the same, unfortunately.
  • EB members and reviewers may also fix obvious mistakes directly.
    • Tagged versions can be compared in History & Revisions mode and undone. It is therefore recommended proponents and EB members tag versions frequently.

Revision 342019-02-13 - MarkRichardJamesWilliams

Line: 1 to 1
 

Version-controlled LaTeX documents in LHCb

This is about git-based solutions. svn is being retired on 21 February 2019. The obsolete documentation for svn can be found here.

Line: 33 to 33
 

lhcb-docs group on gitlab

Changed:
<
<
Past, present and future LHCb documents with an assigned LHCb ID will be hosted in lhcb-docs. The transition from svn is ongoing and thus the group is not yet in production. Interested users can ask for a project by contacting Patrick.Koppenburg@cernNOSPAMPLEASE.ch. The group contains subgroups matching CDS categories: PAPER, CONF, ANA, INT, PUB, TDR and DP. Eventually directories will be automtically created there when LHCb document IDs are requested from the secretariat, but the infrastructure is not there yet.
>
>
Past, present and future LHCb documents with an assigned LHCb ID will be hosted in lhcb-docs. The transition from svn is ongoing and thus the group is not yet in production. Interested users can ask for a project by contacting Patrick.Koppenburg@cernNOSPAMPLEASE.ch. The group contains subgroups matching CDS categories: PAPER, CONF, ANA, INT, PUB, TDR and DP. Eventually directories will be automatically created there when LHCb document IDs are requested from the secretariat, but the infrastructure is not there yet.
  In the meantime you can do the following. Suppose you want to create a new note LHCb-ANA-2018-123, or copy an already existing LHCb-ANA-2018-123 project from svn.
Line: 43 to 43
 
  • Then you can follow the instructions to upload your project from you local copy. But DELETE the .svn directory first or you will import the svn internal stuff into git.
  • What you presently cannot do is become a manager of this project. This requires action from Patrick K or any software librarian. So just let Patrick know when you are ready.
Changed:
<
<
In the above, replace ANA by whatever appropriate for other types of documents. There is no need t copy old documents that are no longer updated. A script will take care of that in early 2019.
>
>
In the above, replace ANA by whatever appropriate for other types of documents. There is no need to copy old documents that are no longer updated. A script will take care of that in early 2019.
 

Gitlab User space

Revision 332019-02-07 - PatrickSKoppenburg

Line: 1 to 1
 

Version-controlled LaTeX documents in LHCb

Changed:
<
<
This is about git-based solutions. svn is being retired. The obsolete documentation for svn can be found here.
>
>
This is about git-based solutions. svn is being retired on 21 February 2019. The obsolete documentation for svn can be found here.
 

Table of Contents

Revision 322019-02-07 - PatrickSKoppenburg

Line: 1 to 1
 

Version-controlled LaTeX documents in LHCb

This is about git-based solutions. svn is being retired. The obsolete documentation for svn can be found here.

Line: 39 to 39
 
  • On lhcb-docs, you can create a new project at https://gitlab.cern.ch/lhcb-docs/ANA
  • It should be called LHCb-ANA-2018-123 (please make sure the capitalisation is correct, in particular in the project "slug" - gitlab will by default uncapitalise it).
Added:
>
>
    • Once you are manager you can fix that under Settings -> Advanced -> Expand -> Rename
 
  • Then you can follow the instructions to upload your project from you local copy. But DELETE the .svn directory first or you will import the svn internal stuff into git.
  • What you presently cannot do is become a manager of this project. This requires action from Patrick K or any software librarian. So just let Patrick know when you are ready.

Revision 312019-02-07 - PatrickSKoppenburg

Line: 1 to 1
 

Version-controlled LaTeX documents in LHCb

This is about git-based solutions. svn is being retired. The obsolete documentation for svn can be found here.

Line: 8 to 8
 

Warning

Changed:
<
<
The transition from svn to git-based repositories is ongoing. This page is likely to be updated frequently. If anything is wrong, please let lhcb-editorial-board-chair@cernNOSPAMPLEASE.ch know.
>
>
The transition from svn to git-based repositories is ongoing. This page is likely to be updated frequently. If anything is wrong, please let lhcb-editorial-board-chair@cernNOSPAMPLEASE.ch know. laso have a look at Patrick's talk at the 15/1 Tuesday meeting.
 

Overview

There are three places where documents can be hosted:

Revision 302019-01-07 - PatrickSKoppenburg

Line: 1 to 1
 

Version-controlled LaTeX documents in LHCb

This is about git-based solutions. svn is being retired. The obsolete documentation for svn can be found here.

Line: 19 to 19
 

Overleaf

Changed:
<
<
Overleaf is a commercial wysiwyg LaTeX interface supported by CERN. It recently bought ShareLaTeX and the merger of the two platforms resulted in overleav v2. You can put any kind of LaTeX document there. The Editorial Board (EB) will request you to put your paper there during the EB process.
  • Get an account at overleaf/cern. PK logs in via ORCID id, which works well.
>
>
Overleaf is a commercial wysiwyg LaTeX interface supported by CERN. It recently bought ShareLaTeX and the merger of the two platforms resulted in overleaf v2. You can put any kind of LaTeX document there. The Editorial Board (EB) will request you to put your paper there during the EB process.
  • Get an account at overleaf/cern. PK logs in via ORCID id, which works well. Your user name is your e-mail address.
 
  • Create a new project
    • You can either share a project with a defined set of users, or with anyone who has the link. While not ideal (overleaf is working on implementing CERN sign-on), we consider this safe enough. I allows all EB members and reviewers to peek at the paper.
Added:
>
>
    • Since beginning of 2019, overleaf v2 projects can be directly git-cloned. You will need your overleaf username and password.
 
    • Do not export a project to dropbox! doing so destroys the history and may overwrite comments from EB members.
  • Overleaf can be used to comment directly on the paper.
    • Comments can be added in the source. They will appear as small windows on the tex file in rich text mode, or commented blocks in source mode.

Revision 292018-12-23 - PatrickSKoppenburg

Line: 1 to 1
 

Version-controlled LaTeX documents in LHCb

This is about git-based solutions. svn is being retired. The obsolete documentation for svn can be found here.

Line: 37 to 37
 In the meantime you can do the following. Suppose you want to create a new note LHCb-ANA-2018-123, or copy an already existing LHCb-ANA-2018-123 project from svn.

Changed:
<
<
  • It should be called LHC-ANA-2018-123 (please make sure the capitalisation is correct, in particular in the project "slug" - gitlab will by default uncapitalise it).
>
>
  • It should be called LHCb-ANA-2018-123 (please make sure the capitalisation is correct, in particular in the project "slug" - gitlab will by default uncapitalise it).
 
  • Then you can follow the instructions to upload your project from you local copy. But DELETE the .svn directory first or you will import the svn internal stuff into git.
  • What you presently cannot do is become a manager of this project. This requires action from Patrick K or any software librarian. So just let Patrick know when you are ready.

Revision 282018-12-21 - PatrickSKoppenburg

Line: 1 to 1
 

Version-controlled LaTeX documents in LHCb

This is about git-based solutions. svn is being retired. The obsolete documentation for svn can be found here.

Line: 32 to 32
 

lhcb-docs group on gitlab

Changed:
<
<
Past, present and future LHCb documents with an assigned LHCb ID will be hosted in lhcb-docs. The transition from svn is ongoing and thus the group is not yet in production. Interested users can ask for a project by contacting Patrick.Koppenburg@cernNOSPAMPLEASE.ch. The group contains subgroups matching CDS categories: PAPER, CONF, ANA, INT, PUB, TDR and DP.
>
>
Past, present and future LHCb documents with an assigned LHCb ID will be hosted in lhcb-docs. The transition from svn is ongoing and thus the group is not yet in production. Interested users can ask for a project by contacting Patrick.Koppenburg@cernNOSPAMPLEASE.ch. The group contains subgroups matching CDS categories: PAPER, CONF, ANA, INT, PUB, TDR and DP. Eventually directories will be automtically created there when LHCb document IDs are requested from the secretariat, but the infrastructure is not there yet.
 
Changed:
<
<
Old documents on svn will be copied there in early 2019.
>
>
In the meantime you can do the following. Suppose you want to create a new note LHCb-ANA-2018-123, or copy an already existing LHCb-ANA-2018-123 project from svn.

  • On lhcb-docs, you can create a new project at https://gitlab.cern.ch/lhcb-docs/ANA
  • It should be called LHC-ANA-2018-123 (please make sure the capitalisation is correct, in particular in the project "slug" - gitlab will by default uncapitalise it).
  • Then you can follow the instructions to upload your project from you local copy. But DELETE the .svn directory first or you will import the svn internal stuff into git.
  • What you presently cannot do is become a manager of this project. This requires action from Patrick K or any software librarian. So just let Patrick know when you are ready.

In the above, replace ANA by whatever appropriate for other types of documents. There is no need t copy old documents that are no longer updated. A script will take care of that in early 2019.

 

Gitlab User space

Revision 272018-12-21 - PatrickSKoppenburg

Line: 1 to 1
 

Version-controlled LaTeX documents in LHCb

Changed:
<
<
SVN is being retired. The obsolete documentation for svn can be found here.
>
>
This is about git-based solutions. svn is being retired. The obsolete documentation for svn can be found here.
 

Table of Contents

Line: 13 to 13
 

Overview

There are three places where documents can be hosted:
Changed:
<
<
overleaf
The commercial wysiwyg LaTeX interface supported by CERN. For any kind of documents. The Editorial Board (EB) will request you to put your paper there during the EB process.
lhcb-docs on CERN gitlab
The (partial) replacement of the svn (LHCbDocs) repository. Only documents with an official LHCb ID can be hosted there.
>
>
overleaf
The commercial wysiwyg LaTeX interface supported by CERN. Any kind of LaTeX document can be put there. The Editorial Board (EB) will actually request you to put your paper on overleaf during the EB process. It's the only solution that does not require any knowledge of git.
lhcb-docs on CERN gitlab
The (partial) replacement of the svn (LHCbDocs) repository. Only documents with an official LHCb ID can be hosted there.
 
User space on CERN gitlab
For any document.

Revision 262018-12-21 - PatrickSKoppenburg

Line: 1 to 1
Changed:
<
<

Version-controlled LateX documents in LHCb

>
>

Version-controlled LaTeX documents in LHCb

  SVN is being retired. The obsolete documentation for svn can be found here.

Revision 252018-12-21 - PatrickSKoppenburg

Line: 1 to 1
Changed:
<
<

This is obsolete

SVN will be retired. A retirement plan is presently being discussed.
>
>

Version-controlled LateX documents in LHCb

 
Changed:
<
<
Please use overleaf starting from a copy of the template at https://www.overleaf.com/read/hdmcxdrpdszd.

LHCbDocs.jpg

Using SVN (Subversion) public LHCb Document repository lhcbdocs

LHCbDocs repository has following goals:

  • To host document development projects, especially collaborative in nature. Private LHCb-related projects are accepted as well.

  • Provide space for sharing of source codes for officially released documents (Notes, Papers) even if developed outside of the repository.

  • Space for template development and sharing.

It supplements, not replaces CDS (CERN Document Server). It is open to all LHCb collaborators.

There is more information to be found in the presentation at Oct.26,2010 Tuesday meeting., which may be especially useful to novice SVN users.

>
>
SVN is being retired. The obsolete documentation for svn can be found here.
 

Table of Contents

Added:
>
>

Warning

The transition from svn to git-based repositories is ongoing. This page is likely to be updated frequently. If anything is wrong, please let lhcb-editorial-board-chair@cernNOSPAMPLEASE.ch know.
 
Added:
>
>

Overview

There are three places where documents can be hosted:
 
Changed:
<
<

Relation to SVN LHCb code repository

SVN is also used to maintain LHCb software code in a separate repository (lhcb).

There is a lot of useful information about use of SVN for code development in LHCb at this page. Much of it is also relevant for use of lhcbdocs.

The main differences is that while we usually check out projects from lhcb code repository via getpack interface, you will be using "svn co" directly in lhcbdocs. A half-way replacement for getpack functionality exits - see getDoc.py and related tagDoc.py.

Access to lhcbdocs repository

Every member of lhcb-general e-group mailing list has read and write access to lhcbdocs repository. You don't need to sign-up to get write access to it (unlike write access to lhcb software repository which requires membership in lhcb-svn-writers e-group which is not automatic). Other users have no access at all. Once you leave the collaboration you will lose access to it (export your docs before you leave).

Occasionally the SVN server is overloaded - just try svn command again if it fails unexpectedly.

If you are a newcomer to svn, or if you are accessing lhcbdocs remotely you may need to set up your user account and connection to the server.

Please consult LHCb instructions

or more general

CERN IT pages for the instructions.

To see if you can access repository from your unix system try to list the main directory structure of the repository via:


svn ls https://svn.cern.ch/reps/lhcbdocs

This will prompt you for the password. If your userid on the local machine is different than at CERN, just enter anything, then the system will ask you for your username (and then password again). You will not have to enter the password again for subsequent svn commands.

A faster access is provided via ssh:

 

svn ls svn+ssh://svn.cern.ch/reps/lhcbdocs

In this method you can avoid entering password altogether if you follow the procedure outlined at CERN svn pages.

Since it is tedious to type the repository address all the time I recommend defining an environmental variable as a shorthand e.g. (csh):


setenv DLHCB svn+ssh://svn.cern.ch/reps/lhcbdocs

or if using https transport


setenv DLHCB https://svn.cern.ch/reps/lhcbdocs

I use this convention below.

Web browser access to lhcbdocs repository

You can access the repository (read only) with a web browser from any location using either svnweb, or if your prefer Trac. You will be prompted to login with your CERN userid.

This site also offers revision log for each file and ability to download files or entire directories (in .tar.gz format).

You can access specific files in the repository (no browsing however) e.g. via https://svnweb.cern.ch/cern/wsvn/lhcbdocs/Publications/PAPER/2011/044/drafts/v5.4/latex/main.pdf.

This is recommended way if you need to set a link e.g. in your analysis TWiki page.

Please be advised that CERN is no longer supporting lhcbdocs access via "Trac".

lhcbdocs policies

Since everybody in LHCb has read/write access to lhcbdocs you must behave responsibly and observe its policies! Violators will be banned by librarian from the repository. Report any abuses to the librarian.

Be careful with commands which operate directly on the repository and not on your local copies (svn ci, direct svn cp, svn mv, svn dele etc.).

Respect editing policies defined in README.txt files which are often present in each project directory. Generally stay away from files you did not create unless you are sure you are authorized to change them.

If repository grows too big it will become inefficient or may be completely unusable.

Try to conserve space in the repository.

It is forbidden to use it for other projects than document development (absolutely no data files and code development projects!).

Remember, every file committed to it stays forever there even if you delete it (this is versioned repository which remembers the past). When making a lot of changes, make them in a local copy. Commit to repository only after you are done for a while.

You are encouraged to request your private SVN repository for projects which don't fit the above policies and/or require read/write access restrictions to smaller groups of people. You will find instructions how to do it at:

CERN IT pages.

How to extract LHCb LaTeX document template?

If you want to use LHCb LaTeX document template as a starting point for your document within the repository, copy it from the /Templates/LHCb-latex-template via:


svn cp $DLHCB/Templates/LHCb-latex-template $DLHCB/some-other-path/MyNote  -m"copied template"

If you want to use this template externally, export the template directory into your local directory:


svn export $DLHCB/Templates/LHCb-latex-template/latest MyNote 

and find template files in MyNote/latex/ subdirectory.

You can also downloaded from a web at https://svnweb.cern.ch/cern/wsvn/lhcbdocs/Templates/LHCb-latex-template/latest. Click on "Download" to get a tarbal (.tar.gz file). You can download files one-by-one from https://svnweb.cern.ch/cern/wsvn/lhcbdocs/Templates/LHCb-latex-template/latest/latex directory - double click on the directory name to expend it. You can then click on individual text files to view them.

Say "make" to produce output file (main.pdf) from within the latex/ subdirectory.

Find more info on this template directory by inspecting its README file e.g.


svn cat $DLHCB/Templates/LHCb-latex-template/README.txt | more  

Area for registered LHCb documents

If you have or want to develop a document which already has official LHCb ID numbers (contact the LHCb secretariat), you can put it in /Notes (or /Publications/CERN-EP-PH for papers) areas. E.g. Note LHCb-ANA-2009-011 should be put in /Notes/ANA/2009/011/ location.

If you developed your note in the /Users/ area, use "svn mv" command to move it to the registered notes area.

Users area in lhcbdocs

You are welcome to use lhcbdocs to develop your own documents. You will first need to create your own area in Users/ subdirectory:


svn mkdir $DLHCB/Users/your_user_id -m" "

The above your_user_id should be your lxplus login userid (if you use svn on lxplus you can use $USER for your_user_id).

You must observe policies spelled in here.

It is recommended that you create subdirectories in your area instead of depositing files in your top area. For example:


svn mkdir $DLHCB/Users/$USER/MyDocument1 -m" "

This way you can check out only part of your user area instead of all of it to get to any files (you can check out only directories!) e.g.

svn co $DLHCB/Users/$USER/MyDocument1 

If you are starting new ANA note from scratch in your area which does not have ANA note number assigned (otherwise you should be working under $DLHCB/Notes/ANA/ area), create subdirectory by copying the template

svn cp  $DLHCB/Templates/LHCb-latex-template $DLHCB/Users/$USER/MyANANoteDraft -m" "

which you can later move to the Notes area once you get the note number (e.g. for LHCb-ANA-2009-045):

svn mv $DLHCB/Users/$USER/MyANANoteDraft $DLHCB/Notes/ANA/2009/045   -m" "

Version tagging

Every time you change something in repository global revision number is incremented. In principle, you can use this revision number to identify a version of the document. This number is not human friendly (e.g. 87651). It is a common practice to "tag" versions of the project with human friendly names for future reference.

SVN does not have tag command. Instead, use "svn cp" command to take a snapshot of your development directory to tag directory (this does not create real copies, just references to file revisions, thus it is storage efficient). In svn jargon they are often called "trunk" and "tag" directories respectively. The LHCb templates use "latest" and "drafts" directories for this purpose - we recommend that you stick to this convention. Pre-commit hooks of lhcbdocs prevent modifications to anything put under "drafts" or "tags" directories.

See also tagDoc.py.

Python scripts to help with checking out and tagging of document projects

At present you can get local copies of these scripts via:


svn export $DLHCB/Templates/Scripts/tags/2010-10-24/python . --force

Say "python getDoc.py -help" and "python tagDoc.py -help" to see the usage.

What do I do if I made a mistake and don't know what to do?

The past versions can be restored with "svn cp -revision <#>" command.

If you make a mistake using repository and you don't know how to recover, consult the librarian.

Librarian e-group

To reach lhcbdocs librarian send E-mail to VC-librarians-lhcbdocs at cern (you need to be a member of lhcb-general mailing list to be able to do it).

>
>
overleaf
The commercial wysiwyg LaTeX interface supported by CERN. For any kind of documents. The Editorial Board (EB) will request you to put your paper there during the EB process.
lhcb-docs on CERN gitlab
The (partial) replacement of the svn (LHCbDocs) repository. Only documents with an official LHCb ID can be hosted there.
User space on CERN gitlab
For any document.

Overleaf

Overleaf is a commercial wysiwyg LaTeX interface supported by CERN. It recently bought ShareLaTeX and the merger of the two platforms resulted in overleav v2. You can put any kind of LaTeX document there. The Editorial Board (EB) will request you to put your paper there during the EB process.
  • Get an account at overleaf/cern. PK logs in via ORCID id, which works well.
  • Create a new project * You can either share a project with a defined set of users, or with anyone who has the link. While not ideal (overleaf is working on implementing CERN sign-on), we consider this safe enough. I allows all EB members and reviewers to peek at the paper.
    • Do not export a project to dropbox! doing so destroys the history and may overwrite comments from EB members.
  • Overleaf can be used to comment directly on the paper.
    • Comments can be added in the source. They will appear as small windows on the tex file in rich text mode, or commented blocks in source mode.
    • Comments can also be made on pdf with the packages described here. See an example. However the two kinds of comments are not the same, unfortunately.
  • EB members and reviewers may also fix obvious mistakes directly.
    • Tagged versions can be compared in History & Revisions mode and undone. It is therefore recommended proponents and EB members tag versions frequently.

lhcb-docs group on gitlab

Past, present and future LHCb documents with an assigned LHCb ID will be hosted in lhcb-docs. The transition from svn is ongoing and thus the group is not yet in production. Interested users can ask for a project by contacting Patrick.Koppenburg@cernNOSPAMPLEASE.ch. The group contains subgroups matching CDS categories: PAPER, CONF, ANA, INT, PUB, TDR and DP.

Old documents on svn will be copied there in early 2019.

Gitlab User space

All LHCb members have a user space at https://gitlab.cern.ch/. Personal documents and drafts of LHCb documents can be hosted there. This replaces the svn LHCbDocs user space.

How do I access old documents on svn?

All svn directories have been zipped and made available online at https://lhcb-notes.web.cern.ch/lhcb-notes/svn-archive/. You may browse files and download zips.

LHCb Template

Presently the template lives on gitlab at this url. It will eventually be mapped on overleaf once it supports gitlab.
 
Changed:
<
<
-- TomaszSkwarnicki - 25-Oct-2010
>
>
-- PatrickSKoppenburg - 2018-12-21
 
META FILEATTACHMENT attachment="LHCbDocs.jpg" attr="" comment="" date="1287573919" name="LHCbDocs.jpg" path="LHCbDocs.jpg" size="81352" stream="LHCbDocs.jpg" tmpFilename="/usr/tmp/CGItemp10321" user="tskwarni" version="1"

Revision 242018-07-24 - PatrickSKoppenburg

Line: 1 to 1
Changed:
<
<
LHCbDocs.jpg
>
>

This is obsolete

SVN will be retired. A retirement plan is presently being discussed.

Please use overleaf starting from a copy of the template at https://www.overleaf.com/read/hdmcxdrpdszd.

 
Added:
>
>
LHCbDocs.jpg
 

Using SVN (Subversion) public LHCb Document repository lhcbdocs

Revision 232014-03-25 - AntonPoluektov

Line: 1 to 1
 
LHCbDocs.jpg
Line: 18 to 18
 It is open to all LHCb collaborators.

There is more information to be found

Changed:
<
<
in the presentation at Oct.26,2010 Tuesday meeting.,
>
>
in the presentation at Oct.26,2010 Tuesday meeting.,
 which may be especially useful to novice SVN users.

Table of Contents

Revision 222013-09-24 - ChristopherRJones

Line: 1 to 1
 
LHCbDocs.jpg
Line: 110 to 110
 

Web browser access to lhcbdocs repository

Changed:
<
<
You can access the repository (read only) with a web browser from any location at

https://svnweb.cern.ch/cern/wsvn/lhcbdocs. You will be prompted to login with your CERN userid.

>
>
You can access the repository (read only) with a web browser from any location using either svnweb, or if your prefer Trac. You will be prompted to login with your CERN userid.
  This site also offers revision log for each file and ability to download files or entire directories (in .tar.gz format).

Revision 212012-12-18 - RudolfOldeman

Line: 1 to 1
 
LHCbDocs.jpg
Line: 118 to 118
 

You can access specific files in the repository (no browsing however) e.g. via

Changed:
<
<
https://svn.cern.ch/reps/lhcbdocs/Publications/PAPER/2011/044/drafts/v5.4/latex/main.pdf.
>
>
https://svnweb.cern.ch/cern/wsvn/lhcbdocs/Publications/PAPER/2011/044/drafts/v5.4/latex/main.pdf.
 This is recommended way if you need to set a link e.g. in your analysis TWiki page.

Please be advised that CERN is no longer supporting lhcbdocs access via "Trac".

Revision 202012-11-29 - TomaszSkwarnicki

Line: 1 to 1
 
LHCbDocs.jpg
Line: 199 to 199
 
Added:
>
>
 
Added:
>
>

Area for registered LHCb documents

 
Deleted:
<
<
 
Changed:
<
<

Users area in lhcbdocs

>
>
If you have or want to develop a document which already has official LHCb ID numbers (contact the LHCb secretariat), you can put it in /Notes (or /Publications/CERN-EP-PH for papers) areas. E.g. Note LHCb-ANA-2009-011 should be put in /Notes/ANA/2009/011/ location.
 
Added:
>
>
If you developed your note in the /Users/ area, use "svn mv" command to move it to the registered notes area.
 
Changed:
<
<
You are welcome to use lhcbdocs to develop your own documents. You will first need to create your own area in Users/ subdirectory.
>
>
 
Changed:
<
<
Please follow instructions which you can obtain via:
>
>

Users area in lhcbdocs

 
Added:
>
>
You are welcome to use lhcbdocs to develop your own documents. You will first need to create your own area in Users/ subdirectory:
 
Changed:
<
<
svn cat $DLHCB/Templates/UsersDirectoryTemplate/README.txt
>
>
svn mkdir $DLHCB/Users/your_user_id -m" "
 
Changed:
<
<
Create subdirectories in your area as suggested.
>
>
The above your_user_id should be your lxplus login userid (if you use svn on lxplus you can use $USER for your_user_id).
  You must observe policies spelled in here.
Added:
>
>
It is recommended that you create subdirectories in your area instead of depositing files in your top area. For example:
 
Added:
>
>
svn mkdir $DLHCB/Users/$USER/MyDocument1 -m" "
 
Changed:
<
<

Area for registered LHCb documents

>
>
This way you can check out only part of your user area instead of all of it to get to any files (you can check out only directories!) e.g.
 
Changed:
<
<
If you have or want to develop a document which already has official LHCb ID numbers (contact the LHCb secretariat), you can put it in /Notes (or /Publications/CERN-EP-PH for papers) areas. E.g. Note LHCb-ANA-2009-011 should be put in /Notes/ANA/2009/011/ location.
>
>
svn co $DLHCB/Users/$USER/MyDocument1
 
Added:
>
>
If you are starting new ANA note from scratch in your area which does not have ANA note number assigned (otherwise you should be working under $DLHCB/Notes/ANA/ area), create subdirectory by copying the template
 
Added:
>
>
svn cp $DLHCB/Templates/LHCb-latex-template $DLHCB/Users/$USER/MyANANoteDraft -m" "
 
Changed:
<
<
If you developed you note in the /Users/ area, use "svn mv" command to move it to the registered notes area.
>
>
which you can later move to the Notes area once you get the note number (e.g. for LHCb-ANA-2009-045):
 
Added:
>
>
svn mv $DLHCB/Users/$USER/MyANANoteDraft $DLHCB/Notes/ANA/2009/045 -m" "
 
Added:
>
>
 
Deleted:
<
<
To start developing a conference note based on your analysis note, use the "svn cp" command from your analysis area to the userarea. Then when you are assigned a CONF number, use "svn mv" to move the note to /Notes/ANA/20XX/YYY/.
 

Revision 192012-06-25 - TomaszSkwarnicki

Line: 1 to 1
 
LHCbDocs.jpg
Line: 117 to 117
 This site also offers revision log for each file and ability to download files or entire directories (in .tar.gz format).
Added:
>
>
You can access specific files in the repository (no browsing however) e.g. via https://svn.cern.ch/reps/lhcbdocs/Publications/PAPER/2011/044/drafts/v5.4/latex/main.pdf. This is recommended way if you need to set a link e.g. in your analysis TWiki page.
 
Changed:
<
<
Plain web browsing is also available via: https://svn.cern.ch/reps/lhcbdocs/.

Also https://svnweb.cern.ch/trac/lhcbdocs/browser can be used (you must login to access the repository content).

>
>
Please be advised that CERN is no longer supporting lhcbdocs access via "Trac".
 

Revision 182011-12-15 - TomaszSkwarnicki

Line: 1 to 1
 
LHCbDocs.jpg
Line: 184 to 184
 
Changed:
<
<
You can also downloaded from a web at https://svnweb.cern.ch/cern/wsvn/lhcbdocs/Templates/LHCb-latex-template/latest. Click on "Tarball".
>
>
You can also downloaded from a web at https://svnweb.cern.ch/cern/wsvn/lhcbdocs/Templates/LHCb-latex-template/latest. Click on "Download" to get a tarbal (.tar.gz file). You can download files one-by-one from https://svnweb.cern.ch/cern/wsvn/lhcbdocs/Templates/LHCb-latex-template/latest/latex directory - double click on the directory name to expend it. You can then click on individual text files to view them.
  Say "make" to produce output file (main.pdf) from within the latex/ subdirectory.

Revision 172011-04-02 - UlrikEgede

Line: 1 to 1
 
LHCbDocs.jpg
Line: 240 to 240
 
Changed:
<
<
To start developing e.g. LHCb-CONF note, from your LHCb-ANA note use "svn cp" command.
>
>
To start developing a conference note based on your analysis note, use the "svn cp" command from your analysis area to the userarea. Then when you are assigned a CONF number, use "svn mv" to move the note to /Notes/ANA/20XX/YYY/.
 

Revision 162011-02-21 - PatrickSKoppenburg

Line: 1 to 1
 
LHCbDocs.jpg
Line: 236 to 236
 
Changed:
<
<
If you developed you note in the [[#UserArea][/Users/] area, use "svn mv" command to move it to the registered notes area.
>
>
If you developed you note in the /Users/ area, use "svn mv" command to move it to the registered notes area.
 

Revision 152011-02-11 - PSpradlin1

Line: 1 to 1
 
LHCbDocs.jpg
Line: 162 to 162
 

How to extract LHCb LaTeX document template?

Changed:
<
<
If you want to use LHCb LaTeX document template as a starting point for your document within the repository, copy it from the /Template/LHCb-latex-template via:
>
>
If you want to use LHCb LaTeX document template as a starting point for your document within the repository, copy it from the /Templates/LHCb-latex-template via:
 
Changed:
<
<
svn cp $DLHCB/Template/LHCb-latex-template $DLHCB/some-other-path/MyNote -m"copied template"
>
>
svn cp $DLHCB/Templates/LHCb-latex-template $DLHCB/some-other-path/MyNote -m"copied template"
 

Revision 142010-11-19 - ChristopherRJones

Line: 1 to 1
 
LHCbDocs.jpg

Using SVN (Subversion) public LHCb Document repository lhcbdocs

Changed:
<
<
LHCbDocs repository has following goals:
>
>
LHCbDocs repository has following goals:
 
  • To host document development projects, especially collaborative in nature. Private LHCb-related projects are accepted as well.

Revision 132010-11-17 - ChristopherRJones

Line: 1 to 1
 
LHCbDocs.jpg

Revision 122010-10-26 - TomaszSkwarnicki

Line: 1 to 1
 
LHCbDocs.jpg
Added:
>
>
 

Using SVN (Subversion) public LHCb Document repository lhcbdocs

Added:
>
>
LHCbDocs repository has following goals:

  • To host document development projects, especially collaborative in nature. Private LHCb-related projects are accepted as well.

  • Provide space for sharing of source codes for officially released documents (Notes, Papers) even if developed outside of the repository.

  • Space for template development and sharing.

It supplements, not replaces CDS (CERN Document Server). It is open to all LHCb collaborators.

There is more information to be found in the presentation at Oct.26,2010 Tuesday meeting., which may be especially useful to novice SVN users.

 

Table of Contents

Added:
>
>
 
Added:
>
>
 
Added:
>
>
 

Relation to SVN LHCb code repository

Added:
>
>
 SVN is also used to maintain LHCb software code in a separate repository (lhcb).
Added:
>
>
 There is a lot of useful information about use of SVN for code development in LHCb at
Added:
>
>
 this page. Much of it is also relevant for use of lhcbdocs.
Changed:
<
<
The main differences is that while we usually check out projects from lhcb code repository via getpack interface, you will be using “svn co” directly in lhcbdocs. A half-way replacement for getpack functionality exits - see getDoc.py and related tagDoc.py.
>
>
The main differences is that while we usually check out projects from lhcb code repository via getpack interface, you will be using "svn co" directly in lhcbdocs. A half-way replacement for getpack functionality exits - see getDoc.py and related tagDoc.py.
 
Added:
>
>
 

Access to lhcbdocs repository

Deleted:
<
<
Every member of lhcb-general e-group mailing list has read and write access to lhcbdocs repository. You don’t need to sign-up to get write access to it (unlike write access to lhcb software repository which requires membership in lhcb-svn-writers e-group which is not automatic). Other users have no access at all. Once you leave the collaboration you will lose access to it (export your docs before you leave).
 
Changed:
<
<
Occasionally the SVN server is overloaded – just try svn command again if it fails unexpectedly.
>
>
Every member of lhcb-general e-group mailing list has read and write access to lhcbdocs repository. You don't need to sign-up to get write access to it (unlike write access to lhcb software repository which requires membership in lhcb-svn-writers e-group which is not automatic). Other users have no access at all. Once you leave the collaboration you will lose access to it (export your docs before you leave).

Occasionally the SVN server is overloaded - just try svn command again if it fails unexpectedly.

  If you are a newcomer to svn, or if you are accessing lhcbdocs remotely you may need to set up your user account and connection to the server.
Added:
>
>
 Please consult LHCb instructions
Added:
>
>
 or more general
Added:
>
>
 CERN IT pages for the instructions.
Added:
>
>
 To see if you can access repository from your unix system try to list the main directory structure of the repository via:
Added:
>
>
 
Added:
>
>
 svn ls https://svn.cern.ch/reps/lhcbdocs
Added:
>
>
 
Added:
>
>
 This will prompt you for the password. If your userid on the local machine is different than at CERN, just enter anything, then the system will ask you for your username (and then password again). You will not have to enter the password again for subsequent svn commands.
Added:
>
>
 A faster access is provided via ssh:
Changed:
<
<
>
>
 
 svn ls svn+ssh://svn.cern.ch/reps/lhcbdocs
Added:
>
>
 
Added:
>
>
 In this method you can avoid entering password altogether if you follow the procedure outlined at CERN svn pages.

Added:
>
>
 Since it is tedious to type the repository address all the time I recommend defining an environmental variable as a shorthand e.g. (csh):
Added:
>
>
 
Added:
>
>
 setenv DLHCB svn+ssh://svn.cern.ch/reps/lhcbdocs
Added:
>
>
 
Added:
>
>
 or if using https transport
Added:
>
>
 
Added:
>
>
 setenv DLHCB https://svn.cern.ch/reps/lhcbdocs
Added:
>
>
 
Added:
>
>
 I use this convention below.
Added:
>
>
 
Added:
>
>
 

Web browser access to lhcbdocs repository

Added:
>
>
 You can access the repository (read only) with a web browser from any location at
Added:
>
>
 https://svnweb.cern.ch/cern/wsvn/lhcbdocs. You will be prompted to login with your CERN userid.
Added:
>
>
 This site also offers revision log for each file and ability to download files or entire directories (in .tar.gz format).
Added:
>
>
 Plain web browsing is also available via: https://svn.cern.ch/reps/lhcbdocs/.
Added:
>
>
 Also https://svnweb.cern.ch/trac/lhcbdocs/browser can be used (you must login to access the repository content).
Added:
>
>
 
Added:
>
>
 

lhcbdocs policies

Added:
>
>
 Since everybody in LHCb has read/write access to lhcbdocs you must behave responsibly and observe its policies! Violators will be banned by librarian from the repository. Report any abuses to the librarian.
Added:
>
>
 Be careful with commands which operate directly on the repository and not on your local copies (svn ci, direct svn cp, svn mv, svn dele etc.).
Added:
>
>
 Respect editing policies defined in README.txt files which are often present in each project directory. Generally stay away from files you did not create unless you are sure you are authorized to change them.
Added:
>
>
 If repository grows too big it will become inefficient or may be completely unusable.
Added:
>
>
 Try to conserve space in the repository.
Added:
>
>
 It is forbidden to use it for other projects than document development (absolutely no data files and code development projects!).
Added:
>
>
 Remember, every file committed to it stays forever there even if you delete it (this is versioned repository which remembers the past). When making a lot of changes, make them in a local copy. Commit to repository only after you are done for a while.
Changed:
<
<
You are encouraged to request your private SVN repository for projects which don’t fit the above policies and/or require read/write access restrictions to smaller groups of people. You will find instructions how to do it at:
>
>

You are encouraged to request your private SVN repository for projects which don't fit the above policies and/or require read/write access restrictions to smaller groups of people. You will find instructions how to do it at:

 CERN IT pages.
Added:
>
>
 
Added:
>
>
 

How to extract LHCb LaTeX document template?

Added:
>
>
 If you want to use LHCb LaTeX document template as a starting point for your document within the repository, copy it from the /Template/LHCb-latex-template via:
Added:
>
>
 
Changed:
<
<
svn cp $DLHCB/Template/LHCb-latex-template $DLHCB/some-other-path/MyNote -m“copied template”
>
>
svn cp $DLHCB/Template/LHCb-latex-template $DLHCB/some-other-path/MyNote -m"copied template"
 
Added:
>
>
 If you want to use this template externally, export the template directory into your local directory:
Added:
>
>
 
Added:
>
>
 svn export $DLHCB/Templates/LHCb-latex-template/latest MyNote
Added:
>
>
 
Added:
>
>
 and find template files in MyNote/latex/ subdirectory.
Added:
>
>
 You can also downloaded from a web at https://svnweb.cern.ch/cern/wsvn/lhcbdocs/Templates/LHCb-latex-template/latest. Click on "Tarball".
Changed:
<
<
Say “make” to produce output file (main.pdf) from within the latex/ subdirectory.
>
>

Say "make" to produce output file (main.pdf) from within the latex/ subdirectory.

  Find more info on this template directory by inspecting its README file e.g.
Added:
>
>
 
Added:
>
>
 svn cat $DLHCB/Templates/LHCb-latex-template/README.txt | more
Added:
>
>
 
Added:
>
>
 
Added:
>
>
 

Users area in lhcbdocs

Added:
>
>
 You are welcome to use lhcbdocs to develop your own documents. You will first need to create your own area in Users/ subdirectory.
Added:
>
>
 Please follow instructions which you can obtain via:
Added:
>
>
 
Added:
>
>
 svn cat $DLHCB/Templates/UsersDirectoryTemplate/README.txt
Added:
>
>
 
Added:
>
>
 Create subdirectories in your area as suggested.
Added:
>
>
 You must observe policies spelled in here.
Added:
>
>
 
Added:
>
>
 

Area for registered LHCb documents

Added:
>
>
 If you have or want to develop a document which already has official LHCb ID numbers (contact the LHCb secretariat), you can put it in /Notes (or /Publications/CERN-EP-PH for papers) areas. E.g. Note LHCb-ANA-2009-011 should be put in /Notes/ANA/2009/011/ location.
Deleted:
<
<
If you developed you note in the [[#UserArea][/Users/] area, use “svn mv” command to move it to the registered notes area.
 
Changed:
<
<
To start developing e.g. LHCb-CONF note, from your LHCb-ANA note use “svn cp” command.
>
>
If you developed you note in the [[#UserArea][/Users/] area, use "svn mv" command to move it to the registered notes area.

To start developing e.g. LHCb-CONF note, from your LHCb-ANA note use "svn cp" command.

 
Added:
>
>
 

Version tagging

Deleted:
<
<
Every time you change something in repository global revision number is incremented. In principle, you can use this revision number to identify a version of the document. This number is not human friendly (e.g. 87651). It is a common practice to “tag” versions of the project with human friendly names for future reference.
 
Changed:
<
<
SVN does not have tag command. Instead, use “svn cp” command to take a snapshot of your development directory to tag directory (this does not create real copies, just references to file revisions, thus it is storage efficient). In svn jargon they are often called “trunk” and “tag” directories respectively. The LHCb templates use “latest” and “drafts” directories for this purpose – we recommend that you stick to this convention. Pre-commit hooks of lhcbdocs prevent modifications to anything put under “drafts” or “tags” directories.
>
>
Every time you change something in repository global revision number is incremented. In principle, you can use this revision number to identify a version of the document. This number is not human friendly (e.g. 87651). It is a common practice to "tag" versions of the project with human friendly names for future reference.

SVN does not have tag command. Instead, use "svn cp" command to take a snapshot of your development directory to tag directory (this does not create real copies, just references to file revisions, thus it is storage efficient). In svn jargon they are often called "trunk" and "tag" directories respectively. The LHCb templates use "latest" and "drafts" directories for this purpose - we recommend that you stick to this convention. Pre-commit hooks of lhcbdocs prevent modifications to anything put under "drafts" or "tags" directories.

  See also tagDoc.py.
Line: 125 to 262
 See also tagDoc.py.
Added:
>
>
 
Added:
>
>
 

Python scripts to help with checking out and tagging of document projects

Added:
>
>
 At present you can get local copies of these scripts via:
Added:
>
>
 
Added:
>
>
 svn export $DLHCB/Templates/Scripts/tags/2010-10-24/python . --force
Added:
>
>
 
Changed:
<
<
Say “python getDoc.py –help” and “python tagDoc.py –help” to see the usage.
>
>
Say "python getDoc.py -help" and "python tagDoc.py -help" to see the usage.
 
Deleted:
<
<

What do I do if I made a mistake and don’t know what to do?

 
Changed:
<
<
The past versions can be restored with “svn cp –revision <#>” command. If you make a mistake using repository and you don’t know how to recover, consult the librarian.
>
>

What do I do if I made a mistake and don't know what to do?

The past versions can be restored with "svn cp -revision <#>" command.

If you make a mistake using repository and you don't know how to recover, consult the librarian.

 
Added:
>
>
 

Librarian e-group

Added:
>
>
 To reach lhcbdocs librarian send E-mail to VC-librarians-lhcbdocs at cern (you need to be a member of lhcb-general mailing list to be able to do it).
Added:
>
>
 -- TomaszSkwarnicki - 25-Oct-2010

META FILEATTACHMENT attachment="LHCbDocs.jpg" attr="" comment="" date="1287573919" name="LHCbDocs.jpg" path="LHCbDocs.jpg" size="81352" stream="LHCbDocs.jpg" tmpFilename="/usr/tmp/CGItemp10321" user="tskwarni" version="1"

Revision 112010-10-25 - TomaszSkwarnicki

Line: 1 to 1
 
LHCbDocs.jpg
Changed:
<
<

Using Subversion (svn) public LHCb Document repository lhcbdocs

This SVN repository and this page are presently under construction.

Draft of the initial outline for this repository can be found at this location, where basic ideas and plan are spelled out. Please be aware that the actual implementation deviates from this proposal. Our intention is to include all important information here, however, this will take time to accomplish. If you are using repository already and have suggestions how to improve documentation please send E-mail to Tomasz Skwarnicki who is serving as initial developer and librarian.

Mailing e-group list will be created for the support, but it does not exist yet.

>
>

Using SVN (Subversion) public LHCb Document repository lhcbdocs

 

Table of Contents

Relation to SVN LHCb code repository

Changed:
<
<
SVN is also used to maintain LHCb code in a separate repository (lhcb).
>
>
SVN is also used to maintain LHCb software code in a separate repository (lhcb).
 There is a lot of useful information about use of SVN for code development in LHCb at this page. Much of it is also relevant for use of lhcbdocs.
Changed:
<
<
The main differences is that while we usually check out projects from lhcb code repository via getpack interface, you will be using “svn co” directly in lhcbdocs.
>
>
The main differences is that while we usually check out projects from lhcb code repository via getpack interface, you will be using “svn co” directly in lhcbdocs. A half-way replacement for getpack functionality exits - see getDoc.py and related tagDoc.py.
 

Access to lhcbdocs repository

Changed:
<
<
Every member of lhcb-general e-group mailing list has read and write access to lhcbdocs repository. Other users have no access at all.
>
>
Every member of lhcb-general e-group mailing list has read and write access to lhcbdocs repository. You don’t need to sign-up to get write access to it (unlike write access to lhcb software repository which requires membership in lhcb-svn-writers e-group which is not automatic). Other users have no access at all. Once you leave the collaboration you will lose access to it (export your docs before you leave).

Occasionally the SVN server is overloaded – just try svn command again if it fails unexpectedly.

  If you are a newcomer to svn, or if you are accessing lhcbdocs remotely you may need to set up your user account and connection to the server. Please consult LHCb instructions
Line: 36 to 28
 
svn ls https://svn.cern.ch/reps/lhcbdocs
Changed:
<
<
This will prompt you for the password. If your userid on the local machine is different than at CERN, just enter anything, then the system will ask you for your username (and then password again). You will not have to enter the password again for subsequent svn commands in the same session.
>
>
This will prompt you for the password. If your userid on the local machine is different than at CERN, just enter anything, then the system will ask you for your username (and then password again). You will not have to enter the password again for subsequent svn commands.
  A faster access is provided via ssh:
Line: 56 to 48
 

Web browser access to lhcbdocs repository

Changed:
<
<
You can access the repository (read only) with a web browser from any location at https://svn.cern.ch/reps/lhcbdocs/. You will be prompted to login with your CERN userid.
>
>
You can access the repository (read only) with a web browser from any location at https://svnweb.cern.ch/cern/wsvn/lhcbdocs. You will be prompted to login with your CERN userid. This site also offers revision log for each file and ability to download files or entire directories (in .tar.gz format).

Plain web browsing is also available via: https://svn.cern.ch/reps/lhcbdocs/. Also https://svnweb.cern.ch/trac/lhcbdocs/browser can be used (you must login to access the repository content).

 
Changed:
<
<

What do I do if I get error message about outdated svn client?

>
>

lhcbdocs policies

 
Changed:
<
<
If you get error messages that your SVN client is outdated (it may happen on lxplus!) login to lxsvn.cern.ch instead which has the up to date SVN software.
>
>
Since everybody in LHCb has read/write access to lhcbdocs you must behave responsibly and observe its policies! Violators will be banned by librarian from the repository. Report any abuses to the librarian. Be careful with commands which operate directly on the repository and not on your local copies (svn ci, direct svn cp, svn mv, svn dele etc.).
 
Changed:
<
<
I noticed that sometimes the repository is momentarily not accessible which can results in odd messages when referring to it (e.g. during svn ci command). If something unexpected like this happens. Simply try again.
>
>
Respect editing policies defined in README.txt files which are often present in each project directory. Generally stay away from files you did not create unless you are sure you are authorized to change them.

If repository grows too big it will become inefficient or may be completely unusable. Try to conserve space in the repository. It is forbidden to use it for other projects than document development (absolutely no data files and code development projects!).

Remember, every file committed to it stays forever there even if you delete it (this is versioned repository which remembers the past). When making a lot of changes, make them in a local copy. Commit to repository only after you are done for a while.

You are encouraged to request your private SVN repository for projects which don’t fit the above policies and/or require read/write access restrictions to smaller groups of people. You will find instructions how to do it at: CERN IT pages.

 

How to extract LHCb LaTeX document template?

Added:
>
>
If you want to use LHCb LaTeX document template as a starting point for your document within the repository, copy it from the /Template/LHCb-latex-template via:
svn cp $DLHCB/Template/LHCb-latex-template $DLHCB/some-other-path/MyNote  -m“copied template”
 
Changed:
<
<
If all you want is an LHCb document latex template, export the template directory into your local directory. E.g. let us call it MyNote
>
>
If you want to use this template externally, export the template directory into your local directory:
 
svn export $DLHCB/Templates/LHCb-latex-template/latest MyNote 
and find template files in MyNote/latex/ subdirectory.
Added:
>
>
You can also downloaded from a web at https://svnweb.cern.ch/cern/wsvn/lhcbdocs/Templates/LHCb-latex-template/latest. Click on "Tarball".
 Say “make” to produce output file (main.pdf) from within the latex/ subdirectory.

Find more info on this template directory by inspecting its README file e.g.

Line: 89 to 102
 
svn cat $DLHCB/Templates/UsersDirectoryTemplate/README.txt
Changed:
<
<
Create subdirectories in your area as suggested. Equip each with README.txt. See examples at:
svn cat $DLHCB/Users/tskwarni/README.txt
svn cat $DLHCB/Users/tskwarni/TestArea/README.txt
>
>
Create subdirectories in your area as suggested.
 
Changed:
<
<
You must observe policies spelled out in the next section.
>
>
You must observe policies spelled in here.
 
Changed:
<
<

lhcbdocs policies

>
>

Area for registered LHCb documents

 
Changed:
<
<
Since everybody in LHCb has read/write access to lhcbdocs you must behave responsibly and observe its policies! Violators will be banned by librarian from the repository. Report any abuses to the librarian. Be careful with commands which operate directly on the repository and not on your local copies (svn ci, direct svn cp, svn mv, svn dele etc.).
>
>
If you have or want to develop a document which already has official LHCb ID numbers (contact the LHCb secretariat), you can put it in /Notes (or /Publications/CERN-EP-PH for papers) areas. E.g. Note LHCb-ANA-2009-011 should be put in /Notes/ANA/2009/011/ location.
 
Changed:
<
<
Respect editing policies defined in README.txt file which should be present in each project directory. Generally stay away from files you did not create unless you are sure you are authorized to change them.
>
>
If you developed you note in the [[#UserArea][/Users/] area, use “svn mv” command to move it to the registered notes area.
 
Changed:
<
<
If repository grows too big it will become inefficient or may be completely unusable. Try to conserve space in the repository. It is forbidden to use it for other projects than document development (absolutely no data files and code development projects!). It is mostly intended for collaborative projects, but small private projects are OK too.
>
>
To start developing e.g. LHCb-CONF note, from your LHCb-ANA note use “svn cp” command.
 
Changed:
<
<
Remember, every file committed to it stays forever there even if you delete it (this is versioned repository which remembers the past). When making a lot of changes, make them in a local copy. Commit to repository only after you are done for a while.
>
>

Version tagging

 
Changed:
<
<
You are encouraged to request your private SVN repository for projects which don’t fit the above policies and/or require read/write access restrictions to smaller groups of people. You will find instructions how to do it at: CERN IT pages.
>
>
Every time you change something in repository global revision number is incremented. In principle, you can use this revision number to identify a version of the document. This number is not human friendly (e.g. 87651). It is a common practice to “tag” versions of the project with human friendly names for future reference.

SVN does not have tag command. Instead, use “svn cp” command to take a snapshot of your development directory to tag directory (this does not create real copies, just references to file revisions, thus it is storage efficient). In svn jargon they are often called “trunk” and “tag” directories respectively. The LHCb templates use “latest” and “drafts” directories for this purpose – we recommend that you stick to this convention. Pre-commit hooks of lhcbdocs prevent modifications to anything put under “drafts” or “tags” directories.

See also tagDoc.py.

Python scripts to help with checking out and tagging of document projects

At present you can get local copies of these scripts via:
svn export $DLHCB/Templates/Scripts/tags/2010-10-24/python . --force
Say “python getDoc.py –help” and “python tagDoc.py –help” to see the usage.
 

What do I do if I made a mistake and don’t know what to do?

Added:
>
>
The past versions can be restored with “svn cp –revision <#>” command.
 If you make a mistake using repository and you don’t know how to recover, consult the librarian.

Librarian e-group

To reach lhcbdocs librarian send E-mail to VC-librarians-lhcbdocs at cern (you need to be a member of lhcb-general mailing list to be able to do it).
Changed:
<
<
-- TomaszSkwarnicki - 25-Sep-2010
>
>
-- TomaszSkwarnicki - 25-Oct-2010
 
META FILEATTACHMENT attachment="LHCbDocs.jpg" attr="" comment="" date="1287573919" name="LHCbDocs.jpg" path="LHCbDocs.jpg" size="81352" stream="LHCbDocs.jpg" tmpFilename="/usr/tmp/CGItemp10321" user="tskwarni" version="1"

Revision 102010-10-25 - TomaszSkwarnicki

Line: 1 to 1
 
LHCbDocs.jpg

Using Subversion (svn) public LHCb Document repository lhcbdocs

Line: 24 to 24
 

Access to lhcbdocs repository

Changed:
<
<
Every member of lhcb-svn-writers e-group mailing list has read and write access to lhcbdocs repository.
>
>
Every member of lhcb-general e-group mailing list has read and write access to lhcbdocs repository.
 Other users have no access at all.
Deleted:
<
<
Please see this location to see how to sign up for the access.
  If you are a newcomer to svn, or if you are accessing lhcbdocs remotely you may need to set up your user account and connection to the server. Please consult LHCb instructions

Revision 92010-10-22 - TomaszSkwarnicki

Line: 1 to 1
 
LHCbDocs.jpg

Using Subversion (svn) public LHCb Document repository lhcbdocs

Deleted:
<
<
WARNING ! I am testing access control today on Fri Oct 22. If you can't access the repository and you need immediate access send me an e-mail to tomasz at phy.syr.edu.
 This SVN repository and this page are presently under construction.

Draft of the initial outline for this repository can be found at

Line: 26 to 24
 

Access to lhcbdocs repository

Changed:
<
<
Every member of lhcb-general e-group mailing list who has account at CERN has read and write access to lhcbdocs repository.
>
>
Every member of lhcb-svn-writers e-group mailing list has read and write access to lhcbdocs repository.
 Other users have no access at all.
Added:
>
>
Please see this location to see how to sign up for the access.
  If you are a newcomer to svn, or if you are accessing lhcbdocs remotely you may need to set up your user account and connection to the server. Please consult LHCb instructions

Revision 82010-10-22 - TomaszSkwarnicki

Line: 1 to 1
 
LHCbDocs.jpg

Using Subversion (svn) public LHCb Document repository lhcbdocs

Added:
>
>
WARNING ! I am testing access control today on Fri Oct 22. If you can't access the repository and you need immediate access send me an e-mail to tomasz at phy.syr.edu.
 This SVN repository and this page are presently under construction.

Draft of the initial outline for this repository can be found at

Revision 72010-10-22 - TomaszSkwarnicki

Line: 1 to 1
 
LHCbDocs.jpg

Using Subversion (svn) public LHCb Document repository lhcbdocs

Line: 71 to 71
  If all you want is an LHCb document latex template, export the template directory into your local directory. E.g. let us call it MyNote
Changed:
<
<
svn export $DLHCB/Templates/LHCb-latex-template/latest MyNote
>
>
svn export $DLHCB/Templates/LHCb-latex-template/latest MyNote
  and find template files in MyNote/latex/ subdirectory.

Revision 62010-10-20 - TomaszSkwarnicki

Line: 1 to 1
Added:
>
>
LHCbDocs.jpg
 

Using Subversion (svn) public LHCb Document repository lhcbdocs

This SVN repository and this page are presently under construction.

Line: 124 to 126
 To reach lhcbdocs librarian send E-mail to VC-librarians-lhcbdocs at cern (you need to be a member of lhcb-general mailing list to be able to do it).

-- TomaszSkwarnicki - 25-Sep-2010

Added:
>
>
META FILEATTACHMENT attachment="LHCbDocs.jpg" attr="" comment="" date="1287573919" name="LHCbDocs.jpg" path="LHCbDocs.jpg" size="81352" stream="LHCbDocs.jpg" tmpFilename="/usr/tmp/CGItemp10321" user="tskwarni" version="1"

Revision 52010-10-19 - TomaszSkwarnicki

Line: 1 to 1
 

Using Subversion (svn) public LHCb Document repository lhcbdocs

This SVN repository and this page are presently under construction.

Line: 37 to 37
  This will prompt you for the password. If your userid on the local machine is different than at CERN, just enter anything, then the system will ask you for your username (and then password again). You will not have to enter the password again for subsequent svn commands in the same session.
Changed:
<
<
If you have ssh installed you can also do
>
>
A faster access is provided via ssh:
  svn ls svn+ssh://svn.cern.ch/reps/lhcbdocs
Changed:
<
<
With this method you can avoid entering password ever if you follow the procedure outlined at CERN svn pages.
>
>
In this method you can avoid entering password altogether if you follow the procedure outlined at CERN svn pages.
  Since it is tedious to type the repository address all the time I recommend defining an environmental variable as a shorthand e.g. (csh):
setenv DLHCB svn+ssh://svn.cern.ch/reps/lhcbdocs
Added:
>
>
  or if using https transport
Added:
>
>
 setenv DLHCB https://svn.cern.ch/reps/lhcbdocs I use this convention below.
Line: 65 to 67
 

How to extract LHCb LaTeX document template?

Changed:
<
<
If all you want is an LHCb document latex template, export the template directory into your local directory. E.g. let us call it MyNote
>
>
If all you want is an LHCb document latex template, export the template directory into your local directory. E.g. let us call it MyNote
 
Changed:
<
<
svn export $DLHCB/Templates/LHCb-latex-template/latest MyNote
>
>
svn export $DLHCB/Templates/LHCb-latex-template/latest MyNote
 
Changed:
<
<
and find template files in MyNote/latex/ subdirectory.
>
>
and find template files in MyNote/latex/ subdirectory.
  Say “make” to produce output file (main.pdf) from within the latex/ subdirectory.
Line: 98 to 100
 

lhcbdocs policies

Changed:
<
<
Since everybody in LHCb has read/write access to lhcbdocs you must behave responsibly and observe its policies! Violators will be banned by librarian from the repository. Report any abuses to the librarian (liblhcbd).
>
>
Since everybody in LHCb has read/write access to lhcbdocs you must behave responsibly and observe its policies! Violators will be banned by librarian from the repository. Report any abuses to the librarian.
 Be careful with commands which operate directly on the repository and not on your local copies (svn ci, direct svn cp, svn mv, svn dele etc.).

Respect editing policies defined in README.txt file which should be present in each project directory. Generally stay away from files you did not create unless you are sure you are authorized to change them.

Line: 115 to 117
 

What do I do if I made a mistake and don’t know what to do?

Changed:
<
<
If you make a mistake using repository and you don’t know how to recover, consult the librarian (liblhcbd).
>
>
If you make a mistake using repository and you don’t know how to recover, consult the librarian.

Librarian e-group

To reach lhcbdocs librarian send E-mail to VC-librarians-lhcbdocs at cern (you need to be a member of lhcb-general mailing list to be able to do it).
 
Changed:
<
<
-- TomaszSkwarnicki - 19-Oct-2010
>
>
-- TomaszSkwarnicki - 25-Sep-2010

Revision 42010-10-19 - TomaszSkwarnicki

Line: 1 to 1
 

Using Subversion (svn) public LHCb Document repository lhcbdocs

This SVN repository and this page are presently under construction.

Line: 31 to 31
 or more general CERN IT pages for the instructions.
Changed:
<
<
To see if you can access repository try
>
>
To see if you can access repository from your unix system try to list the main directory structure of the repository via:
 
Added:
>
>
svn ls https://svn.cern.ch/reps/lhcbdocs This will prompt you for the password. If your userid on the local machine is different than at CERN, just enter anything, then the system will ask you for your username (and then password again). You will not have to enter the password again for subsequent svn commands in the same session.

If you have ssh installed you can also do

 svn ls svn+ssh://svn.cern.ch/reps/lhcbdocs
Added:
>
>
With this method you can avoid entering password ever if you follow the procedure outlined at CERN svn pages.
  Since it is tedious to type the repository address all the time I recommend defining an environmental variable as a shorthand e.g. (csh):
setenv DLHCB svn+ssh://svn.cern.ch/reps/lhcbdocs
Added:
>
>
or if using https transport setenv DLHCB https://svn.cern.ch/reps/lhcbdocs
  I use this convention below.
Added:
>
>

Web browser access to lhcbdocs repository

You can access the repository (read only) with a web browser from any location at https://svn.cern.ch/reps/lhcbdocs/. You will be prompted to login with your CERN userid.
 

What do I do if I get error message about outdated svn client?

If you get error messages that your SVN client is outdated (it may happen on lxplus!) login to lxsvn.cern.ch instead which has the up to date SVN software.

Changed:
<
<
I noticed that sometimes the repository is momentairly not accessible which can results in odd messages when referring to it (e.g. during svn ci command). If something unexpected like this happens. Simply try again.
>
>
I noticed that sometimes the repository is momentarily not accessible which can results in odd messages when referring to it (e.g. during svn ci command). If something unexpected like this happens. Simply try again.
 

How to extract LHCb LaTeX document template?

Changed:
<
<
If all you want is an LHCb document latex template do:
>
>
If all you want is an LHCb document latex template, export the template directory into your local directory. E.g. let us call it MyNote
 
Changed:
<
<
svn export $DLHCB/Templates/LHCb-latex-template/latest directory_name_to_be_created
>
>
svn export $DLHCB/Templates/LHCb-latex-template/latest MyNote
 
Changed:
<
<
and find template files in directory_name_to_be_created/latex/ subdirectory.
>
>
and find template files in MyNote/latex/ subdirectory.
 
Changed:
<
<
Do “make all” to produce output file (main.pdf).
>
>
Say “make” to produce output file (main.pdf) from within the latex/ subdirectory.
 
Changed:
<
<
Find more info on this template directory by:
>
>
Find more info on this template directory by inspecting its README file e.g.
 
svn cat $DLHCB/Templates/LHCb-latex-template/README.txt | more  
Line: 85 to 98
 

lhcbdocs policies

Changed:
<
<
Since everybody in LHCb has read/write access to lhcbdocs you must behave responsibly and observe its policies! Violators will be banned by librarian from the repository. Report any abuses to the librarian (liblhcbd).
>
>
Since everybody in LHCb has read/write access to lhcbdocs you must behave responsibly and observe its policies! Violators will be banned by librarian from the repository. Report any abuses to the librarian (liblhcbd).
 Be careful with commands which operate directly on the repository and not on your local copies (svn ci, direct svn cp, svn mv, svn dele etc.).

Respect editing policies defined in README.txt file which should be present in each project directory. Generally stay away from files you did not create unless you are sure you are authorized to change them.

Line: 106 to 117
  If you make a mistake using repository and you don’t know how to recover, consult the librarian (liblhcbd).
Changed:
<
<

-- TomaszSkwarnicki - 25-Sep-2010

>
>
-- TomaszSkwarnicki - 19-Oct-2010

Revision 32010-10-07 - TomaszSkwarnicki

Line: 1 to 1
 

Using Subversion (svn) public LHCb Document repository lhcbdocs

This SVN repository and this page are presently under construction.

Line: 54 to 54
  If all you want is an LHCb document latex template do:
Changed:
<
<
svn export $DLHCB/Templates/LHCb-template/latest directory_name_to_be_created
>
>
svn export $DLHCB/Templates/LHCb-latex-template/latest directory_name_to_be_created
  and find template files in directory_name_to_be_created/latex/ subdirectory.
Line: 62 to 62
  Find more info on this template directory by:
Changed:
<
<
svn cat $DLHCB/Templates/LHCb-template/README.txt | more
>
>
svn cat $DLHCB/Templates/LHCb-latex-template/README.txt | more
 

Revision 22010-09-29 - TomaszSkwarnicki

Line: 1 to 1
 

Using Subversion (svn) public LHCb Document repository lhcbdocs

This SVN repository and this page are presently under construction.

Line: 47 to 47
  If you get error messages that your SVN client is outdated (it may happen on lxplus!) login to lxsvn.cern.ch instead which has the up to date SVN software.
Added:
>
>
I noticed that sometimes the repository is momentairly not accessible which can results in odd messages when referring to it (e.g. during svn ci command). If something unexpected like this happens. Simply try again.
 

How to extract LHCb LaTeX document template?

Revision 12010-09-25 - TomaszSkwarnicki

Line: 1 to 1
Added:
>
>

Using Subversion (svn) public LHCb Document repository lhcbdocs

This SVN repository and this page are presently under construction.

Draft of the initial outline for this repository can be found at this location, where basic ideas and plan are spelled out. Please be aware that the actual implementation deviates from this proposal. Our intention is to include all important information here, however, this will take time to accomplish. If you are using repository already and have suggestions how to improve documentation please send E-mail to Tomasz Skwarnicki who is serving as initial developer and librarian.

Mailing e-group list will be created for the support, but it does not exist yet.

Table of Contents

Relation to SVN LHCb code repository

SVN is also used to maintain LHCb code in a separate repository (lhcb). There is a lot of useful information about use of SVN for code development in LHCb at this page. Much of it is also relevant for use of lhcbdocs. The main differences is that while we usually check out projects from lhcb code repository via getpack interface, you will be using “svn co” directly in lhcbdocs.

Access to lhcbdocs repository

Every member of lhcb-general e-group mailing list who has account at CERN has read and write access to lhcbdocs repository. Other users have no access at all.

If you are a newcomer to svn, or if you are accessing lhcbdocs remotely you may need to set up your user account and connection to the server. Please consult LHCb instructions or more general CERN IT pages for the instructions.

To see if you can access repository try

svn ls svn+ssh://svn.cern.ch/reps/lhcbdocs

Since it is tedious to type the repository address all the time I recommend defining an environmental variable as a shorthand e.g. (csh):

setenv DLHCB svn+ssh://svn.cern.ch/reps/lhcbdocs
I use this convention below.

What do I do if I get error message about outdated svn client?

If you get error messages that your SVN client is outdated (it may happen on lxplus!) login to lxsvn.cern.ch instead which has the up to date SVN software.

How to extract LHCb LaTeX document template?

If all you want is an LHCb document latex template do:

svn export $DLHCB/Templates/LHCb-template/latest  directory_name_to_be_created
and find template files in directory_name_to_be_created/latex/ subdirectory.

Do “make all” to produce output file (main.pdf).

Find more info on this template directory by:

svn cat $DLHCB/Templates/LHCb-template/README.txt | more  

Users area in lhcbdocs

You are welcome to use lhcbdocs to develop your own documents. You will first need to create your own area in Users/ subdirectory. Please follow instructions which you can obtain via:

svn cat $DLHCB/Templates/UsersDirectoryTemplate/README.txt
Create subdirectories in your area as suggested. Equip each with README.txt. See examples at:
svn cat $DLHCB/Users/tskwarni/README.txt
svn cat $DLHCB/Users/tskwarni/TestArea/README.txt

You must observe policies spelled out in the next section.

lhcbdocs policies

Since everybody in LHCb has read/write access to lhcbdocs you must behave responsibly and observe its policies! Violators will be banned by librarian from the repository. Report any abuses to the librarian (liblhcbd). Be careful with commands which operate directly on the repository and not on your local copies (svn ci, direct svn cp, svn mv, svn dele etc.).

Respect editing policies defined in README.txt file which should be present in each project directory. Generally stay away from files you did not create unless you are sure you are authorized to change them.

If repository grows too big it will become inefficient or may be completely unusable. Try to conserve space in the repository. It is forbidden to use it for other projects than document development (absolutely no data files and code development projects!). It is mostly intended for collaborative projects, but small private projects are OK too.

Remember, every file committed to it stays forever there even if you delete it (this is versioned repository which remembers the past). When making a lot of changes, make them in a local copy. Commit to repository only after you are done for a while.

You are encouraged to request your private SVN repository for projects which don’t fit the above policies and/or require read/write access restrictions to smaller groups of people. You will find instructions how to do it at: CERN IT pages.

What do I do if I made a mistake and don’t know what to do?

If you make a mistake using repository and you don’t know how to recover, consult the librarian (liblhcbd).

-- TomaszSkwarnicki - 25-Sep-2010

 
This site is powered by the TWiki collaboration platform Powered by PerlCopyright &© 2008-2019 by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Ideas, requests, problems regarding TWiki? Send feedback