Difference between revisions of "Template:Docnav"

From FreeCAD Documentation
Jump to: navigation, search
(Vertical Docnav for clarify)
 
Line 38: Line 38:
  
 
'''Code''' 1 (English): mode 1
 
'''Code''' 1 (English): mode 1
  <nowiki>{{Docnav| Draft Workbench | Arch Workbench }}</nowiki>
+
  <nowiki>
 +
{{Docnav
 +
|Draft Workbench  
 +
|Arch Workbench  
 +
}}
 +
</nowiki>
 
Result:
 
Result:
 
{{Docnav|Draft Workbench|Arch Workbench}}
 
{{Docnav|Draft Workbench|Arch Workbench}}
Line 45: Line 50:
  
 
'''Code''' 2 (English): mode 2
 
'''Code''' 2 (English): mode 2
  <nowiki>{{Docnav| [[Draft Workbench|Draft Workbench]] | [[Arch Workbench|Arch Workbench]] }}</nowiki>
+
  <nowiki>
 +
{{Docnav
 +
|[[Draft Workbench|Draft Workbench]]
 +
|[[Arch Workbench|Arch Workbench]]  
 +
}}
 +
</nowiki>
 
Result:
 
Result:
 
{{Docnav| [[Draft Workbench|Draft Workbench]] | [[Arch Workbench|Arch Workbench]] }}
 
{{Docnav| [[Draft Workbench|Draft Workbench]] | [[Arch Workbench|Arch Workbench]] }}
  
 
'''Code''' 3 /fr (Translated):
 
'''Code''' 3 /fr (Translated):
  <nowiki>{{Docnav/fr| [[Draft Workbench/fr|Atelier Draft]] | [[Arch Workbench/fr|Atelier Arch]] }}</nowiki>
+
  <nowiki>
 +
{{Docnav/fr
 +
|[[Draft Workbench/fr|Atelier Draft]]  
 +
|[[Arch Workbench/fr|Atelier Arch]]
 +
}}
 +
</nowiki>
 
Result:
 
Result:
 
{{Docnav/fr| [[Draft Workbench/fr|Atelier Draft]] | [[Arch Workbench/fr|Atelier Arch]] }}
 
{{Docnav/fr| [[Draft Workbench/fr|Atelier Draft]] | [[Arch Workbench/fr|Atelier Arch]] }}
Line 57: Line 72:
  
 
'''Code''' 4 (English): mode 1
 
'''Code''' 4 (English): mode 1
  <nowiki>{{Docnav| Draft Workbench | Arch Workbench | Online Help Toc | My personal title }}</nowiki>
+
  <nowiki>
 +
{{Docnav
 +
|Draft Workbench  
 +
|Arch Workbench  
 +
|Online Help Toc  
 +
|My personal title  
 +
}}
 +
</nowiki>
 
Result:
 
Result:
 
{{Docnav|Draft Workbench|Arch Workbench|Online Help Toc|My personal title}}
 
{{Docnav|Draft Workbench|Arch Workbench|Online Help Toc|My personal title}}
Line 64: Line 86:
  
 
'''Code''' 5 (English) mode 2:
 
'''Code''' 5 (English) mode 2:
  <nowiki>{{Docnav| [[Draft Workbench|Draft Workbench]] | [[Arch Workbench|Arch Workbench]] | [[Online Help Toc|My personal title]] }}</nowiki>
+
  <nowiki>
 +
{{Docnav
 +
|[[Draft Workbench|Draft Workbench]]  
 +
|[[Arch Workbench|Arch Workbench]]  
 +
|[[Online Help Toc|My personal title]]  
 +
}}
 +
</nowiki>
 
Result:
 
Result:
 
{{Docnav| [[Draft Workbench|Draft Workbench]] | [[Arch Workbench|Arch Workbench]] | [[Online Help Toc|My personal title]] }}
 
{{Docnav| [[Draft Workbench|Draft Workbench]] | [[Arch Workbench|Arch Workbench]] | [[Online Help Toc|My personal title]] }}
  
 
'''Code''' 6 /fr (Translated) mode 1:
 
'''Code''' 6 /fr (Translated) mode 1:
  <nowiki>{{Docnav/fr| [[Draft Workbench/fr|Atelier Draft]] | [[Arch Workbench/fr|Atelier Arch]] | Online Help Toc/fr | Mon titre personnel }}</nowiki>
