Difference between revisions of "Template:Docnav"

From FreeCAD Documentation
Jump to navigation Jump to search
(Vertical Docnav for clarify)
(modify the examples for adapt the Vertical mode more clear and modifiable)
Line 40: Line 40:
 
  <nowiki>
 
  <nowiki>
 
{{Docnav
 
{{Docnav
|Draft Workbench  
+
|[[Draft Workbench]]
|Arch Workbench  
+
|[[Arch Workbench]]
 
}}
 
}}
 
</nowiki>
 
</nowiki>
 
Result:
 
Result:
{{Docnav|Draft Workbench|Arch Workbench}}
+
{{Docnav
 +
|[[Draft Workbench]]
 +
|[[Arch Workbench]]
 +
}}
  
 
'''or'''
 
'''or'''
Line 57: Line 60:
 
</nowiki>
 
</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):
Line 67: Line 73:
 
</nowiki>
 
</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]]  
 +
}}
  
 
==Normal mode Left, normal Right, title and personal central link==
 
==Normal mode Left, normal Right, title and personal central link==
  
'''Code''' 4 (English): mode 1
+
{{ColoredParagraph|'''Code''' 4 (English): mode 1 {{Optional|Not advised}}}}
 
  <nowiki>
 
  <nowiki>
 
{{Docnav
 
{{Docnav
|Draft Workbench  
+
|[[Draft Workbench]]
|Arch Workbench  
+
|[[Arch Workbench]]
|Online Help Toc  
+
|Online Help Toc|My personal title
|My personal title  
 
 
}}
 
}}
 
</nowiki>
 
</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
 +
}}
  
 
'''or'''
 
'''or'''
Line 94: Line 106:
 
</nowiki>
 
</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:
+
{{ColoredParagraph|'''Code''' 6 /fr (Translated) mode 1: {{Optional|Not advised}}}}
 
  <nowiki>
 
  <nowiki>
 
{{Docnav/fr
 
{{Docnav/fr
 
|[[Draft Workbench/fr|Atelier Draft]]  
 
|[[Draft Workbench/fr|Atelier Draft]]  
 
|[[Arch Workbench/fr|Atelier Arch]]  
 
|[[Arch Workbench/fr|Atelier Arch]]  
|Online Help Toc/fr  
+
|Online Help Toc/fr|Mon titre personnel  
|Mon titre personnel  
 
 
}}
 
}}
 
</nowiki>
 
</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:
Line 117: Line 136:
 
</nowiki>
 
</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]]  
 +
}}
  
 
==Left arrow + imposed index (example last page)==
 
==Left arrow + imposed index (example last page)==
Line 124: Line 147:
 
  <nowiki>
 
  <nowiki>
 
{{Docnav
 
{{Docnav
|Draft Workbench  
+
|[[Draft Workbench]]
 
|
 
|
}}</nowiki>
+
}}
 +
</nowiki>
 
Result:
 
Result:
{{Docnav|Draft Workbench|}}
+
{{Docnav
 +
|[[Draft Workbench]]
 +
|
 +
}}
  
 
'''or'''
 
'''or'''
Line 140: Line 167:
 
</nowiki>
 
</nowiki>
 
Result:
 
Result:
{{Docnav| [[Draft Workbench|Draft Workbench]]| }}
+
{{Docnav
 +
|[[Draft Workbench|Draft Workbench]]
 +
|  
 +
}}
  
 
'''Code''' 10 /fr (Translated):
 
'''Code''' 10 /fr (Translated):
Line 150: Line 180:
 
</nowiki>
 
</nowiki>
 
Result:
 
Result:
{{Docnav/fr| [[Draft Workbench/fr|Atelier Draft]] | }}
+
{{Docnav/fr
 +
|[[Draft Workbench/fr|Atelier Draft]]  
 +
|  
 +
}}
  
 
==Right arrow + imposed index (example first page)==
 
==Right arrow + imposed index (example first page)==
Line 158: Line 191:
 
{{Docnav
 
{{Docnav
 
|  
 
|  
|Draft Workbench
+
|[[Draft Workbench]]
 
}}
 
}}
 
</nowiki>
 
</nowiki>
 
Result:
 
