Template:Repo link/doc: Difference between revisions

Added examples for GitHub wikis. These will work once implemented in {{repo link}}.
(Addition of another OpenSceneGraph example to test the 'branch' and 'path' parameters (the path should be appended to the URL, but currently is not).)
(Added examples for GitHub wikis. These will work once implemented in {{repo link}}.)
(23 intermediate revisions by the same user not shown)
Line 39: Line 39:


{{repo link/doc design intro}}
{{repo link/doc design intro}}
{{repo link/doc design overview}}
{{repo link/doc design overview | site=1}}
{{repo link/doc design sourceforge}}
{{repo link/doc design sourceforge}}
{{repo link/doc design github}}
{{repo link/doc design github}}
Line 144: Line 144:


  {{obr}}repo link
  {{obr}}repo link
  {{!}} site   = sf
  {{!}} site = sf
  {{!}} repo   = flightgear
  {{!}} repo = flightgear
  {{!}} branch = version/2016.1.1/~
  {{!}} tag  = version/2016.1.1/~
  {{cbr}}.
  {{cbr}}.


{{repo link
{{repo link
| site   = sf
| site = sf
| repo   = flightgear
| repo = flightgear
| branch = version/2016.1.1/~
| tag  = version/2016.1.1/~
}}.
}}.


===== Tag, history view =====
===== Tag, history view =====
This is a link to https://sourceforge.net/p/flightgear/flightgear/ci/version/2016.1.1/~/log/?path=.
This is a link to https://sourceforge.net/p/flightgear/flightgear/ci/version/2016.1.1/~/log/?path=.
{{obr}}repo link
{{!}} site = sf
{{!}} repo = flightgear
{{!}} tag  = version/2016.1.1/~
{{!}} view = log
{{cbr}}.
{{repo link
| site = sf
| repo = flightgear
| tag  = version/2016.1.1/~
| view = log
}}.
===== Commit =====
This is a link to https://sourceforge.net/p/flightgear/flightgear/ci/f88d6418297e250138fda48f5a7d3e51bb3c543d/


  {{obr}}repo link
  {{obr}}repo link
  {{!}} site  = sf
  {{!}} site  = sf
  {{!}} repo  = flightgear
  {{!}} repo  = flightgear
  {{!}} branch = version/2016.1.1/~
  {{!}} commit = f88d6418297e250138fda48f5a7d3e51bb3c543d
  {{!}} view  = log
  {{!}} view  = commit
  {{cbr}}.
  {{cbr}}.


Line 168: Line 185:
| site  = sf
| site  = sf
| repo  = flightgear
| repo  = flightgear
| branch = version/2016.1.1/~
| commit = f88d6418297e250138fda48f5a7d3e51bb3c543d
| view  = log
| view  = commit
}}.
}}.


===== Commit =====
Or:
This is a link to https://sourceforge.net/p/flightgear/flightgear/ci/f88d6418297e250138fda48f5a7d3e51bb3c543d/


  {{obr}}repo link
  {{obr}}repo link
Line 179: Line 195:
  {{!}} repo  = flightgear
  {{!}} repo  = flightgear
  {{!}} commit = f88d6418297e250138fda48f5a7d3e51bb3c543d
  {{!}} commit = f88d6418297e250138fda48f5a7d3e51bb3c543d
{{!}} view  = commit
  {{cbr}}.
  {{cbr}}.


Line 186: Line 201:
| repo  = flightgear
| repo  = flightgear
| commit = f88d6418297e250138fda48f5a7d3e51bb3c543d
| commit = f88d6418297e250138fda48f5a7d3e51bb3c543d
| view  = commit
}}.
}}.


Line 294: Line 308:
  {{!}} repo  = simgear
  {{!}} repo  = simgear
  {{!}} view  = rss
  {{!}} view  = rss
  {{!}} branch = branches/release-2016.1                     <nowiki><!-- Dummy parameter, not to be used --></nowiki>
  {{!}} branch = branches/release-2016.1/~                  <nowiki><!-- Dummy parameter, not to be used --></nowiki>
  {{!}} path  = simgear/                                    <nowiki><!-- Dummy parameter, not to be used --></nowiki>
  {{!}} path  = simgear/                                    <nowiki><!-- Dummy parameter, not to be used --></nowiki>
  {{!}} commit = f88d6418297e250138fda48f5a7d3e51bb3c543d    <nowiki><!-- Dummy parameter, not to be used --></nowiki>
  {{!}} commit = f88d6418297e250138fda48f5a7d3e51bb3c543d    <nowiki><!-- Dummy parameter, not to be used --></nowiki>
