Trusted, Bureaucrats
4,228
edits
Changes
Addition of the links that the examples should create and improved the formatting.
| examples =
=== No parameters ===
This is a link to https://sourceforge.net/p/nmr-relax/code/ci/master/tree/. {{obr}}relax source{{cbr}}. {{relax source}}. === Text link ===This is a link to https://sourceforge.net/p/nmr-relax/code/ci/master/tree/.
{{obr}}relax source
{{!}} text = The relax source repository
{{cbr}}.
{{relax source
| text = The relax source repository
}}.
=== File ===
This is a link to https://sourceforge.net/p/nmr-relax/code/ci/master/tree/pipe_control/diffusion_tensor.py.
{{obr}}relax source
{{!}} path = pipe_control/diffusion_tensor.py
{{cbr}}.
{{relax source
| path = pipe_control/diffusion_tensor.py
}}.
=== File and a branch ===
This is a link to https://sourceforge.net/p/nmr-relax/code/ci/j_couplings/tree/generic_fns/align_tensor.py.
{{obr}}relax source
{{!}} path = generic_fns/align_tensor.py
{{!}} branch = j_couplings
{{cbr}}.
{{relax source
| path = generic_fns/align_tensor.py
| branch = j_couplings
}}.
=== File and a tag ===
This is a link to https://sourceforge.net/p/nmr-relax/code/ci/4.0.3/tree/pipe_control/diffusion_tensor.py.
{{obr}}relax source
{{!}} path = pipe_control/diffusion_tensor.py
{{!}} tag = 4.0.3
{{cbr}}.
{{relax source
| path = pipe_control/diffusion_tensor.py
| tag = 4.0.3
}}.
=== File and a commit ===
This is a link to https://sourceforge.net/p/nmr-relax/code/ci/bb91d6/tree/data_store/exp_info.py.
{{obr}}relax source
{{!}} path = data_store/exp_info.py
{{!}} commit = bb91d6
{{cbr}}.
{{relax source
| path = data_store/exp_info.py
| commit = bb91d6
}}.
{{obr}}relax source
{{!}} path = data_store/exp_info.py
{{!}} commit = bb91d693f4102f81735e2a965cc1eed610211753
{{cbr}}.
{{relax source
| path = data_store/exp_info.py
| commit = bb91d693f4102f81735e2a965cc1eed610211753
}}.
=== Commit ===
{{note|For a simpler interface for this specific example, see {{tl|relax commit}}.}}
This is a link to https://sourceforge.net/p/nmr-relax/code/ci/6105c8/.
{{obr}}relax source
{{!}} commit = 6105c8
{{!}} view = commit
{{cbr}}.
{{relax source
| commit = 6105c8
| view = commit
}}.
=== File and line number ===
This is a link to https://sourceforge.net/p/nmr-relax/code/ci/master/tree/gui/spin_viewer/tree.py#l68.
{{obr}}relax source
{{!}} path = gui/spin_viewer/tree.py
{{!}} line = 68
{{cbr}}.
{{relax source
| path = gui/spin_viewer/tree.py
| line = 68
}}.
=== File, line number, and commit ===
This is a link to https://sourceforge.net/p/nmr-relax/code/ci/21462188d194d28ee6bd0523ebcc13a00a73c4ba/tree/gui/spin_viewer/tree.py#l546.
{{obr}}relax source
{{!}} path = gui/spin_viewer/tree.py
{{!}} commit = 21462188d194d28ee6bd0523ebcc13a00a73c4ba
{{!}} line = 546
{{cbr}}.
{{relax source
| commit = 21462188d194d28ee6bd0523ebcc13a00a73c4ba
| line = 546
}}.
=== Custom label given ===
This is a link to https://sourceforge.net/p/nmr-relax/code/ci/master/tree/gui/spin_viewer/tree.py.
{{obr}}relax source
{{!}} path = gui/spin_viewer/tree.py
{{!}} text = The spin viewer window tree element
{{cbr}}.
{{relax source
| path = gui/spin_viewer/tree.py
| text = The spin viewer window tree element
}}.
=== Prefix of $RELAX_SRC ===
This is a link to https://sourceforge.net/p/nmr-relax/code/ci/master/tree/gui/spin_viewer/tree.py.
{{obr}}relax source
{{!}} path = gui/spin_viewer/tree.py
{{!}} pre = $RELAX_SRC
{{cbr}}.
{{relax source
| path = gui/spin_viewer/tree.py
| pre = $RELAX_SRC
}}.
=== Full path ===
This is a link to https://sourceforge.net/p/nmr-relax/code/ci/21462188d194d28ee6bd0523ebcc13a00a73c4ba/tree/gui/spin_viewer/tree.py#l546.
{{obr}}relax source
{{!}} path = gui/spin_viewer/tree.py
{{!}} line = 546
{{!}} full = 1
{{cbr}}.
{{relax source
| line = 546
| full = 1
}}.
=== Git clone ===
{{note|For a simpler interface for this specific example, see {{tl|relax clone}}.}}
This is for <code><nowiki>git clone git://git.code.sf.net/p/nmr-relax/code</nowiki></code>.
=== Aliased parameters ===
This is for a link to https://sourceforge.net/p/nmr-relax/code/ci/j_couplings/tree/generic_fns/align_tensor.py#l227.
{{obr}}relax source
{{!}} f = generic_fns/align_tensor.py
{{!}} b = j_couplings
{{!}} l = 227
{{!}} full = 1
{{cbr}}.
{{relax source
| f = generic_fns/align_tensor.py
| b = j_couplings
| l = 227
| full = 1
}}.
=== Numbered parameters ===
This is for a link to https://sourceforge.net/p/nmr-relax/code/ci/j_couplings/tree/generic_fns/align_tensor.py.
{{obr}}relax source {{!}} generic_fns/align_tensor.py {{!}} b = j_couplings {{!}} full = 1 {{cbr}}.
{{relax source | generic_fns/align_tensor.py | b = j_couplings | full = 1 }}.
}}</noinclude>