aboutsummaryrefslogtreecommitdiff
path: root/wikilib.d/PmWiki.MarkupMasterIndex
blob: 30d5af67ee4b13c72824fed0f14b9bbc771dc2c7 (plain)
1
2
3
4
5
6
7
8
9
10
version=pmwiki-2.3.35 ordered=1 urlencoded=1
author=simon
charset=UTF-8
csum=hlt (+61)
name=PmWiki.MarkupMasterIndex
rev=294
targets=PmWiki.WikiStyles,PmWiki.ListStyles,PmWiki.Links,PmWiki.WikiWord,PmWiki.Categories,PmWiki.InterMap,PmWiki.Uploads,PmWiki.LinkSchemes,PmWiki.Images,PmWiki.TextFormattingRules,Cookbook.WikiStylesPlus,PmWiki.BlockMarkup,PmWiki.PageDirectives,PmWiki.Tables,PmWiki.TableDirectives,PmWiki.GroupHeaders,PmWiki.CommentMarkup,PmWiki.PageVariables,PmWiki.IncludeOtherPages,PmWiki.PageTextVariables,PmWiki.ConditionalMarkup,PmWiki.PageLists,PmWiki.TableOfContents,PmWiki.Forms,PmWiki.WikiTrails,PmWiki.PageListTemplates,PmWiki.Internationalizations,PmWiki.SkinTemplates,PmWiki.MarkupExpressions
text=(:title Markup Master Index:)%0a(:Summary:Tabulation of all PmWiki markup:)%0aThis page contains the most frequently used wiki markup, briefly. Follow the links in each section to learn more.%0a%0a!! Markup concepts introduction%0aPmWiki markup can be applied to 'blocks' of text, and to text 'lines'.%0aPmWiki markup is also used to read and save page, group, and wiki metadata through the use of variables. %0aPmWiki markup can be used to process metadata variables though expressions and [[#PageLists|pagelists]].%0aPmWiki provides a [[WikiStyles|wiki style]] markup that can be applied to text, [[ListStyles|lists]], paragraphs, and blocks.%0a%0aText markup, also known as wikitext is variable, see below, and in general broadly follows wiki conventions. %0aText markup only applies to single lines of text, delimited by a [[Wikipedia:Newline|newline]].%0a%0aBlock markup is applied to multiple lines of text as [[#BlockMarkups|paragraph blocks]] and [[#DivisionBlocks|division blocks]].%0a%0aIn PmWiki the most important markup is the [[#Directives|directive]]. %0aThe directive is signified by parenthesis and a colon, viz: %25pmhlt%25[@(:...:)@].%0aThe directive provides most of PmWiki's functionality. %0a%0a[[#Expressions|Markup expressions]] %25pmhlt%25[@{(...)}@], [[#PageVariables|variable markup]] [@{$...}@], and [[wiki styles]] [@%25...%25@] also provide PmWiki functionality.%0a%0a!! [[#LinkMarkups]] Links%0a%0aSee [[Links]]%0a!!![[#ExternalLinks]]External links%0a-%3c %25pmhlt%25[@https://example.com@]%0a-%3c %25pmhlt%25[@[[https://example.com]] @]%0a-%3c %25pmhlt%25[@[[https://example.com"tool tip"]] @]%0a-%3c %25pmhlt%25[@[[https://example.com | link text]] @]%0a-%3c %25pmhlt%25[@[[link text -> https://example.com]] @]%0aUse %25pmhlt%25[@[=link address=]@] to escape any special characters, including quotes, spaces, parentheses and pipes. %0a%0a[[#InternalLinks]]%0a!!! Page links%0a-%3c %25pmhlt%25[@[[PageName]] @]%0a-%3c %25pmhlt%25[@[[page name]] @]%0a-%3c %25pmhlt%25[@[[page (name)]] @]%0a-%3c %25pmhlt%25[@[[PageName | link text]] @]%0a-%3c %25pmhlt%25[@[[PageName | + ]] @] ''(titled link)''%0a-%3c %25pmhlt%25[@[[PageName | # ]] @] ''(anonymous numerical reference link)''%0a-%3c %25pmhlt%25[@[[PageName"tool tip"]] @]%0a-%3c %25pmhlt%25[@[[link text -> PageName]] @]%0a-%3c %25pmhlt%25[@[[#anchor]] @] ''(to create an anchor)''%0a-%3c %25pmhlt%25[@[[#anchor | link text]] @] ''(to refer to an anchor)''%0a-%3c %25pmhlt%25[@[[#anchor | # ]] @] ''(anonymous numerical reference link)''%0a-%3c %25pmhlt%25[@[[PageName#anchor | link text]] @] ''(to refer to an anchor in another page)''%0a%0a%0aSee also [[WikiWord]] on how to enable [@WikiWord@] links.%0a%0a[[#WikiGroupLinks]]%0a!!! WikiGroup links%0aSee [[Links]] and [[Categories]] %0a-%3c %25pmhlt%25[@[[GroupName/]] or [[Group name/]] @]%0a-%3c %25pmhlt%25[@[[GroupName"tool tip"]] @]%0a-%3c %25pmhlt%25[@[[GroupName.]] @]%0a-%3c %25pmhlt%25[@[[GroupName/PageName]] or [[GroupName/page name]] @]%0a-%3c %25pmhlt%25[@[[(GroupName.)page name]] @]%0a%0a-%3c %25pmhlt%25[@[[~Author Name]] @]%0a-%3c %25pmhlt%25[@[[~Author Name | +]] @]%0a-%3c %25pmhlt%25[@[[~Author Name | #]] @]%0a-%3c %25pmhlt%25[@[[~Author Name | link text]] @]%0a-%3c %25pmhlt%25[@[[~Author Name"tool tip"]] @]%0a-%3c %25pmhlt%25[@[[!Category Name]] @]%0a%0a[[#IntermapLinks]]%0a!!! InterMap links%0aSee [[InterMap]]%0a-%3c %25pmhlt%25[@[[Path:/path/local_document.html]] @]%0a-%3c %25pmhlt%25[@[[Wikipedia:WikiWikiWeb]] @]%0a%0a[[#EmailLinks]]%0a!!! Email links%0a-%3c %25pmhlt%25[@mailto:someone@example.com @]%0a-%3c %25pmhlt%25[@[[(mailto:)someone@example.com]] @]%0a-%3c %25pmhlt%25[@[[mailto:someone@example.com | display text]] @]%0a-%3c %25pmhlt%25[@[[display text -> mailto:someone@example.com]] @]%0a%0a[[#UploadLinks]]%0a!!! Upload links%0aSee [[Uploads]] and [[#Images|Images]]%0a-%3c %25pmhlt%25[@Attach:file.odt @]%0a-%3c %25pmhlt%25[@[[(Attach:)file.odt]] @]%0a-%3c %25pmhlt%25[@[[Attach:file.odt | alternative text ]] @]%0a-%3c %25pmhlt%25[@[[Attach:file with spaces.pdf]] @]%0a-%3c %25pmhlt%25[@[[Attach:Groupname./file with spaces.pdf]] @]%0a%0a[[#linkschemes]]%0a!!! [[(PmWiki:)Link Schemes]]%0aIn addition to %25pmhlt%25@@http:@@, @@https:@@, @@mailto:@@ PmWiki also supports:%0a-%3c %25pmhlt%25@@ftp:@@%0a-%3c %25pmhlt%25@@news:@@%0a-%3c %25pmhlt%25@@gopher:@@%0a-%3c %25pmhlt%25@@nap:@@%0a-%3c %25pmhlt%25@@file:@@%0a-%3c %25pmhlt%25@@tel:@@%0a-%3c %25pmhlt%25@@geo:@@%0a%0a!! [[#Images]] Images%0a%0aSee [[Images]] and [[Uploads]]%0a!!! [[#ImagesAsImages]] Images as Images%0a-%3c %25pmhlt%25[@https://example.com/image.gif@]%0a-%3c %25pmhlt%25[@https://example.com/image.gif"alt text"@]%0a-%3c %25pmhlt%25[@Attach:image.gif"My image"@]%0a-%3c %25pmhlt%25[@Attach:Groupname./image.gif"image in another group"@]%0a-%3c %25pmhlt%25[@Attach:Groupname.Pagename/image.gif"image on another page"@]%0a-%3c %25pmhlt%25[@%25lfloat%25 Attach:image.gif | Caption %25%25@] ''(could be [=%25rfloat%25, %25center%25, %25rframe%25, %25lframe%25, %25frame%25 =])''%0a-%3c %25pmhlt%25[@%25width=200px%25 Attach:image.gif %25%25@]%0a-%3c %25pmhlt%25[@%25thumb%25 Attach:image.gif %25%25@]%0a%0a%0a!!! [[#ImagesAsLinks]] Images as links%0a%0a-%3c %25pmhlt%25[@[[Attach:image.gif]] @]%0a-%3c %25pmhlt%25[@[[(Attach:)image.gif]] @]%0a-%3c %25pmhlt%25[@[[PageName | Attach:image.gif"alt text"]] @]%0a-%3c %25pmhlt%25[@[[https://example.com/ | Attach:image.gif"alt text"]] @]%0a-%3c %25pmhlt%25[@[[https://example.com/ | https://example.com/image.png"alt text"]] | Caption @]%0a-%3c %25pmhlt%25[@%25rframe thumb%25 [[Attach:image.gif | Attach:image.gif"alt text"]] | Caption @]%0a%0a%0a!! [[#StartOfLine]] Start-of-line markup%0a%0aSee [[Text formatting rules]]%0a%0a!!! [[#Lists]] [[PmWiki/TextFormattingRules#BulletedLists| Lists]]%0a%0aSee [[List styles]], [[Wiki styles]] and [[Cookbook:Wiki Styles Plus]]%0a-%3c %25pmhlt%25[@* unordered list@]%0a-%3c %25pmhlt%25[@** deeper list@]%0a-%3c %25pmhlt%25[@# ordered list@]%0a-%3c %25pmhlt%25[@# %25item value=#%25@] arbitrary start number%0a-%3c %25pmhlt%25[@# %25decimal%25, %25roman%25, %25ROMAN%25, %25alpha%25, %25ALPHA%25 @]%0a-%3c %25pmhlt%25[@%25comment%25 @]%0a-%3c %25pmhlt%25[@:term:definition@]%0aAlso%0a-%3c %25pmhlt%25[@Q:@] start a question paragraph%0a-%3c %25pmhlt%25[@A:@] start an answer paragraph%0a%0a%0a!!! [[#Headings]] Headings%0a%0a-%3c %25pmhlt%25[@!! Heading@]%0a-%3c %25pmhlt%25[@!!! Deeper heading@]%0a%0a%0a!!! [[#BlockMarkups]] Paragraph blocks%0a%0a-%3c %25pmhlt%25[@-> indented text@]%0a-%3c %25pmhlt%25[@-%3c hanging indent@]%0a-%3c %25pmhlt%25[@%3cspace> preformatted text@]%0a-%3c %25pmhlt%25@@[=[@...@]=]@@ preformatted block%0a-%3c %25pmhlt%25[@----@] (horizontal rule)%0a-%3c %25pmhlt%25[@blank line@] is vertical space%0a-%3c %25pmhlt%25[@\@] at end of line joins next line%0a-%3c %25pmhlt%25[@\\@] at end of line produces a line break%0a-%3c %25pmhlt%25[@\\\@] at the end of a line produces a blank line, even within a list item, n backslashes will produce n-1 blank lines%0a-%3c %25pmhlt%25[@[[%3c%3c]] @] produces a line break that clears floating content%0a%0a%0a!!! [[#DivisionBlocks]] Division blocks, Semantic elements%0a%0aSee [[Block markup]], [[Wiki styles]] and [[Page directives]]%0a-%3c %25pmhlt%25[@>>wikistyle%3c%3c@]%0a-%3c %25pmhlt%25[@>>%3c%3c@]%0a-%3c %25pmhlt%25[@(:div class="" style="":) @]%0a-%3c %25pmhlt%25[@(:divend:) @]%0a-%3c %25pmhlt%25[@>>comment%3c%3c@] %0aSemantic HTML 5 elements%0a-%3c %25pmhlt%25[@(:article:)...(:articleend:)@]%0a-%3c %25pmhlt%25[@(:section:)...(:sectionend:)@]%0a-%3c %25pmhlt%25[@(:header:)...(:headerend:)@]%0a-%3c %25pmhlt%25[@(:footer:)...(:footerend:)@]%0a-%3c %25pmhlt%25[@(:aside:)...(:asideend:)@]%0a-%3c %25pmhlt%25[@(:address:)...(:addressend:)@]%0a-%3c %25pmhlt%25[@(:nav:)...(:navend:)@]%0a-%3c %25pmhlt%25[@(:details summary="Summary" open=open:)...(:detailsend:)@]%0a%0a%0a!! [[#Text]] Text markup%0a%0aSee [[Text formatting rules]]%0a!!! [[#InlineMarkups]] Character format%0a%0a-%3c %25pmhlt%25[@''emphasized''@] %0a-%3c %25pmhlt%25[@'''strong'''@]%0a-%3c %25pmhlt%25[@'''''strong emphasis'''''@]%0a-%3c %25pmhlt%25[@@@monospaced@@@]%0a-%3c %25pmhlt%25[@[-small-], [--smaller--]@]%0a-%3c %25pmhlt%25[@[+big+], [++bigger++]@]%0a-%3c %25pmhlt%25[@'-small-', '+big+'@]%0a-%3c %25pmhlt%25[@'^superscript^', '_subscript_'@]%0a-%3c %25pmhlt%25[@{+inserted+} (underscore)@]%0a-%3c %25pmhlt%25[@{-deleted-} (strikethrough)@]%0a-%3c %25pmhlt%25@@[=[@escaped code@]=]@@%0a-%3c %25pmhlt%25[@[=escaped text=]@]%0a%0a%0a!!! [[#PostingMarkups]] Posting markup%0a%0a-%3c %25pmhlt%25@@~~@@@@~@@ (author's signature)%0a-%3c %25pmhlt%25@@~~@@@@~~@@ (author's signature and date)%0a-%3c %25pmhlt%25@@[=(:encrypt=] ''phrase''[=:)=]@@ -- replaced with encrypted form of ''phrase''%0a%0a%0a!! [[#Tables]] Tables%0a%0a!!!  [[#PlainTables]] Plain rows and columns of text%0a%0aSee [[Tables]]%0a-%3c %25pmhlt%25[@||table attributes@]%0a-%3c %25pmhlt%25[@||!table caption!||@]%0a-%3c %25pmhlt%25[@||left aligned  || centered ||  right aligned||@]%0a-%3c %25pmhlt%25[@||!column heading||@]%0a-%3c %25pmhlt%25[@||spanned columns ||||||@]%0a%0a!!! [[#TablesAndDivs]]  Structured tables%0a%0aSee [[Table directives ]]%0a-%3c %25pmhlt%25[@(:table attr:) @]%0a-%3c %25pmhlt%25[@(:headnr attr:) @]%0a-%3c %25pmhlt%25[@(:head attr:) @]%0a-%3c %25pmhlt%25[@(:cellnr attr:) @]%0a-%3c %25pmhlt%25[@(:cell attr:) @]%0a-%3c %25pmhlt%25[@(:tableend:) @]%0a%0a!! [[#Directives]] Directives%0a%0a!!! [[#PageDirectives]] Page directives%0a%0aSee [[Page directives]]%0a-%3c %25pmhlt%25[@(:redirect PageName:) @]%0a%0a-%3c %25pmhlt%25[@(:spacewikiwords:) @] [@(:nospacewikiwords:) @]%0a-%3c %25pmhlt%25[@(:linkwikiwords:) @] [@(:nolinkwikiwords:) @]%0a-%3c %25pmhlt%25[@(:linebreaks:) @] [@(:nolinebreaks:) @]%0a%0a!!! [[#Display]] Display%0a%0aSee [[Page directives]] [[Group headers]]%0a-%3c %25pmhlt%25[@(:noheader:), (:nofooter:) @]%0a-%3c %25pmhlt%25[@(:notitle:) @]%0a-%3c %25pmhlt%25[@(:noleft:), (:noright:) @]%0a-%3c %25pmhlt%25[@(:nogroupheader:), (:nogroupfooter:) @]%0a-%3c %25pmhlt%25[@(:noaction:) @]%0a%0a%0a!!! [[#Metadata]] Metadata%0a%0aSee [[Page directives]], [[(PmWiki:)Comment markup]],  [[Page variables]]%0a-%3c %25pmhlt%25[@(:title text:) @]%0a-%3c %25pmhlt%25[@(:keywords word, ...:) @]%0a-%3c %25pmhlt%25[@(:description text:) @]%0a-%3c %25pmhlt%25[@(:comment text:) @]%0a-%3c %25pmhlt%25[@{Group/PageName$:variable}@] [-includes from [@ (:variable:text:) @]-]%0a-%3c for example %25pmhlt%25@@[= (:=]Summary:text:) @@%0a%0a%0a!!! [[#IncludeOtherPages]] Include%0a%0aSee [[Include other pages]], [[Page text variables]]%0a-%3c %25pmhlt%25[@(:include PageName:) @]%0a-%3c %25pmhlt%25[@(:include PageName#start#end lines=n paras=n:) @]%0a-%3c %25pmhlt%25[@(:include Page1 Page2 Page3:) @]%0a-%3c %25pmhlt%25[@{Group/PageName$:Var}@] [-includes from [@ (:name:text:) @]-]%0a-%3c %25pmhlt%25[@(:nl:) @] [-separate included text by conditional line break-]%0a%0a!!! [[#ConditionalMarkup]] Conditional markup%0a%0aSee [[Conditional markup]]%0a-%3c %25pmhlt%25[@(:if (!) cond param:)...(:ifend:)@]%0a-%3c %25pmhlt%25[@(:if (!) cond param:)...(:else:)...(:ifend:)@]%0a-%3c %25pmhlt%25[@(:if (!) cond param:)...(:elseif (!) cond param:)...(:ifend:) @]%0a%0a%0a!!! [[#PageLists]] Pagelists%0a%0aSee [[Page lists]]%0a-%3c %25pmhlt%25[@(:searchbox label=label order=-time:) @]%0a-%3c %25pmhlt%25[@(:searchresults incl -excl group=abc fmt=def:) @]%0a-%3c %25pmhlt%25[@(:pagelist incl -excl group=abc fmt=def:) @]%0a%0a%0a!!! [[#OtherDirectives]] Other directives%0a%0aSee [[Page directives]]%0a-%3c %25pmhlt%25[@(:toc:) @] see [[Table of contents]]%0a-%3c %25pmhlt%25[@(:attachlist:)@] see [[PageDirectives#attachlist]]%0a-%3c %25pmhlt%25[@(:markup:)...(:markupend:) @] see [[PageDirectives#markup]]%0a-%3c %25pmhlt%25[@(:markup class=horiz:)...(:markupend:) @]%0a-%3c %25pmhlt%25[@(:markup class=norender:)...(:markupend:) @]%0a-%3c %25pmhlt%25[@(:markup caption='...':)...(:markupend:) @]%0a-%3c %25pmhlt%25[@(:messages:) @]%0a%0a%0a!! [[#Forms]] Forms%0a%0aSee [[PmWiki/Forms]]%0a-%3c  %25pmhlt%25[@(:input form method=get action=url enctype=multipart/form-data:) @]%0a--%3c %25pmhlt%25[@(:input default name=xyz value="abc":) @]%0a--%3c %25pmhlt%25[@(:input text name=first value="Bob" size=20:) @]%0a--%3c %25pmhlt%25[@(:input textarea name=xyz [=value=] rows=2 cols=80:) @]%0a--%3c %25pmhlt%25[@(:input submit name=post value="Go" accesskey=g:) @]%0a--%3c %25pmhlt%25[@(:input reset:) @]%0a--%3c %25pmhlt%25[@(:input hidden name=action value=edit:) @]%0a--%3c %25pmhlt%25[@(:input radio name=xyz value="abc" checked=1:) @]%0a--%3c %25pmhlt%25[@(:input checkbox name=xyz value="abc" checked=1:) @]%0a--%3c %25pmhlt%25[@(:input password name=authpw:) @]%0a--%3c %25pmhlt%25[@(:input file name=upload:) @]%0a--%3c %25pmhlt%25[@(:input image name=xyz src="https:..." alt="Alt Text":) @]%0a--%3c %25pmhlt%25[@(:input select name=xyz value="val1" label="Value 1":) @]%0a--%3c %25pmhlt%25[@(:input select name=xyz value="val2" label="Value 2":) @]%0a-%3c  %25pmhlt%25[@(:input end:) @]%0a%0aSee also [[PmWiki/Forms#pageeditcontrols|PmWiki Edit forms]].%0a%0a!! [[#WikiTrails]] Wiki trails%0a%0aSee [[Wiki trails]]%0a-%3c %25pmhlt%25[@%3c%3c|[[TrailPage]]|>>@]%0a-%3c %25pmhlt%25[@%3c|[[TrailPage]]|>@]%0a-%3c %25pmhlt%25[@^|[[TrailPage]]|^@]%0a%0a%0a!! [[#PageVariables]] Page variables%0a%0aSee [[Page variables]], [[Page text variables]], [[PmWiki/PageLists#pagetextvariables|Page lists]]%0a-%3c %25pmhlt%25[@{$variable}, {pagename$variable}, {groupname.pagename$variable} @]%0a-%3c %25pmhlt%25[@{$:variable}, {pagename$:variable}, {groupname.pagename$:variable} @]%0aSet a [[page text variable(s)]]%0a-%3c %25pmhlt%25[@(:name:description:) @] %0a-%3c %25pmhlt%25[@:name:description @] %0a-%3c %25pmhlt%25[@name:description @] %0aSee [[PmWiki:PageVariables#specialreferences | special references]]%0a-%3c %25pmhlt%25[@{*$variable} @]%0a-%3c %25pmhlt%25[@{*$:variable} @]%0a[[Page list templates]] [[PmWiki:PageListTemplates#specialreferences | special variables]]%0a-%3c %25pmhlt%25[@{=$variable}, {%3c$variable}, {>$variable}@],%0a-%3c %25pmhlt%25[@{=$:variable}, {%3c$:variable}, {>$:variable}@]%0a%0a!! [[#Internationalization]] Internationalization%0aSee [[PmWiki/Internationalizations]] and [[PmWiki/SkinTemplates]]%0a-%3c %25pmhlt%25[@$[phrase] @]%0a%0a!! [[#Expressions]] Expressions%0a%0aSee [[Markup expressions]]%0a-%3c %25pmhlt%25[@{(function arg)} @]%0a
time=1721038488
title=Markup Master Index