Eclipse-ohje

• Asetusten laittaminen kuntoon
• Projektin luominen
• Projektin avaaminen
• Projektin poistaminen
• PHP-dokumentin luominen
• XHTML-dokumentin luominen
• CSS-tiedoston luominen
• PHP-koodin debuggausohjeita
• Yleisiä käyttövinkkejä
• Asetusten säilyttäminen mikroluokassa (vanha)

Seuraavassa kerrotaan ohjeita ja vinkkejä Eclipsen käyttöön PHP- ja XHTML-koodia ohjelmoitaessa.

Eclipse PDT:n ja Zend Debuggerin saa kotikoneelle osoitteesta:

http://www.zend.com/pdt

• Uusin all-in-one-versio on tällä hetkellä:

  pdt-0.7.0.S20070401-RC3_debugger-0.1.7-all-in-one-*.zip

• PHP-sivut pitää siirtää SSH-ohjelmalla users.jyu.fi-palvelimelle, kun niitä halutaan testata selaimessa, kts. julkaisuohjeet.

Yliopistolla kyseiset lisäosat on asennettu mikroluokan Ag B112.2 (Latin) koneille.

Asetusten laittaminen kuntoon

1. Jos et ole ennen laittanut Eclipsen asetuksia kuntoon PHP:tä varten, käynnistä Eclipse valinnalla Start | All Programs | Eclipse.
2. Asetetaan oletusmerkistöksi ISO-8859-1 (länsimaalainen merkistö). Muokkaa yleisasetuksia valinnalla Window | Preferences.
   • Valitse General | Content Types | Text | PHP Content Type ja kirjoita kohtaan Default Encoding ISO-8859-1. Valitse kohta XML ja tee sama operaatio.
   • Muuta General | Workspace | Text file encoding kohtaan Other: ISO-8859-1.
   • Valitse PHP | Debug ja laita kohtaan Debug Transfer Encoding ISO Latin-1.
   • Valitse Web and XML | XML Files ja kohtaan Encoding ISO Latin-1
   • Kansainvälinen UTF-8:kin käy hyvin, mutta saattaa tuottaa joillain editoreilla ja komentorivikäytössä ongelmia (esim. vanha HTML-Kit ja useimmat jalavan tekstieditoreista eivät tue UTF-8:aa).
   • XML-dokumenttien merkistö voi vaihtaa vielä jälkikäteen Eclipsessä helposti muuttamalla xml-deklaraation encoding-ominaisuuden arvoa.
3. Valitse PHP | PHP Servers... ja sitten New.
4. Lisää nimeksi users.jyu.fi ja URL-kohtaan linkki sovellukset-hakemiston juureen, esim. http://users.jyu.fi/~omatunnus/sovellukset
   • Viimeistä kauttaviivaa ei saa laittaa osoitteeseen.
5. Valitse PHP | Debug-välilehti ja valitse Default Server -kohtaan users.jyu.fi. Hyväksy muutokset.

Projektin luominen

1. Valitse File | New | Project. Valitse PHP-alavalikosta kohta PHP Project. Valitse Next.
2. Anna projektille nimeksi esim. sovellukset. Poista Use Defaults Project Contents -kentästä ja valitse workspace-hakemistoksi W:\sovellukset. Valitse Finish.
3. Napauta oikealla sovellukset-projektia Navigator-välilehdeltä (tai PHP Explorer -välilehdeltä, nimi riippuu ohjelman versiosta ja asetuksista) ja valitse New | Other.... Valitse tyhjä tekstitiedosto General-ryhmän alta. Kirjoita tiedostoon:

   AddType text/html .xml
   DirectoryIndex index.php index.xml index.html

   Tällä asetuksella saamme .xml-tiedostot näkymään Internet Explorerissa järkevästi ja määrättyä ne hakemiston indeksitiedostoiksi html- ja php-sivujen lisäksi.

4. Tallenna tiedosto sovellukset-hakemistoon nimellä .htaccess.

Projektin avaaminen