+
  <nowiki>
 +
{{Docnav/fr
 +
|[[Draft Workbench/fr|Atelier Draft]]  
 +
|[[Arch Workbench/fr|Atelier Arch]]  
 +
|Online Help Toc/fr  
 +
|Mon titre personnel  
 +
}}
 +
</nowiki>
 
Result:
 
Result:
 
{{Docnav/fr| [[Draft Workbench/fr|Atelier Draft]]|[[Arch Workbench/fr|Atelier Arch]]|Online Help Toc/fr|Mon titre personnel}}
 
{{Docnav/fr| [[Draft Workbench/fr|Atelier Draft]]|[[Arch Workbench/fr|Atelier Arch]]|Online Help Toc/fr|Mon titre personnel}}
  
 
'''Code''' 7 /fr (Translated) mode 2:
 
'''Code''' 7 /fr (Translated) mode 2:
  <nowiki>{{Docnav/fr| [[Draft Workbench/fr|Atelier Draft]] | [[Arch Workbench/fr|Atelier Arch]] | [[Online Help Toc/fr|Mon titre personnel]] }}</nowiki>
+
  <nowiki>
 +
{{Docnav/fr
 +
|[[Draft Workbench/fr|Atelier Draft]]  
 +
|[[Arch Workbench/fr|Atelier Arch]]  
 +
|[[Online Help Toc/fr|Mon titre personnel]]  
 +
}}
 +
</nowiki>
 
Result:
 
Result:
 
{{Docnav/fr| [[Draft Workbench/fr|Atelier Draft]]|[[Arch Workbench/fr|Atelier Arch]]|[[Online Help Toc/fr|Mon titre personnel]] }}
 
{{Docnav/fr| [[Draft Workbench/fr|Atelier Draft]]|[[Arch Workbench/fr|Atelier Arch]]|[[Online Help Toc/fr|Mon titre personnel]] }}
Line 81: Line 122:
  
 
'''Code''' 8 (English) mode 1:
 
'''Code''' 8 (English) mode 1:
  <nowiki>{{Docnav| Draft Workbench | }}</nowiki>
+
  <nowiki>
 +
{{Docnav
 +
|Draft Workbench  
 +
|
 +
}}</nowiki>
 
Result:
 
Result:
 
{{Docnav|Draft Workbench|}}
 
{{Docnav|Draft Workbench|}}
Line 88: Line 133:
  
 
'''Code''' 9 (English) mode 2:
 
'''Code''' 9 (English) mode 2:
  <nowiki>{{Docnav| [[Draft Workbench|Draft Workbench]] | }}</nowiki>
+
  <nowiki>
 +
{{Docnav
 +
|[[Draft Workbench|Draft Workbench]]
 +
|
 +
}}
 +
</nowiki>
 
Result:
 
Result:
 
{{Docnav| [[Draft Workbench|Draft Workbench]]| }}
 
{{Docnav| [[Draft Workbench|Draft Workbench]]| }}
  
 
'''Code''' 10 /fr (Translated):
 
'''Code''' 10 /fr (Translated):
  <nowiki>{{Docnav/fr| [[Draft Workbench/fr|Atelier Draft]] | }}</nowiki>
+
  <nowiki>
 +
{{Docnav/fr
 +
|[[Draft Workbench/fr|Atelier Draft]]
 +
|  
 +
}}
 +
</nowiki>
 
Result:
 
Result:
 
{{Docnav/fr| [[Draft Workbench/fr|Atelier Draft]] | }}
 
{{Docnav/fr| [[Draft Workbench/fr|Atelier Draft]] | }}
Line 100: Line 155:
  
 
'''Code''' 11 (English) mode 1:
 
'''Code''' 11 (English) mode 1:
  <nowiki>{{Docnav| | Draft Workbench}}</nowiki>
+
  <nowiki>
 +
{{Docnav
 +
|  
 +
|Draft Workbench
 +
}}
 +
</nowiki>
 
Result:
 
Result:
 
{{Docnav| | Draft Workbench}}
 
{{Docnav| | Draft Workbench}}
  
 
'''Code''' 12 (English) mode 2:
 
'''Code''' 12 (English) mode 2:
  <nowiki>{{Docnav| | [[Draft Workbench|Draft Workbench]]}}</nowiki>
