Difference between revisions of "Hypertext Syntax"

From PKC
Jump to navigation Jump to search
 
(37 intermediate revisions by the same user not shown)
Line 1: Line 1:
=Absolute Essential=
=Absolute Essential=
The essential markdown syntax for MediaWiki are:
# [[Hypertext_Syntax#Hierarchical_Markdown|Hierarchical Markdown]]: use '''<nowiki>=</nowiki>'''
# [[Hypertext_Syntax#Hyperlink to other pages|Hyperlink]]: use '''<nowiki>[</nowiki>''' and '''<nowiki>]</nowiki>'''
# [[Hypertext_Syntax#Transclusion from other pages|Transclusion]]: use '''<nowiki>{</nowiki>''' and '''<nowiki>}</nowiki>'''
They are essential because they formally define the structure of a hyperlinked document space.
==Hierarchical Markdown==
==Hierarchical Markdown==
Use a number of balanced equal signs ('''<nowiki>=</nowiki>''') to format the level of section titles. Larger number of equal signs indicates lower level.
Use a number of balanced equal signs ('''<nowiki>=</nowiki>''') to format the level of section titles. Larger number of equal signs indicates lower level.
{| class="wikitable"
{| class="wikitable"
|+ Caption text
|+ examples and rendered results
|-
|-
! Input Content !! Rendered Result
! Text Input !! Rendered Result
|-
|-
|  
|  
<nowiki>
<nowiki>
=Level1=
=Level1=
</nowiki>
||


=Level1=
|-
|
<nowiki>
==Level2==
==Level2==
 
</nowiki>
||
==Level2==
|-
|
<nowiki>
===Level3===
</nowiki>
||
===Level3===
===Level3===
 
|-
|
<nowiki>
====Level4====
====Level4====
 
</nowiki>
=====Level5=====
||
 
</nowiki> ||
 
=Level1=
==Level2==
===Level3===
====Level4====
====Level4====
=====Level5=====
|}
==Hyperlink to other pages==
{| class="wikitable"
|+ Linking to other pages [[mw:Help:Link|Help:Link on MediaWiki]]
|-
! Terminology !! Text Input !! Rendered Result
|-
| '''Local Hyperlink''' || <nowiki>[[Main Page]]</nowiki> || [[Main Page]]
|-
| '''External Hyperlink''' || <nowiki>[http://wikimedia.org wikimedia website]</nowiki> || [http://wikimedia.org wikimedia website]
|-
| '''Piped Link''' || <nowiki>[[Main Page|This is called the Piped Link]]</nowiki> || [[Main Page|This is called the Piped Link]]
|}
|}


==Hyperlink to other pages==
==Transclusion from other pages==
==Transclusion from other pages==
{| class="wikitable"
|+ Transcluding content from other pages or functions
|-
! Types of Transclusion !! Sample Text Input !! Rendered Result
|-
| locally defined page transclusion || <nowiki>{{:Paper/Algebra of Systems}}</nowiki> || {{:Paper/Algebra of Systems}}
|-
| transcluding template page || <nowiki>{{LogicModel}}</nowiki> || {{LogicModel}}
|-
| function invocation || <nowiki>{{#invoke:Utility|monthNumberToFullMonthName |{{CURRENTMONTH}}}}</nowiki> || {{#invoke:Utility|monthNumberToFullMonthName|{{CURRENTMONTH}}}}
|}
To learn how to leverage [[Parser Functions]], [[Lua]] programming language/[[Scribunto]] in MediaWiki, see [[Demo:CodeWrapper|Demo:CodeWrapper]].
=More Comprehensive Guides=
=More Comprehensive Guides=
MediaWiki's allows some mixture of HTML syntax and extension defined syntax to enable more functionalities. For additional coding syntax instruction, see the following links.
#[[mw:Help:Formatting|MediaWiki Syntax]]
#[[mw:Help:Formatting|MediaWiki Syntax]]
#[[mw:Help:Cite|Citation]]
#[[mw:Help:Link|MediaWiki Link]]
#[[mw:Help:Cite|MediaWiki Citation]]
#[[Semantic MediaWiki]]

Latest revision as of 14:49, 18 May 2022

Absolute Essential

The essential markdown syntax for MediaWiki are:

  1. Hierarchical Markdown: use =
  2. Hyperlink: use [ and ]
  3. Transclusion: use { and }

They are essential because they formally define the structure of a hyperlinked document space.

Hierarchical Markdown

Use a number of balanced equal signs (=) to format the level of section titles. Larger number of equal signs indicates lower level.

examples and rendered results
Text Input Rendered Result

=Level1=

Level1

==Level2==

Level2

===Level3===

Level3

====Level4====

Level4

Hyperlink to other pages

Linking to other pages Help:Link on MediaWiki
Terminology Text Input Rendered Result
Local Hyperlink [[Main Page]] Main Page
External Hyperlink [http://wikimedia.org wikimedia website] wikimedia website
Piped Link [[Main Page|This is called the Piped Link]] This is called the Piped Link

Transclusion from other pages

Transcluding content from other pages or functions
Types of Transclusion Sample Text Input Rendered Result
locally defined page transclusion {{:Paper/Algebra of Systems}} Koo, Hsueh-Yung Benjamin; Simmons, Willard; Crawley, Edward (Nov 16, 2021). "Algebra of Systems as a Meta Language for Model Synthesis and Analysis" (PDF). local page: IEEE TRANSACTIONS ON SYSTEMS, MAN, AND CYBERNETICS. 


transcluding template page {{LogicModel}}
Logic Model ([[{{{name}}}]]) Template:LogicModel 05 18, 2022
Abstract Specification
[[{{{name}}}/Context|Context]] {{:{{{name}}}/Context}}
[[{{{name}}}/Goal|Goal]] {{:{{{name}}}/Goal}}
[[{{{name}}}/Criteria|Success Criteria]] {{:{{{name}}}/Criteria}}
Concrete Implementation
Given [[{{{name}}}/Input|Inputs]] When [[{{{name}}}/Process|Process]] is executed... Then, we get [[{{{name}}}/Output|Outputs]]
{{:{{{name}}}/Input}} {{:{{{name}}}/Process}} {{:{{{name}}}/Output}}
Boundary/Safety Conditions of [[{{{name}}}/Boundary|{{{name}}}]]
{{:{{{name}}}/Boundary}}
function invocation {{#invoke:Utility|monthNumberToFullMonthName |{{CURRENTMONTH}}}} November

To learn how to leverage Parser Functions, Lua programming language/Scribunto in MediaWiki, see Demo:CodeWrapper.

More Comprehensive Guides

MediaWiki's allows some mixture of HTML syntax and extension defined syntax to enable more functionalities. For additional coding syntax instruction, see the following links.

  1. MediaWiki Syntax
  2. MediaWiki Link
  3. MediaWiki Citation
  4. Semantic MediaWiki