Result:
{{Docnav| | Draft Workbench}}
+
{{Docnav
 +
|  
 +
|[[Draft Workbench]]
 +
}}
  
 
'''Code''' 12 (English) mode 2:
 
'''Code''' 12 (English) mode 2:
Line 172: Line 208:
 
</nowiki>
 
</nowiki>
 
Result:
 
Result:
{{Docnav| | [[Draft Workbench|Draft Workbench]]}}
+
{{Docnav
 +
|  
 +
|[[Draft Workbench|Draft Workbench]]
 +
}}
  
 
'''Code''' 13 /fr (Translated):
 
'''Code''' 13 /fr (Translated):
Line 178: Line 217:
 
{{Docnav/fr
 
{{Docnav/fr
 
|  
 
|  
| [[Draft Workbench/fr|Atelier Draft]]
+
|[[Draft Workbench/fr|Atelier Draft]]
 
}}
 
}}
 
</nowiki>
 
</nowiki>
 
Result:
 
Result:
{{Docnav/fr| | [[Draft Workbench/fr|Atelier Draft]]}}
+
{{Docnav/fr
 +
|  
 +
|[[Draft Workbench/fr|Atelier Draft]]
 +
}}
  
 
==Only imposed index==
 
==Only imposed index==
Line 200: Line 242:
 
</nowiki>
 
</nowiki>
 
Result:
 
Result:
{{Docnav| | }}
+
{{Docnav
 +
|  
 +
|  
 +
}}
  
 
'''Code''' 15 /fr (Translated):
 
'''Code''' 15 /fr (Translated):
Line 220: Line 265:
 
==Only index and personal title==
 
==Only index and personal title==
  
'''Code''' 16 (English) mode 1:
+
{{ColoredParagraph|'''Code''' 16 (English) mode 1: {{Optional|Not advised}}}}
 
  <nowiki>
 
  <nowiki>
 
{{Docnav
 
{{Docnav
 
|  
 
|  
 
|  
 
|  
|Draft_Arc
+
|[[Draft_Arc]] Personal title (Draft_Arc)
|Personal title (Draft_Arc)
 
 
}}
 
}}
 
</nowiki>
 
</nowiki>
 
Result:
 
Result:
{{Docnav| | |Draft_Arc|Personal title (Draft_Arc)}}
+
{{Docnav
 +
|
 +
|  
 +
|[[Draft_Arc]] Personal title (Draft_Arc)
 +
}}
  
 
'''or'''
 
'''or'''
Line 243: Line 291:
 
</nowiki>
 
</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):
Line 254: Line 306:
 
</nowiki>
 
</nowiki>
 
Result:
 
Result:
{{Docnav/fr| | | [[Draft_Arc/fr|Mon titre personnel (Draft_Arc)]] }}
+
{{Docnav/fr
 +
|  
 +
|  
 +
|[[Draft_Arc/fr|Mon titre personnel (Draft_Arc)]]  
 +
}}
  
 
==DocNav with Icon : IconL, IconC, IconR (or tree icon)==
 
==DocNav with Icon : IconL, IconC, IconR (or tree icon)==
Line 278: Line 334:
 
</nowiki>
 
</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>
 
  <nowiki>
 
{{Docnav/fr
 
{{Docnav/fr
|[[FEM_ElementGeometry1D/fr
+
|[[FEM_ElementGeometry1D/fr|FEM_ElementGeometry1D]]  
|FEM_ElementGeometry1D]]  
 
 
|[[FEM_ElementGeometry2D/fr|FEM_ElementGeometry2D]]  
 
|[[FEM_ElementGeometry2D/fr|FEM_ElementGeometry2D]]  
 
|[[FEM_Module/fr|FEM Module]]  
 
|[[FEM_Module/fr|FEM Module]]  
Line 293: Line 355:
 
</nowiki>
 
</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  
 +
}}
  
 
[[Category:Template]]
 
[[Category:Template]]

Revision as of 17:08, 15 May 2020


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 [Not advised]
{{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: [Not advised]
{{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: [Not advised]
{{Docnav
| 
| 
|[[Draft_Arc]] Personal title (Draft_Arc)
}}

Result:

FreeCAD.png
FreeCAD.png
Draft_Arc Personal title (Draft_Arc)

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