Hjælp: fremhævelse af syntaks

Syntaks fremhæve ( "Syntaks fremhævning") er en udvidelse af den MediaWiki -softwaren til visning program kildetekster på Wiki-sider. Kildeteksterne vises i farver i henhold til deres syntaks. ^[1]

syntaks

Grundlæggende syntaks til oprettelse af kildetekster:

 <syntax highlight lang = "php">
<? php
  ekko "Hej verden!";
?>
</syntaxhighlight>

Produktion:

 <? php
  ekko "Hej verden!" ;
?>

Der er også specifikation af valgfrie parametre .

Kopier skabelon

 <syntax highlight lang = "">
</syntaxhighlight>

<kilde>

Først hed elementet <source> ; indtil 2009 var dette den foretrukne dag. Efter at et multimedieelement med samme navn blev introduceret i HTML5 , blev præferencen byttet. Fordi <source> i det viste HTML-eksempel, bør kun den kollisionsfrie <syntaxhighlight> bruges. Det tyske sprog Wikipedia har elimineret <source> i årevis. Fra 2020 elimineres dette element helt.

parameter

Specifikationen af lang er en obligatorisk parameter. Der er også valgfrit:

inline

<syntaxhighlight lang="css" inline >

Dette gør det muligt at generere formateret computerkode i et afsnit. Eksempel: "Dette er en test for at vise, at for eksempel CSS kode table { display : none ;} . Kan vises inline"

highlight

<syntaxhighlight lang="php" highlight= "1,3-5,8" line>

Linje 1, 3 til 5 og 8 er markeret med lysegul.

 <? php
ekko "Hej verden!" ;
ekko "Hej verden!" ;
ekko "Hej verden!" ;
ekko "Hej verden!" ;
ekko "Hej verden!" ;
ekko "Hej verden!" ;
?>

line

<syntaxhighlight lang="php" line >

Linjerne nummereres fortløbende.

 <? php
ekko "Hej verden!" ;
ekko "Hej verden!" ;
ekko "Hej verden!" ;
ekko "Hej verden!" ;
ekko "Hej verden!" ;
ekko "Hej verden!" ;
?>

GeSHi -funktionaliteten til at markere hvert femte linjenummer var endnu ikke blevet gendannet i 2016.

start

<syntaxhighlight lang="php" start= "10" line>

Linjerne nummereres fortløbende, linjetællingen starter ved 10.

 <? php
ekko "Hej verden!" ;
?>

Kan ikke bruges sammen med highlight .

style

<syntaxhighlight style= "margin-left: 6em;" lang="html4strict">

Standardattribut i HTML .

• Eksempel: Her for at 6em en hel blok med 6em henhold til konteksten:

 <syntax highlight style = "margin-left: 6em;" lang = "html4strict">

enclose

<syntaxhighlight enclose="none" lang="css">

Forældet parameter, der som enclose="none" præcist svarede til inline .

enclose= kunne antage andre værdier (f.eks. "div" ), der ikke længere er relevante i dag.

strict

Med opgaven strict="1" kunne den underliggende software instrueres i at fortolke programmeringssproget i henhold til standarden, hvis en separat definition er tilgængelig for det. Dette er dog sandsynligvis ikke længere effektivt under pygmenter.

Sprog

Understøttede sprog

Følgende sprog understøttes af denne udvidelse (uddrag): ^{[2] [3]}

I øjeblikket ikke understøttet under pygmenter

Følgende koder eksisterede med GeSHi, men ikke længere med pygmenter siden sommeren 2015:

Justeringer

Enkeltbrug

Den aktuelle integration kan justeres ved hjælp af parameteren style= såsom en ramme eller indrykning.

• Siden midten af ​​2012 ^[4] er blokkene ikke længere indsat som <div> , men (hvis de ikke er markeret med inline ) som <pre> med standardrammen her.
  • Dette er nyttigt for en blok med flere linjer; men hvis du kun har en eller to linjer, kan dette være irriterende.
  • style="border: none; padding: 0;"
    reducerer dekorationen så meget som muligt.