+
  <nowiki>
 +
{{Docnav
 +
|  
 +
|[[Draft Workbench|Draft Workbench]]
 +
}}
 +
</nowiki>
 
Result:
 
Result:
 
{{Docnav| | [[Draft Workbench|Draft Workbench]]}}
 
{{Docnav| | [[Draft Workbench|Draft Workbench]]}}
  
 
'''Code''' 13 /fr (Translated):
 
'''Code''' 13 /fr (Translated):
  <nowiki>{{Docnav/fr| | [[Draft Workbench/fr|Atelier Draft]]}}</nowiki>
+
  <nowiki>
 +
{{Docnav/fr
 +
|  
 +
| [[Draft Workbench/fr|Atelier Draft]]
 +
}}
 +
</nowiki>
 
Result:
 
Result:
 
{{Docnav/fr| | [[Draft Workbench/fr|Atelier Draft]]}}
 
{{Docnav/fr| | [[Draft Workbench/fr|Atelier Draft]]}}
Line 117: Line 187:
  
 
'''Code''' 14 (English):
 
'''Code''' 14 (English):
  <nowiki>{{Docnav| | }}</nowiki>
+
  <nowiki>
 +
{{Docnav
 +
|
 +
|  
 +
}}
 +
</nowiki>
  
 
'''or'''
 
'''or'''
  
  <nowiki>{{Docnav}}</nowiki>
+
  <nowiki>
 +
{{Docnav}}
 +
</nowiki>
 
Result:
 
Result:
 
{{Docnav| | }}
 
{{Docnav| | }}
  
 
'''Code''' 15 /fr (Translated):
 
'''Code''' 15 /fr (Translated):
  <nowiki>{{Docnav/fr| | }}</nowiki>
+
  <nowiki>
 +
{{Docnav/fr
 +
|  
 +
|  
 +
}}
 +
</nowiki>
  
 
'''or'''
 
'''or'''
  
  <nowiki>{{Docnav/fr}}</nowiki>
+
  <nowiki>
 +
{{Docnav/fr}}
 +
</nowiki>
 
Result:
 
Result:
 
{{Docnav/fr}}
 
{{Docnav/fr}}
Line 137: Line 221:
  
 
'''Code''' 16 (English) mode 1:
 
'''Code''' 16 (English) mode 1:
  <nowiki>{{Docnav| | |Draft_Arc|Personal title (Draft_Arc)}}</nowiki>
+
  <nowiki>
 +
{{Docnav
 +
|  
 +
|  
 +
|Draft_Arc
 +
|Personal title (Draft_Arc)
 +
}}
 +
</nowiki>
 
Result:
 
Result:
 
{{Docnav| | |Draft_Arc|Personal title (Draft_Arc)}}
 
{{Docnav| | |Draft_Arc|Personal title (Draft_Arc)}}
Line 144: Line 235:
  
 
'''Code''' 17 (English) mode 2:
 
'''Code''' 17 (English) mode 2:
  <nowiki>{{Docnav| | | [[Draft_Arc|Personal title (Draft_Arc)]] }}</nowiki>
+
  <nowiki>
 +
{{Docnav
 +
|  
 +
|  
 +
|[[Draft_Arc|Personal title (Draft_Arc)]]  
 +
}}
 +
</nowiki>
 
Result:
 
Result:
 
{{Docnav| | | [[Draft_Arc|Personal title (Draft_Arc)]] }}
 
{{Docnav| | | [[Draft_Arc|Personal title (Draft_Arc)]] }}
  
 
'''Code''' 18 /fr (Translated):
 
'''Code''' 18 /fr (Translated):
  <nowiki>{{Docnav/fr| | | [[Draft_Arc/fr|Mon titre personnel (Draft_Arc)]] }}</nowiki>
+
  <nowiki>
 +
{{Docnav/fr
 +
|  
 +
|  
 +
|[[Draft_Arc/fr|Mon titre personnel (Draft_Arc)]]  
 +
}}
 +
</nowiki>
 
Result:
 
Result:
 
{{Docnav/fr| | | [[Draft_Arc/fr|Mon titre personnel (Draft_Arc)]] }}
 
{{Docnav/fr| | | [[Draft_Arc/fr|Mon titre personnel (Draft_Arc)]] }}
Line 164: Line 267:
  
 
'''Code''' 19 (English):
 
