6,566
edits
Template:Readme file: Difference between revisions
Added the 'line' parameter as this is used by some wiki pages with broken Gitorious links. This is passed into {{fgdata source}}, but required a small redesign to have the full path handed by template.
(Independence of the template from SourceForge. The URL is now being generated by the {{fgdata source}} template, and the name SourceForge has been removed from the documentation.) |
(Added the 'line' parameter as this is used by some wiki pages with broken Gitorious links. This is passed into {{fgdata source}}, but required a small redesign to have the full path handed by template.) |
||
| Line 8: | Line 8: | ||
-->}}<!-- | -->}}<!-- | ||
-->}}<!-- | -->}}<!-- | ||
-->[{{fgdata source|branch={{{2|next}}}|path=Docs | -->[{{fgdata source | ||
| branch = {{{2|next}}} | |||
| path = Docs/<!-- | |||
-->{{#ifeq: {{{1}}} | model-combined.eff <!-- Is the file to link to README.model-combined.eff? --> | |||
| <!-- Yes, add the extra path --><!-- | |||
-->model-combined.eff/ | |||
}}<!-- | |||
-->README<!-- | |||
-->{{#if: {{{1|}}} | .{{{1}}}}}<!-- Is the file defined? --> | |||
| line{{#if:{{{line|}}}||NULL}} = {{{line}}} | |||
| full = 1 | |||
}} <!-- | |||
-->{{#if: {{{1|}}} <!-- Is the file defined? --> | -->{{#if: {{{1|}}} <!-- Is the file defined? --> | ||
| <!-- Yes, go to file path --><!-- | | <!-- Yes, go to file path --><!-- | ||
--> | -->README.{{{1}}} | ||
| <!-- No, go to the deafult --><!-- | | <!-- No, go to the deafult --><!-- | ||
--> | -->README<!-- | ||
-->}}]<noinclude> | -->}}<!-- | ||
-->{{#if: {{{line|}}} | #l{{{line}}}}}<!-- Show the line number. | |||
-->]<noinclude> | |||
{{Informative template|1= | {{Informative template|1= | ||
__NOTOC__ | __NOTOC__ | ||
| Line 25: | Line 34: | ||
== Usage == | == Usage == | ||
{{obr}}'''readme file'''{{!}}''file''{{!}}''commit'' {{!}}''nopath''={{cbr}} | {{obr}}'''readme file''' | ||
{{!}} ''file'' | |||
{{!}} ''commit'' | |||
{{!}} ''line'' = | |||
{{!}} ''nopath'' = | |||
{{cbr}} | |||
All parameters are optional. | All parameters are optional. | ||
; file: Readme file name, not including <code>README.</code>. If empty, the link will go to <code>$ | ; file: Readme file name, not including <code>README.</code>. If empty, the link will go to <code>$FG_ROOT/Docs/README</code>. | ||
: For <code>model-combined.eff/README.model-combined.eff</code> you only have to specify '''model-combined.eff'''. | : For <code>model-combined.eff/README.model-combined.eff</code> you only have to specify '''model-combined.eff'''. | ||
; commit: Optional SHA-1 commit reference to use instead of the latest commit. | ; commit: Optional SHA-1 commit reference to use instead of the latest commit. | ||
; line: Optional line number of the README file to jump to. | |||
; nopath: If not empty the path will not be shown. | ; nopath: If not empty the path will not be shown. | ||
| Line 46: | Line 62: | ||
<nowiki>* {{readme file|materials|nopath=1}}</nowiki> | <nowiki>* {{readme file|materials|nopath=1}}</nowiki> | ||
* {{readme file|materials|nopath=1}} | * {{readme file|materials|nopath=1}} | ||
<nowiki>* {{readme file|gui|line=16}}</nowiki> | |||
* {{readme file|gui|line=16}} | |||
}} | }} | ||