• Linjeskift har været tilladt i inline -stil (og generelt) siden 2015; det indrammede felt er imidlertid ikke egnet til at blive fordelt over flere linjer, og især med montagesprog kan det være meget irriterende at montere længere linjer i den aktuelle skærmbredde.
  • style="white-space:nowrap" forhindrer det.

Siden midten af ​​2015 er kun elementerne <pre> og <code> blevet leveret.

bruger

For brugerspecifikke justeringer se Skin / CSS .

• Et interessant træk blandt pygmenter ; men kan være meget udmattende - følgende CSS -sekvens gør opmærksom på syntaksfejl:

 . mw fremhævning . fejle {
   kant : # FF0000 1 px fast ;
}

Mediawiki

Følgende vil blive justeret ensartet på verdensplan:

• modules / pygments.generated.css - Dekoration af de enkelte syntakskonstruktioner (kommentar, operator, tegnstreng osv.)
• modules / pygments.wrapper.css - Repræsentation af koden i konteksten af wikisiden (indrykning, fremhævelse)

Efter dette eksempel kan brugerne lade deres egne vaner fungere.

Skabelonprogrammering

Når du #tag: skabeloner med #tag: skal du være opmærksom på rækkefølgen af ​​parametrene. Indholdet skal sendes som den første parameter. Derefter kan oplysningerne om sproget og det vedlagte HTML -tag laves. Derudover må der ikke være linjeskift mellem de enkelte parametre.

{{#tag:syntaxhighlight|{{{code}}}|lang={{#if:{{{language|}}}|{{{language}}}|diff}}}}

En skabelon designet på denne måde kan derefter bruges med parametrene

 {{Skabelonnavn
| sprog =
| kode =
}}

blive kaldt. Der henvises til patch -skabelonen som et eksempel på en sådan anvendelse.

Det skal også bemærkes, at code parameter selv ikke må direkte indeholde en pibe karakter (som altid i skabelon -programmering ), skal dette erstattes af et {{!}} ( Eksempel ).

Koden kan også inkluderes fra en komplet side:

{{#tag:syntaxhighlight | {{Modul:Hello}} | lang=lua}}

forsyninger

 lokal p = {} 
funktion s . hej ( ramme )
    lokalt navn = ramme . args [ 1 ]
    hvis ikke navn så 
        name = 'verden' 
    ende
    returner 'Hej,' .. navn .. '! Dette er Lua! ' 
ende 
vende tilbage s

vedligeholdelse

Sider med ukendt sprogkode eller andre ugyldige værdier er angivet i kategorien: Wikipedia: Side med fejl i syntaksfremhævning .

De er defineret via MediaWiki: Syntaxhighlight-error-category , MediaWiki: Syntaxhighlight-source-category og MediaWiki: Syntaxhighlight-enclose-category .

GeSHi

GeSHi -pakken blev brugt indtil den 25. juni 2015 og pygmenter siden da.

For ikke at skulle ændre alle stier og definitioner og identifikatorer kaldes udvidelsen stadig "GeSHi", og identifikatorer beholder denne del af navnet.

Ændringen blev nødvendig, fordi GeSHi ikke længere havde opstrøms vedligeholdelse og pleje.

Yderligere Information

MediaWiki: Extension: SyntaxHighlight GeSHi - Gratis Wiki -software

Phabricator - Workboard: #syntaxhighlight

• Hjælp: Syntaksfremhævning / VisualEditor - Beskrivelse af, hvordan syntakskodeblokke kan indsættes eller redigeres med VisualEditor .

Lister over understøttede sprog (engelsk)

• mw: Extension: SyntaxHighlight GeSHi #Supporterede sprog
  • pygment -id'er (PHP)
    • MW -alias (PHP)
• pygments.org

Ekstern

• pygments.org

Bemærkninger

1. ↑ Hvis du har valgt indstillingen Vis forhåndsvisning uden at genindlæse siden i dine indstillinger, vises syntaksfremhævningen ikke i forhåndsvisningen af ​​en side. Det skal derefter gemmes for at være synligt.
2. ↑ Den aktuelle liste er altid med den originale dokumentation
3. ↑ Med dialekter og varianter opnås normalt den samme optiske effekt med modersproget.
4. ↑ phab: T21416 ( Bugzilla: 19416 ) , rev: 113190