Jos omaa aiemmin luotua projektia (projektikansiota) ei näy Eclipsen avauksen jälkeen Navigator-välilehdellä (tai PHP Explorer -välilehdellä, nimi riippuu ohjelman versiosta ja asetuksista), liitä projekti siihen seuraavalla tavalla:

1. Valitse File | Import.
2. Avautuvassa ikkunassa valitse General | Existing Projects into Workspace ja paina Next.
3. Avautuvan ikkunan Select root directory -kohtaan valitse kansio, jossa projekti sijaitsee (projektikansio).
4. Kansiossa olevan projektin nimi pitäisi ilmestyä Projects-kohtaan. Valitse kyseinen projekti, jos se ei ole jo valittuna ja paina Finish.

Projektin poistaminen

Jos Navigator-välilehdellä (tai PHP Explorer -välilehdellä, nimi riippuu ohjelman versiosta ja asetuksista) näkyy turhia projekteja (ehkä muiden samaa konetta aiemmin käyttäneiden), voit poistaa ne klikkaamalla halutun projektin nimeä hiiren oikealla näppäimellä ja valitsemalla Delete. Avautuvassa ikkunassa valitse Do not delete contents ja paina OK.

PHP-dokumentin luominen

1. Tee ensin projekti (tai avaa projekti), jos sellaista ei vielä ole avattuna Eclipsessä.
2. Klikkaa Navigator-välilehdellä (tai PHP Explorer -välilehdellä, nimi riippuu ohjelman versiosta ja asetuksista) projektin nimeä (projektikansiota) hiiren oikealla näppäimellä ja valitse New | PHP File.
3. Avautuvassa ikkunassa anna tiedoston nimi. Source Folder pitäisi osoittaa jo valmiiksi projektin kansiota (/-merkki ja projektikansion nimi). Jos ei osoita, niin vaihda se oikeaksi. Kenttään ei tule siis kirjoittaa projektin koko hakemistosijaintia, vaan /-merkki ja projektikansion nimi riittää.
4. Klikkaa Finish.

XHTML-dokumentin luominen

1. Valitse Navigator-välilehdeltä (tai PHP Explorer -välilehdeltä, nimi riippuu ohjelman versiosta ja asetuksista) demo1-hakemisto (luo sellainen ellet ole jo tehnyt) oikealla hiiren näppäimellä ja valitse New | XML.
2. Valitse Create XML file from DTD file.
3. Valitse hakemisto, esim. demo1 ja laita tiedostonnimeksi index.xml.
   • Tiedoston päätteen on oltava jostain syystä .xml eivätkä muut päätteet kelpaa. Tämä ongelma on jo hoidettu Apache-asetuksilla.
4. Valitse DTD-valintasivulla Select XML Catalog entry ja sieltä valinta XHTML 1.0 Strict. Siirry seuraavaan kohtaan ja valitse siellä suoraan Finish.
5. Valitse Source-välilehti, niin pääset muokkaamaan lähdekoodia.

CSS-tiedoston luominen

1. Napauta hakemistoa oikealla ja valitse New | CSS.
2. Anna tiedoston nimi.

PHP-koodin debuggausohjeita

• Syntaksivirheiden etsintä Problems-välilehdellä (dokumentti pitää ensin tallentaa, toimii PHP-, XHTML- ja CSS-koodeissa)
• Koodin täydennös (Ctrl+Välilyönti, toimii PHP-, XHTML- ja CSS-koodeissa)
• Breakpointin asettaminen (oikea hiiren näppäin -> Toggle Breakpoints)
• Debuggaus (oikea hiiren näppäin -> Debug As -> PHP Script):
  • F6-näppäimellä pääsee koodissa eteenpäin rivin kerrallaan.
  • Debug Output -välilehti näyttää, mitä XHTML-koodia syntyy.
  • Browser Output -välilehti näyttää, miltä syntynyt XHTML-sivu näyttää todellisuudessa.
  • Variables-välilehti näyttää muuttujien reaaliaikaiset arvot
  • Takaisin "päänäyttöön" pääsee oikean yläkulman väkäsen takaa löytyvällä PHP-painikkeella
