Template:Pulse-sequence-record-1.0

General template for pulse sequence records. Other pulse sequence templates should inherit this one. =Template manual=

Blank
Copy paste this into a new page and fill out the fields (refer to the remaining part of this manual on format of values). If you intend to create many records, it is worth creating another template which inherits this one with some values pre-set for convinience. You might find that the child template may be quite a bit shorter. Perhaps you will also want to add some default categorylinks into your custom template which will further simplify building the database.

Not all parametes are required. For those that are required you will receive a warning message in case you miss the parameter. Looking at other pulse sequences might give a better idea of how these records should be put together.

name
Name of pulse sequence, usually it will be name of main pulse sequence file, like gNhsqc. Note that this value can be automatically used to calculate links to parameter files, etc. This is something that can be arranged through a customized child template.

family
Wikitext containing links to appropriate experiment family pages. For example if you are creating a record for another 2D HSQC experiment, make value of family 2D HSQC. If your experiment belongs to more then one family at once, just put a comma-separated list of links like that. Once your page is saved, the family pages will be automatically updated with a link to your new record.

package
Wikitext. This will be typically description of or a link to a page describing the package to which this sequence belongs.

synopsis
Wikitext, short description of the pulse sequence

authors
Comma-separated list of initials, e.g. Template will automatically expand initials into full name and link to owner's personal page. cbr,gtm Meaning of those initials will be set in the registry page corresponding to registry_page parameter.

At this point all authors in the list must be entered in the same registry page. In the future this problem may be fixed.

author group
Plain text. Name of the author group, e.g XYZ Lab or XYZ, Inc.

copyright
Wikitext, copyright information.

readme
Link pointing to the readme file without braces. Examples:

readme=media:xyz_pulsesequence.txt readme=http://www.overthere.com/file.txt readme=ftp://ftp.righthere.com/file.txt

code
link/url

format
Format of pulse sequence code: "Varian", "Bruker", "Chemmagnetics"

image
link/url to pulse sequence image (perhaps you have pdf or file in some other format). This has nothing to do with the pulse sequence drawing extension, but it is for the users to link to the existing pulse sequence images.

Pulse sequence drawings can also be created using the drawing extension outside the template.

hardware_requirements
string of wikitext describing additional modifications of hardware required for the pulse sequence to run

console
Console type. E.g. UnityInova, Avance.

platform
Varian/Bruker/JEOL, etc.

medium
liquids/solids

dim
Number of dimensions - integer or comma-separated list of integers for reduced dimensionality experiments.

nuclei & observe
Parameters nuclei and observe contain information about nuclei involved in the pulse sequence. There are several ways that information can be entered.

A) As a comma-separated list: nuclei=1H,13C,15N nuclei=H,C,N nuclei=N,13C observe=H Notice that second option skips atomic numbers. This is OK only for atoms H (implies ), D (implies, C, N (implies , F, P. This allows somewhat of a shorthand notation. The last example includes only one nucleus, so it's "mathematically" a comma separated list with single element :). For other atoms atomic number is required.

B) Condensed list: nuclei=HCN nuclei=NHC Notice that here comma's are not used, which allows even more of a shorthand notation. This will only work for atoms H, D, C, N, F, P. Order of letters in the value of the nuclei parameter does not matter in this. If you want to place other nuclei, e.g. 23Na you will have to resort to using comma-separated list.

Element names in either case should start with the upper case character.

registry_page
name of registry page (registry_page=XYZ Lab). Registry page must contain information necessary for the pulse sequence database, etc. These pages reside in the NMRWIKI namespace, i.e. full wikilink will be  NMRWIKI:Page name . Namespace however should not be included into the value of registry_page parameter.

One example of registry page is here.

Note that registry pages are there mainly for various inner workings of the wiki, so there is no need to elaborate their text beyond what is technically necessary.

sample
Wikitext. Sample requirements: labelling, concentration, etc.