Line 305: Line 319:
| repo  = simgear
| repo  = simgear
| view  = rss
| view  = rss
| branch = branches/release-2016.1                 <!-- Dummy parameter, not to be used -->
| branch = branches/release-2016.1/~                <!-- Dummy parameter, not to be used -->
| path  = simgear/                                <!-- Dummy parameter, not to be used -->
| path  = simgear/                                <!-- Dummy parameter, not to be used -->
| commit = f88d6418297e250138fda48f5a7d3e51bb3c543d <!-- Dummy parameter, not to be used -->
| commit = f88d6418297e250138fda48f5a7d3e51bb3c543d <!-- Dummy parameter, not to be used -->
| line  = 10                                      <!-- Dummy parameter, not to be used -->
| line  = 10                                      <!-- Dummy parameter, not to be used -->
}}.
==== FGData repository links ====
===== $FG_ROOT prefix and a commit =====
{{obr}}repo link
{{!}} site  = sf
{{!}} type  = git web
{{!}} repo  = fgdata
{{!}} path  = AI/nimitz_demo.xml
{{!}} commit = 7b53516a9619f598721d7ee34d6a446367e9d9cd
{{!}} line  = 85
{{!}} pre    = $FG_ROOT
{{cbr}}
{{repo link
| site  = sf
| type  = git web
| repo  = fgdata
| path  = AI/nimitz_demo.xml
| commit = 7b53516a9619f598721d7ee34d6a446367e9d9cd
| line  = 85
| pre    = $FG_ROOT
}}
==== FGMeta repository ====
===== Raw view =====
This is a link to https://sourceforge.net/p/flightgear/fgmeta/ci/next/tree/download_and_compile.sh?format=raw.
{{obr}}repo link
{{!}} site = sf
{{!}} repo = fgmeta
{{!}} path = download_and_compile.sh
{{!}} view = raw
{{!}} full = 1
{{cbr}}.
{{repo link
| site = sf
| repo = fgmeta
| path = download_and_compile.sh
| view = raw
| full = 1
}}.
}}.


==== FGAddon repository links ====
==== FGAddon repository links ====


===== Branch (HEAD) =====
===== Branch =====
This is a link for https://sourceforge.net/p/flightgear/fgaddon/HEAD/tree/branches/release-3.4.0/Aircraft.
This is a link for https://sourceforge.net/p/flightgear/fgaddon/HEAD/tree/branches/release-3.4.0/Aircraft.


Line 332: Line 388:
| path  = Aircraft
| path  = Aircraft
| text  = FG 3.4 add-on aircraft
| text  = FG 3.4 add-on aircraft
}}.
===== Tag =====
This is a link for https://sourceforge.net/p/flightgear/fgaddon/HEAD/tree/branches/release-3.4.0/Aircraft.  Although <code>branches/relax-3.4.0</code> is a branch, this tests the tag parameter.
{{obr}}repo link
{{!}} site = sf
{{!}} type = svn web
{{!}} repo = fgaddon
{{!}} tag  = branches/release-3.4.0
{{!}} path = Aircraft
{{!}} full = 1
{{cbr}}.
{{repo link
| site = sf
| type = svn web
| repo = fgaddon
| tag  = branches/release-3.4.0
| path = Aircraft
| full = 1
}}.
}}.


Line 351: Line 428:
| commit = 1001
| commit = 1001
| view  = commit
| view  = commit
}}.
===== r1001, default view =====
This is a link for https://sourceforge.net/p/flightgear/fgaddon/1001.
{{obr}}repo link
{{!}} site  = sf
{{!}} type  = svn web
{{!}} repo  = fgaddon
{{!}} commit = 1001
{{cbr}}.
{{repo link
| site  = sf
| type  = svn web
| repo  = fgaddon
| commit = 1001
}}.
}}.


Line 607: Line 701:


