Difference: LahdekoodinUpottaminen (r10 vs. r9)

Tekninen dokumentointi TUTWikillä

Lähdekoodin upottaminen

Lähdekoodin upottaminen wiki-sivulle on erityisen kätevää silloin, kun wikiä haluaa käyttää mm. esimerkkien tuomiseen wiki-sivulle. Lähdekoodin upotus pitää huolen siitä, että käytetty kieli korostetaan oikein sen syntaksin mukaan. Myös rivinumerointi tuotetaan automaattisesti siten, että koodin voi tarvittaessa helposti kopioida leikepöydän kautta eteenpäin. Lähdekoodin upottaminen on toteutettu DpSyntaxHighlighter-laajennuksen avulla.

Lähdekoodi upotetaan wiki-sivulle seuraavalla syntaksilla:

%CODE{lang="kieli"}%
...
%ENDCODE%

Vinkki: Lähdekoodin upottaminen kannattaa aina tehdä raaka muokkaus tai wiki text tilassa.

Esimerkki 1: HTML-merkkauksen JavaScript-lähdekoodin liittäminen sivulle

%CODE{lang="html"}%   Hei Maailma!   

Hei Maailma!

%CODE{lang="javascript"}% function popup() { var item = document.getElementById('item'); alert('Item=' + item); return false; } %ENDCODE%
<html> <head> <title>Hei Maailma!</title> </head> <body> <h1>Hei Maailma!</h1> </body> </html> 
function popup() {
   var item = document.getElementById('item');
   alert('Item=' + item);
   return false;
} 

Vinkki: Ympäröi lähdekoodi <sticky>-tageilla. Muussa tapauksessa HTML-muokkaustilan käyttö rikkoo lähdekoodin rivinvaihdot!

Esimerkki 2: HTML-merkkauksen liittäminen sivulle

%CODE{lang="html"}%
html>
   <head>
      <title>Hei Maailma!</title>
   </head>
   <body>
      <h1>Hei Maailma!</h1>
   </body>
</html>
%ENDCODE%
<html>
  <head>
    <title>Hei Maailma!</title>
  </head>
  <body>
    <h1>Hei Maailma!</h1>
  </body>
</html>

Vinkki: HTML:n upottaminen lähdekoodina voi toisinaan aiheuttaa sen, että wiki yrittää lähdekoodin sijaan näyttää itse HTML-merkkauksen. Jos näin käy, käytä HTML-lähdekoodissa pakomerkkejä. Erityisesti vasen kulmasulku ( >) merkitään > ja oikea kulmasulku ( <) merkitään <.

Esimerkki 2: JavaScript-lähdekoodin liittäminen

%CODE{lang="javascript"}%
function popup() {
  var item = document.getElementById('item');
  alert('Item=' + item);
  return false;
}
%ENDCODE%
function popup() { var item = document.getElementById('item'); alert('Item=' + item); return false; } 

 
Copyright © by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Ideas, requests, problems regarding TUTWiki? Send feedback