Quanta RefreshDoc

From KDE Wiki Sandbox
Revision as of 10:16, 24 November 2010 by Claus chr (talk | contribs)
Other languages:

Dette er en vejledning i, hvordan man holder quanta-php-documentation opdateret.

Følg denne guide skridt for skridt.

Første skridt: Installér php-documentation

Først skal du installere php-documentationspakken for din distribution.

I Ubuntu skriver du:

sudo apt-get install php-doc


Andet skridt: Download den nyeste php-documentation

Note
Hvis du gør som foreslået, så får doc-filerne brugerrettigheder. I dette tilfælde er det ikke vigtigt.


  • Gå til http://www.php.net/download-docs.php og download arkivet "Many HTML files " for dit foretrukne sprog.
  • Pak arkivet ud i din hjemmemappe, sådan at du har en mappe /home/user/html
  • Kopiér disse filer til dokumentationsmappen (i Ubuntu: /usr/share/doc/php-doc/html)
# rm -fr /usr/share/doc/php-doc/html
# mv /home/user/html /usr/share/doc/php-doc/html


  • Kør
# chmod -R o+rwx /usr/share/doc/php-doc/html


Tredje skridt: genopfrisk filen docrc, sådan at Quanta har et nyt indeks

Installér php-cli

I Ubuntu skriver du:

sudo apt-get install php-cli

Kopiér koden fra denne side og gem den i mappen quanta-doc som /usr/share/apps/quanta/doc/gendoc.php

Scriptet bruger php-XML-Reader. På grund af det kan du være nødt til at gøre nogle html-filer til gyldig XML:

  • Åbn /usr/share/apps/quanta/doc/php/index.html og /usr/share/apps/quanta/doc/php/funcref.html
  • Ret linjen
<meta http-equiv="content-type" content="text/html; charset=UTF-8">

til

<meta http-equiv="content-type" content="text/html; charset=UTF-8" />
  • cd til /usr/share/apps/quanta/doc/
  • Kør (som root)
php gendoc.php php

Dette script opdaterer php.docrc og laver php_fref.docrc.

php.docrc er den fil, som indeholder php-dolumentationens normale indeks.

php-fref.docrc er et yderligere indeks for alle sider, hvor funktioner indføres. Jeg tænkte, at det kunne være nyttigt.


Fjerde skridt: Få siderne til at se bedre ud

Det er muligt at bruge en css-fil på dokumentationen. Installér op åbn KFileReplace.

  • Klik Tilpas søg-/erstat-session
  • Skriv /usr/share/doc/php-doc/html i feltet Sted
  • Skriv *.html i Filter
  • Fjern flueben ved Inkludér undermapper
  • I Tegnsæt for filerne vælger du UTF-8
  • Skriv ikke noget i felterne Søg og Erstat
  • Klik på knappen Søg senere
  • Klik på knappen Tilføj streng i hovedvinduet
  • Aktivér Søge- og erstatningstilstand
  • I feltet Søg efter skriver du:
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
 <html>
  <head>
   <meta http-equiv="content-type" content="text/html; charset=UTF-8"


  • I feltet Erstat med skriver du:
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
 <html>
  <head>
   <link rel="stylesheet" type="text/css" href="style.css" />
   <meta http-equiv="content-type" content="text/html; charset=UTF-8"

Advarsel
Sørg for, at du ikke har et linjeskift til sidst!!


  • Klik på pilen ->.
  • Klik OK
  • Klik på knappen Erstat (ikke Simulér) i hovedvinduet.
  • Lav en fil ved navn style.css i /usr/share/doc/php-doc/html

Her kan du modificere udseendet.

Hvis du kan lide php.net's stil, så download den fra

http://www.php.net/styles/site.css

og modificér den. Du kan for eksempel gøre skriftstørrelsen mindre etc.

Held og lykke