=== GitHub examples ===
=== GitHub examples ===
==== Base site URL ====
This is for the base URL https://github.com.
{{obr}}repo link{{!}}site=gh{{cbr}}.
{{repo link|site=gh}}.
{{obr}}repo link{{!}}site=gh{{!}}full=1{{cbr}}.
{{repo link|site=gh|full=1}}.
==== User repository ====
==== User repository ====
  {{obr}}repo link
  {{obr}}repo link
Line 863: Line 968:
| type  = zip
| type  = zip
| full  = 1
| full  = 1
}}.
==== GitHub issue tracker ====
===== All issues =====
This is for https://github.com/Juanvvc/c172p-detailed/issues.
{{obr}}repo link
{{!}} site = github
{{!}} proj = Juanvvc
{{!}} repo = c172p-detailed
{{!}} type = tracker
{{!}} full = 1
{{cbr}}.
{{repo link
| site = github
| proj = Juanvvc
| repo = c172p-detailed
| type = tracker
| full = 1
}}.
===== Specific issue =====
This is for https://github.com/Juanvvc/c172p-detailed/issues/1.
{{obr}}repo link
{{!}} site  = github
{{!}} proj  = Juanvvc
{{!}} repo  = c172p-detailed
{{!}} type  = tracker
{{!}} number = 1
{{!}} full  = 1
{{cbr}}.
{{repo link
| site  = github
| proj  = Juanvvc
| repo  = c172p-detailed
| type  = tracker
| number = 1
| full  = 1
}}.
==== GitHub wiki ====
===== Main page =====
This is for https://github.com/c172p-team/c172p/wiki.
{{obr}}repo link
{{!}} site = github
{{!}} proj = c172p-team
{{!}} repo = c172p
{{!}} type = wiki
{{!}} full = 1
{{cbr}}.
{{repo link
| site = github
| proj = c172p-team
| repo = c172p
| type = wiki
| full = 1
}}.
===== Subpage =====
This is for https://github.com/c172p-team/c172p/wiki/Release-process-and-versioning.
{{obr}}repo link
{{!}} site = github
{{!}} proj = c172p-team
{{!}} repo = c172p
{{!}} type = wiki
{{!}} path = Release-process-and-versioning
{{!}} full = 1
{{cbr}}.
{{repo link
| site = github
| proj = c172p-team
| repo = c172p
| type = wiki
| path = Release-process-and-versioning
| full = 1
}}.
}}.