'''Code''' 19 (English):
  <nowiki>{{Docnav| [[Draft Workbench|Draft Workbench]] | [[Arch Workbench|Arch Workbench]] | [[FEM_Module|FEM Module]] | IconC = Workbench_FEM.svg | IconL = Fem-beam-section.svg | IconR = Fem-shell-thickness.svg }}</nowiki>
+
  <nowiki>
 +
{{Docnav
 +
|[[Draft Workbench|Draft Workbench]]  
 +
|[[Arch Workbench|Arch Workbench]]  
 +
|[[FEM_Module|FEM Module]]  
 +
|IconC = Workbench_FEM.svg  
 +
|IconL = Fem-beam-section.svg  
 +
|IconR = Fem-shell-thickness.svg  
 +
}}
 +
</nowiki>
 
Result:
 
Result:
 
{{Docnav| [[FEM_ElementGeometry1D|FEM_ElementGeometry1D]] | [[FEM_ElementGeometry2D|FEM_ElementGeometry2D]] | [[FEM_Module|FEM Module]] | IconC = Workbench_FEM.svg | IconL = Fem-beam-section.svg | IconR = Fem-shell-thickness.svg }}
 
{{Docnav| [[FEM_ElementGeometry1D|FEM_ElementGeometry1D]] | [[FEM_ElementGeometry2D|FEM_ElementGeometry2D]] | [[FEM_Module|FEM Module]] | IconC = Workbench_FEM.svg | IconL = Fem-beam-section.svg | IconR = Fem-shell-thickness.svg }}
  
 
'''Code''' 20 /fr (Translated):
 
'''Code''' 20 /fr (Translated):
  <nowiki>{{Docnav/fr| [[FEM_ElementGeometry1D/fr|FEM_ElementGeometry1D]] | [[FEM_ElementGeometry2D/fr|FEM_ElementGeometry2D]] | [[FEM_Module/fr|FEM Module]] | IconC = Workbench_FEM.svg | IconL = Fem-beam-section.svg | IconR = Fem-shell-thickness.svg }}</nowiki>
+
  <nowiki>
 +
{{Docnav/fr
 +
|[[FEM_ElementGeometry1D/fr
 +
|FEM_ElementGeometry1D]]  
 +
|[[FEM_ElementGeometry2D/fr|FEM_ElementGeometry2D]]  
 +
|[[FEM_Module/fr|FEM Module]]  
 +
|IconC = Workbench_FEM.svg  
 +
|IconL = Fem-beam-section.svg  
 +
|IconR = Fem-shell-thickness.svg  
 +
}}
 +
</nowiki>
 
Result:
 
Result:
 
{{Docnav/fr| [[FEM_ElementGeometry1D/fr|FEM_ElementGeometry1D]] | [[FEM_ElementGeometry2D/fr|FEM_ElementGeometry2D]] | [[FEM_Module/fr|FEM Module]] | IconC = Workbench_FEM.svg | IconL = Fem-beam-section.svg | IconR = Fem-shell-thickness.svg }}
 
{{Docnav/fr| [[FEM_ElementGeometry1D/fr|FEM_ElementGeometry1D]] | [[FEM_ElementGeometry2D/fr|FEM_ElementGeometry2D]] | [[FEM_Module/fr|FEM Module]] | IconC = Workbench_FEM.svg | IconL = Fem-beam-section.svg | IconR = Fem-shell-thickness.svg }}

Latest revision as of 17:55, 15 October 2019


Use this template to show an element to advance or go back a page in the documentation.

Example:

Normal mode Left, normal Right, central title imposed

Code 1 (English): mode 1

{{Docnav
|Draft Workbench 
|Arch Workbench 
}}

Result:

or

Code 2 (English): mode 2

{{Docnav
|[[Draft Workbench|Draft Workbench]]
|[[Arch Workbench|Arch Workbench]] 
}}

Result:

Code 3 /fr (Translated):

{{Docnav/fr
|[[Draft Workbench/fr|Atelier Draft]] 
|[[Arch Workbench/fr|Atelier Arch]]
}}

Result:

Arrow-left.svg Page précédente: Atelier Draft
Page suivante: Atelier Arch Arrow-right.svg

Normal mode Left, normal Right, title and personal central link

Code 4 (English): mode 1

{{Docnav
|Draft Workbench 
|Arch Workbench 
|Online Help Toc 
|My personal title 
}}

