Template:Repo link/doc design sourceforge commit

From FlightGear wiki
Jump to navigation Jump to search

Site: SourceForge

Project vs. developer page

For a normal SourceForge project and a SourceForge developer page, the base URL is respectively constructed as: 

https://sourceforge.net/p/<proj>/<repo>/
https://sourceforge.net/u/<user>/<repo>/

This will be abstracted as: 

https://sourceforge.net/<u|p>/<user>|<proj>/<repo>/

SourceForge git <URL>

For the svn repository type, the <URL> value will be: 

https://sourceforge.net/<u|p>/<user>|<proj>/<repo>/ci/<commit>

SourceForge svn <URL>

For the svn repository type, the <URL> value will be: 

https://sourceforge.net/<u|p>/<user>|<proj>/<repo>/<commit|HEAD>

SourceForge URL <TEXT>

The link text <TEXT>, if the text parameter is not set, will simply be: 

MISSING commit <commit>

Or if the text parameter is supplied, the <TEXT> is simply: 

<text>


The following template description is not displayed when the template is inserted in an article.

Goal

To provide documentation of the design of the {{repo link}} family of templates. This is only for use within documentation of the subtemplates. This is for use by the SourceForge specific {{* commit}} set of subtemplates.

Usage

{{repo link/doc design sourceforge commit
| label =
| proj  = 
| repo  = 
| user  =
| git   =
| svn   =
}}
label
The name of the repository, for use in the <TEXT> documentation.
proj
The optional project name.
repo
The optional repository name.
user
If set to 1, then both the user and project pages will be part of the description. Otherwise only the project pages will be described.
git
If set to 1, then git instructions will be included.
svn
If set to 1, then svn instructions will be included.

Examples

Git project pages

{{repo link/doc design sourceforge commit
| label = SimGear
| proj  = flightgear
| repo  = simgear
| user  = 0
| git   = 1
| svn   = 0
}}

Site: SourceForge

Project page

For a normal SourceForge project page, the base URL is respectively constructed as: 

https://sourceforge.net/p/flightgear/simgear/

SourceForge git <URL>

For the svn repository type, the <URL> value will be: 

https://sourceforge.net/p/flightgear/simgear/ci/<commit>

SourceForge URL <TEXT>

The link text <TEXT>, if the text parameter is not set, will simply be: 

SimGear commit <commit>

Or if the text parameter is supplied, the <TEXT> is simply: 

<text>
Retrieved from "https://wiki.flightgear.org/w/index.php?title=Template:Repo_link/doc_design_sourceforge_commit&oldid=95084"