=== GitLab examples ===
=== GitLab examples ===
==== Base site URL ====
This is for the base URL https://gitlab.com.
{{obr}}repo link{{!}}site=gl{{cbr}}.
{{repo link|site=gl}}.
{{obr}}repo link{{!}}site=gl{{!}}full=1{{cbr}}.
{{repo link|site=gl|full=1}}.
==== User repository ====
This is for https://gitlab.com/emilianh/Lockheed-L10-Electra.
{{obr}}repo link
{{!}} site  = gl
{{!}} user  = emilianh
{{!}} repo  = Lockheed-L10-Electra
{{cbr}}
{{repo link
| site  = gl
| user  = emilianh
| repo  = Lockheed-L10-Electra
}}
Or:
{{obr}}repo link
{{!}} site  = gl
{{!}} user  = emilianh
{{!}} repo  = Lockheed-L10-Electra
{{!}} full  = 1
{{cbr}}
{{repo link
| site  = gl
| user  = emilianh
| repo  = Lockheed-L10-Electra
| full  = 1
}}
==== The FlightGear Multiplayer server software ====
==== The FlightGear Multiplayer server software ====
This should produce <code><nowiki>git clone https://gitlab.com/fgms/fgms-0-x.git</nowiki></code>.
This should produce <code><nowiki>git clone https://gitlab.com/fgms/fgms-0-x.git</nowiki></code>.
Line 892: Line 1,121:
| lang = "sh"
| lang = "sh"
}}
}}
==== File ====
This is for https://gitlab.com/fg-radi/osm2city/blob/master/osm2city.py.
{{obr}}repo link
{{!}} site = gitlab
{{!}} proj = fg-radi
{{!}} repo = osm2city
{{!}} path = osm2city.py
{{!}} full = 1
{{cbr}}.
{{repo link
| site = gitlab
| proj = fg-radi
| repo = osm2city
| path = osm2city.py
| full = 1
}}.
==== File and a branch ====
This is for https://gitlab.com/tortoisegit/tortoisegit/blob/REL_1.8.16.0_EXTERNAL/release.txt.
{{obr}}repo link
{{!}} site  = gitlab
{{!}} proj  = tortoisegit
{{!}} repo  = tortoisegit
{{!}} branch = REL_1.8.16.0_EXTERNAL
{{!}} path  = release.txt
{{!}} full  = 1
{{cbr}}.
{{repo link
| site  = gitlab
| proj  = tortoisegit
| repo  = tortoisegit
| branch = REL_1.8.16.0_EXTERNAL
| path  = release.txt
| full  = 1
}}.
==== File and a commit ====
This is for https://gitlab.com/extra500/extra500/blob/20ac59/extra500-set.xml.
{{obr}}repo link
{{!}} site  = gitlab
{{!}} proj  = extra500
{{!}} repo  = extra500
{{!}} commit = 20ac59ad
{{!}} path  = extra500-set.xml
{{!}} full  = 1
{{cbr}}.
{{repo link
| site  = gitlab
| proj  = extra500
| repo  = extra500
| commit = 20ac59ad
| path  = extra500-set.xml
| full  = 1
}}.
==== File with line number ====
This is for https://gitlab.com/mdanil/Tu-144/blob/master/Models/Tu-144.xml#L8-14.
{{obr}}repo link
{{!}} site  = gitlab
{{!}} user  = mdanil
{{!}} repo  = Tu-144
{{!}} view  = blob
{{!}} branch = master
{{!}} path  = Models/Tu-144.xml
{{!}} line  = 8-14
{{!}} full  = 1
{{cbr}}.
{{repo link
| site  = gitlab
| user  = mdanil
| repo  = Tu-144
| view  = blob
| branch = master
| path  = Models/Tu-144.xml
| line  = 8-14
| full  = 1
}}.
==== Raw view ====
This is for https://gitlab.com/extra500/extra500/raw/20ac59/extra500-set.xml.
{{obr}}repo link
{{!}} site  = gitlab
{{!}} proj  = extra500
{{!}} repo  = extra500
{{!}} view  = raw
{{!}} commit = 20ac59
{{!}} path  = extra500-set.xml
{{!}} full  = 1
{{cbr}}.
{{repo link
| site  = gitlab
| proj  = extra500
| repo  = extra500
| view  = raw
| commit = 20ac59
| path  = extra500-set.xml
| full  = 1
}}.
==== Commit ====
This is for https://gitlab.com/extra500/extra500/commit/20ac59ad.
{{obr}}repo link
{{!}} site  = gitlab
{{!}} proj  = extra500
{{!}} repo  = extra500
{{!}} view  = commit
{{!}} commit = 20ac59ad
{{!}} full  = 1
{{cbr}}.
{{repo link
| site  = gitlab
| proj  = extra500
| repo  = extra500
| view  = commit
| commit = 20ac59ad
| full  = 1
}}.
==== Tree view at a given commit ====
This is for https://gitlab.com/extra500/extra500/tree/20ac59ad.
{{obr}}repo link
{{!}} site  = gitlab
{{!}} proj  = extra500
{{!}} repo  = extra500
{{!}} view  = tree
{{!}} commit = 20ac59ad
{{!}} full  = 1
{{cbr}}.
{{repo link
| site  = gitlab
| proj  = extra500
| repo  = extra500
| view  = tree
| commit = 20ac59ad
| full  = 1
}}.
==== Main views ====
===== History view =====
This is for https://gitlab.com/mailman/mailman/commits/master.
{{obr}}repo link
{{!}} site  = gl
{{!}} user  = mailman
{{!}} repo  = mailman
{{!}} view  = commits
{{!}} full  = 1
{{cbr}}.
{{repo link
| site  = gl
| user  = mailman
| repo  = mailman
| view  = commits
| full  = 1
}}.
===== History view from a commit =====
This is for https://gitlab.com/mailman/mailman/commits/1236a9cf.
{{obr}}repo link
{{!}} site  = gl
{{!}} user  = mailman
{{!}} repo  = mailman
{{!}} view  = commits
{{!}} commit = 1236a9cf
{{!}} full  = 1
{{cbr}}.
{{repo link
| site  = gl
| user  = mailman
| repo  = mailman
| view  = commits
| commit = 1236a9cf
| full  = 1
}}.