• Sivun "ajaminen" (oikea hiiren näppäin -> Run As -> PHP Web Page)

Yleisiä käyttövinkkejä

• Kirjoittamalla < -merkin saa yleensä elementtivaihtoehtoja, jotka sopivat kontekstiin. Elementin lopputunniste täydentyy myös automaattisesti.
  • XHTML-dokumentin alussa on tyhjä body merkittynä yksiosaisesti <body />. Poista kauttaviiva ja kirjoita <-merkki niin saat myös lopputunnisteen.
• Ctrl-space-näppäinyhdistelmällä saa myös vaihtoehdot esiin. Tästä on hyötyä esimerkiksi attribuutteja kirjoitettaessa.
  • Ctrl-space toimii kätevänä muistilistana myös CSS-tiedostojen kirjoittamisessa, jos jokin ominaisuus tai arvo on hukassa.
• Outline-ikkunasta näkyy kätevästi dokumentin puurakenne.
• Problems-välilehdeltä löytyvät dokumentin (lähes) reaaliaikaiset validointitulokset.
• Sisennykset saa tehtyä napauttamalla johonkin kohtaan lähdekoodia oikealla ja valitsemalla Format | Document.
  • Sisennyksiä saa säädettyä General | Editors | Text Editors | Displayed tab width ja Window | Preferences | Web and XML | XML files | XML Source | Formatting.

Asetusten säilyttäminen mikroluokassa (vanha)

Tämä osio koski vanhaa Eclipse-asennusta, uudessa asennuksessa asetuksien pitäisi säilyä automaattisesti.

Oletuksena Eclipsen asetukset tallentuvat mikroluokassa koneiden C-asemalle, eivätkä ne siten ole käyttäjäkohtaiset. Tekemällä Eclipselle pikakuvakkeen työpöydälle (tallentuu käyttäjäprofiiliin) kierrämme tämän ongelman. Toimi seuraavien ohjeiden mukaisesti:

1. Avaa Eclipse normaalisti Start-valikon kautta ja säädä asetukset kuntoon yllä olevien ohjeiden mukaisesti. Sulje sen jälkeen Eclipse.
2. Kopioi hakemiston "C:\Documents and Settings\omatunnus\Local Settings\Application Data\eclipse" sisältö hakemistoon "U:\config\eclipse" (luo U:-asemalle hakemistot tarvittaessa).
3. Tee työpöydälle pikakuvake, jonka Target-kohtaan laita "C:\Program Files\eclipse\eclipse.exe" -data "W:\sovellukset" -configuration "U:\config\eclipse" (myös lainausmerkit) ja Start in -kohtaan "C:\Program Files\eclipse".
   • Optiot -data ja -configuration säätävät siis workspacen ja konfiguraatiohakemiston sijainnit. Ne voivat olla muitakin hakemistoja kuin edellä mainitut, kunhan optio -data on W:-asemalla ja optio -configuration U:-asemalla. Optio -configuration tulee olla sama, mihin kohdassa kaksi kopioit Eclipsen asetukset.
4. Kokeile käynnistää Eclipse pikakuvakkeesta. Jos asetukset eivät ole säilyneet, niin käy vielä kertaalleen tekemässä asetusmuutokset. Hyväksy uudet asetukset ja sulje Eclipse. Nyt asetuksien pitäisi olla jatkossakin kunnossa.

Käynnistä Eclipse jatkossa aina mikroluokassa työskennellessäsi työpöydälle luomastasi pikakuvakkeesta, eikä Start-valikon kautta. Näin tekemäsi asetukset säilyvät, eikä niitä tarvitse laittaa aina uudelleen kuntoon.

HUOM! Työhakemistoa EI kannata muuttaa työskennellessä mikroluokan koneilla (ÄLÄ siis valitse File | Switch Workspace). Se ainoastaan kadottaisi jo laitetut asetukset. Vaikka työhakemisto onkin esimerkiksi W:\sovellukset\, voi projekteja tallentaa muuallekin W-asemalle (tai muille asemille).