Result:

or

Code 5 (English) mode 2:

{{Docnav
|[[Draft Workbench|Draft Workbench]] 
|[[Arch Workbench|Arch Workbench]] 
|[[Online Help Toc|My personal title]] 
}}

Result:

Code 6 /fr (Translated) mode 1:

{{Docnav/fr
|[[Draft Workbench/fr|Atelier Draft]] 
|[[Arch Workbench/fr|Atelier Arch]] 
|Online Help Toc/fr 
|Mon titre personnel 
}}

Result:

Arrow-left.svg Page précédente: Atelier Draft
Page suivante: Atelier Arch Arrow-right.svg

Code 7 /fr (Translated) mode 2:

{{Docnav/fr
|[[Draft Workbench/fr|Atelier Draft]] 
|[[Arch Workbench/fr|Atelier Arch]] 
|[[Online Help Toc/fr|Mon titre personnel]] 
}}

Result:

Arrow-left.svg Page précédente: Atelier Draft
Page suivante: Atelier Arch Arrow-right.svg

Left arrow + imposed index (example last page)

Code 8 (English) mode 1:

{{Docnav
|Draft Workbench 
|
}}

Result:

or

Code 9 (English) mode 2:

{{Docnav
|[[Draft Workbench|Draft Workbench]]
|
}}

Result:

Code 10 /fr (Translated):

{{Docnav/fr
|[[Draft Workbench/fr|Atelier Draft]]
| 
}}

Result:

Arrow-left.svg Page précédente: Atelier Draft
FreeCAD.png

Right arrow + imposed index (example first page)

Code 11 (English) mode 1:

{{Docnav
| 
|Draft Workbench
}}

Result:

Code 12 (English) mode 2:

{{Docnav
| 
|[[Draft Workbench|Draft Workbench]]
}}

Result:

Code 13 /fr (Translated):

{{Docnav/fr
| 
| [[Draft Workbench/fr|Atelier Draft]]
}}

Result:

FreeCAD.png
Page suivante: Atelier Draft Arrow-right.svg

Only imposed index

Code 14 (English):

{{Docnav
|
| 
}}

or

{{Docnav}}

Result:

Code 15 /fr (Translated):

{{Docnav/fr
| 
| 
}}

or

{{Docnav/fr}}

Result:

Only index and personal title

Code 16 (English) mode 1:

{{Docnav
| 
| 
|Draft_Arc
|Personal title (Draft_Arc)
}}

Result:

or

Code 17 (English) mode 2:

{{Docnav
| 
| 
|[[Draft_Arc|Personal title (Draft_Arc)]] 
}}

Result:

Code 18 /fr (Translated):

{{Docnav/fr
| 
| 
|[[Draft_Arc/fr|Mon titre personnel (Draft_Arc)]] 
}}

Result:

DocNav with Icon : IconL, IconC, IconR (or tree icon)

Optionally you can add an icon to the left of the bar to the right of the bar or to the center of the navigation bar or to all three places at once. The position of the code can be placed arbitrarily in the navigation bar it will be placed automatically in the right place using the following codes:

  • IconL = filenameImage.ext (icon on the Left of the bar)
  • IconC = filenameImage.ext (icon in the Center of the bar)
  • IconR = filenameImage.ext (icon to the Right of the bar

example:

Code 19 (English):

{{Docnav
|[[Draft Workbench|Draft Workbench]] 
|[[Arch Workbench|Arch Workbench]] 
|[[FEM_Module|FEM Module]] 
|IconC = Workbench_FEM.svg 
|IconL = Fem-beam-section.svg 
|IconR = Fem-shell-thickness.svg 
}}

Result:

Code 20 /fr (Translated):

{{Docnav/fr
|[[FEM_ElementGeometry1D/fr
|FEM_ElementGeometry1D]] 
|[[FEM_ElementGeometry2D/fr|FEM_ElementGeometry2D]] 
|[[FEM_Module/fr|FEM Module]] 
|IconC = Workbench_FEM.svg 
|IconL = Fem-beam-section.svg 
|IconR = Fem-shell-thickness.svg 
}}

Result:

Arrow-left.svg Page précédente: Fem-beam-section.svg FEM_ElementGeometry1D
Page suivante: FEM_ElementGeometry2D Fem-shell-thickness.svg Arrow-right.svg