==== Zip archive download ====
==== Zip archive download ====
Line 912: Line 1,333:
| type  = zip
| type  = zip
| full  = 1
| full  = 1
}}
==== Zip archive download with tag ====
This is for https://gitlab.com/emilianh/IAR80/repository/archive.zip?ref=latest.
{{obr}}repo link
{{!}} site = gitlab
{{!}} proj = emilianh
{{!}} repo = IAR80
{{!}} tag  = latest
{{!}} type = zip
{{!}} full = 1
{{cbr}}
{{repo link
| site = gitlab
| proj = emilianh
| repo = IAR80
| tag  = latest
| type = zip
| full = 1
}}
}}


=== Gitorious archive examples ===
=== Gitorious archive examples ===
{{note|The Gitorious open source infrastructure is locked in a read-only archived state.}}
{{note|The Gitorious open source infrastructure is locked in a read-only archived state.}}
==== Base site URL ====
This is for the base URL https://gitorious.org.
{{obr}}repo link{{!}}site=go{{cbr}}.
{{repo link|site=go}}.
{{obr}}repo link{{!}}site=go{{!}}full=1{{cbr}}.
{{repo link|site=go|full=1}}.


==== The old FlightGear source repository ====
==== The old FlightGear source repository ====
Line 970: Line 1,423:
| branch = release/3.2.0
| branch = release/3.2.0
| full  = 1
| full  = 1
}}
==== File and tag in the historic fgdata repository ====
This is for https://gitorious.org/fg/fgdata?p=fg:fgdata.git;a=blob;f=Aircraft-uiuc/Cessna172/aircraft.dat;hb=refs/tags/version/3.4.0.
{{obr}}repo link
{{!}} site = gito
{{!}} proj = fg
{{!}} repo = fgdata
{{!}} path = Aircraft-uiuc/Cessna172/aircraft.dat
{{!}} tag  = version/3.4.0/~
{{!}} full = 1
{{cbr}}
{{repo link
| site = gito
| proj = fg
| repo = fgdata
| path = Aircraft-uiuc/Cessna172/aircraft.dat
| tag  = version/3.4.0/~
| full = 1
}}
}}


Line 1,063: Line 1,537:
| branch = topics/scriptable-ai-submodule
| branch = topics/scriptable-ai-submodule
| path  = Nasal/ai/ai.nas
| path  = Nasal/ai/ai.nas
| full  = 1
}}.
==== Branch ====
This is for https://gitorious.org/fg/toms-fgdata?p=fg:toms-fgdata.git;a=shortlog;h=refs/heads/canvas-gui-demo.
{{obr}}repo link
{{!}} site  = go
{{!}} proj  = fg
{{!}} repo  = toms-fgdata
{{!}} branch = canvas-gui-demo
{{!}} full  = 1
{{cbr}}.
{{repo link
| site  = go
| proj  = fg
| repo  = toms-fgdata
| branch = canvas-gui-demo
| full  = 1
| full  = 1
}}.
}}.
Line 1,210: Line 1,703:
| branch = topics/ada-support
| branch = topics/ada-support
| full  = 1
| full  = 1
}}.
==== Merge requests ====
===== Default view =====
This is for https://gitorious.org/fg/fgdata?p=fg:fgdata.git;a=commit;h=refs/merge-requests/190.
{{obr}}repo link
{{!}} site = go
{{!}} proj = fg
{{!}} repo = fgdata
{{!}} mr  = merge-requests/190
{{!}} full = 1
{{cbr}}.
{{repo link
| site = go
| proj = fg
| repo = fgdata
| mr  = 190
| full = 1
}}.
===== Commit view =====
This is for https://gitorious.org/fg/fgdata?p=fg:fgdata.git;a=commit;h=refs/merge-requests/190.
{{obr}}repo link
{{!}} site = go
{{!}} proj = fg
{{!}} repo = fgdata
{{!}} view = commit
{{!}} mr  = merge-requests/190
{{cbr}}.
{{repo link
| site = go
| proj = fg
| repo = fgdata
| view = commit
| mr  = 190
}}.
Or as a URL:
{{obr}}repo link
{{!}} site = go
{{!}} proj = fg
{{!}} repo = fgdata
{{!}} view = commit
{{!}} mr  = merge-requests/190
{{!}} full = 1
{{cbr}}.
{{repo link
| site = go
| proj = fg
| repo = fgdata
| view = commit
| mr  = 190
| full = 1
}}.
}}.