Quanta RefreshDoc: Difference between revisions

    From KDE UserBase Wiki
    No edit summary
    (Tweaked formatting of displayed Input)
     
    (5 intermediate revisions by 2 users not shown)
    Line 1: Line 1:
    =This is a tutorial howto get the quanta-php-documentation up-to-date.=
    <languages />
    <translate>
    ==This is a tutorial howto get the quanta-php-documentation up-to-date.== <!--T:1-->


    <!--T:2-->
    Please follow the step-by-step guide.
    Please follow the step-by-step guide.


    == First: Install php-documentation ==
    === First: Install php-documentation === <!--T:3-->
    First, you have to install the php-documentation packet for your Distribution.
    First, you have to install the php-documentation packet for your Distribution.


    <!--T:4-->
    In Ubuntu, type:
    In Ubuntu, type:
    $ sudo apt-get install php-doc
    {{Input|1= sudo apt-get install php-doc}}


    == Second: Download newest php-documentation ==
    Visit http://www.php.net/download-docs.php and download the "Many HTML files  "-archive for your prefered language.


    Enzip that package into your home-directory, so you have a directory /home/user/html
    === Second: Download newest php-documentation === <!--T:5-->


    Copy these files into the doc-dir. (in Ubuntu: /usr/share/doc/php-doc/html)
    <!--T:6-->
    # rm -fr /usr/share/doc/php-doc/html
    {{Note|1= If you do as proposed, the doc-files will have user-rights. In this case that is not important.}}
    # mv /home/user/html /usr/share/doc/php-doc/html


    Please notice, that if you do as proposed, the doc-files will have user-rights. I don't care about that. Execute
    <!--T:7-->
    # chmod -R o+rwx /usr/share/doc/php-doc/html
    * Visit http://www.php.net/download-docs.php and download the "Many HTML files  "-archive for your prefered language.
    * Extract that package into your home-directory, so you have a directory /home/user/html
    * Copy these files into the doc-dir. (in Ubuntu: /usr/share/doc/php-doc/html)<br />
    {{Input|1= # rm -fr /usr/share/doc/php-doc/html
    # mv /home/user/html /usr/share/doc/php-doc/html}}<br />
    * Execute
    {{Input|1= # chmod -R o+rwx /usr/share/doc/php-doc/html}}


    == Third: refresh docrc-file, so that Quanta has a new index ==


    Install php-cli
    === Third: refresh docrc-file, so that Quanta has a new index === <!--T:8-->


    <!--T:9-->
    Install '''php-cli'''
    <!--T:10-->
    In Ubuntu, type:
    In Ubuntu, type:
    $ sudo apt-get install php-cli
    {{Input|1=sudo apt-get install php-cli}}


    Copy the code from this page:
    <!--T:11-->
    [[Quanta_RefreshDoc_script]]
    Copy the code from [[Quanta_RefreshDoc_script|this page]] and save it into the quanta-doc dir as /usr/share/apps/quanta/doc/gendoc.php


    Save it into the quanta-doc dir as
    <!--T:12-->
    /usr/share/apps/quanta/doc/gendoc.php
    The script uses the '''php-XML-Reader'''. Because of that you have to make some html-files XML-valid:
     
    * Open /usr/share/apps/quanta/doc/php/index.html and /usr/share/apps/quanta/doc/php/funcref.html
    The script uses the php-XML-Reader. Because of that you have to make some html-files XML-valid:
    * Change the line
    Open /usr/share/apps/quanta/doc/php/index.html and /usr/share/apps/quanta/doc/php/funcref.html
    {{Input|1=<meta http-equiv="content-type" content=<nowiki>"text/html; charset=UTF-8"</nowiki>>}}
    Change the line
      <meta http-equiv="content-type" content="text/html; charset=UTF-8">
    into
    into
      <meta http-equiv="content-type" content="text/html; charset=UTF-8" />
    {{Input|1=<meta http-equiv="content-type" content=<nowiki>"text/html; charset=UTF-8"</nowiki> />}}
     
    * cd into /usr/share/apps/quanta/doc/
     
    * Execute (as root)
    cd into /usr/share/apps/quanta/doc/
    {{Input|1=php gendoc.php php}}
     
    Execute (as root)
    # php gendoc.php php
     
    That script will update php.docrc and create php_fref.docrc.
     
    php.docrc is the file for the normal index of the php-documentation.
     
    php-fref.docrc is an additional index file for all pages, functions are listed in. I thought, it could be convenient.
     
    == Fourth: Optional: Get better look&feel for the pages ==
    It's possible to use a css-file on the documentation. Install and open KFileReplace.
     
    Klick "Customize Search/Replace Session"


    Change Location to /usr/share/doc/php-doc/html
    <!--T:13-->
    That script will update '''php.docrc''' and create '''php_fref.docrc'''.


    Set Filter to    *.html
    <!--T:14-->
    '''php.docrc''' is the file for the normal index of the php-documentation.


    Disable including subfolders
    <!--T:15-->
    '''php-fref.docrc''' is an additional index file for all pages, functions are listed in it. I thought it could be convenient.


    Set Encoding to utf8


    Don't type anything in Search or Replace
    === Fourth: Optional: Get better look-and-feel for the pages === <!--T:16-->


    Click "Search Later"
    <!--T:17-->
    It's possible to use a css-file on the documentation. Install and open '''KFileReplace'''.


    Click on "Add string"-Button in main window
    <!--T:18-->
     
    * Click <menuchoice>Customize Search/Replace Session</menuchoice>
    Activate Search and replace-mode
    * Change <menuchoice>Location</menuchoice> to /usr/share/doc/php-doc/html
     
    * Set <menuchoice>Filter</menuchoice> to    *.html
    Search for:
    * Disable including subfolders
    <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
    * Set <menuchoice>Encoding</menuchoice> to utf8
    * Don't type anything in <menuchoice>Search</menuchoice> or <menuchoice>Replace</menuchoice>
    * Click <menuchoice>Search Later</menuchoice>
    * Click on the <menuchoice>Add string</menuchoice> Button in main window
    * Activate <menuchoice>Search and replace</menuchoice> mode
    * <menuchoice>Search</menuchoice> for:
    {{Input|1= <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" <nowiki>"http://www.w3.org/TR/html4/loose.dtd"</nowiki>>
      <html>
      <html>
       <head>
       <head>
       <meta http-equiv="content-type" content="text/html; charset=UTF-8"
       <meta http-equiv="content-type" content="text/html; charset=UTF-8"}}<br />
     
    * <menuchoice>Replace</menuchoice> with:
    Replace with:
    {{Input|1= <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" <nowiki>"http://www.w3.org/TR/html4/loose.dtd"</nowiki>>
    <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
      <html>
      <html>
       <head>
       <head>
       <link rel="stylesheet" type="text/css" href="style.css" />
       <link rel="stylesheet" type="text/css" href="style.css" />
       <meta http-equiv="content-type" content="text/html; charset=UTF-8"
       <meta http-equiv="content-type" content="text/html; charset=UTF-8"}}


    Be shure that you don't have a newline at the end!
    <!--T:19-->
     
    {{Warning|1=Make sure that you don't have a newline at the end!}}
    Click on the -> arrow.
    * Click on the <menuchoice>-> arrow</menuchoice>.
     
    * Click <menuchoice>OK</menuchoice>
    Click OK
    * Click on the <menuchoice>Replace</menuchoice> Button (not <menuchoice>Simulate</menuchoice>) in the main window.
     
    * Create a style.css-File in /usr/share/doc/php-doc/html
    Click on the "Replace"-Button (not simulate) in the main window.
     
    Create a style.css-File in /usr/share/doc/php-doc/html


    <!--T:20-->
    Here you could modify the appearance.
    Here you could modify the appearance.


    <!--T:21-->
    If you like the php.net-style, download it from  
    If you like the php.net-style, download it from  
      http://www.php.net/styles/site.css
      http://www.php.net/styles/site.css
    and modify it. Maybe you want to make the font-size smaller etc.


    and modify it. Maybe you wants to make the font-size smaller etc.
    <!--T:22-->
     
    Good luck
    Good luck


    <!--T:23-->
    [[Category:Development]]
    [[Category:Development]]
    [[Category:Tutorials]]
    </translate>

    Latest revision as of 08:25, 14 November 2010

    Other languages:

    This is a tutorial howto get the quanta-php-documentation up-to-date.

    Please follow the step-by-step guide.

    First: Install php-documentation

    First, you have to install the php-documentation packet for your Distribution.

    In Ubuntu, type:

    sudo apt-get install php-doc


    Second: Download newest php-documentation

    Note

    If you do as proposed, the doc-files will have user-rights. In this case that is not important.


    • Visit http://www.php.net/download-docs.php and download the "Many HTML files "-archive for your prefered language.
    • Extract that package into your home-directory, so you have a directory /home/user/html
    • Copy these files into the doc-dir. (in 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


    • Execute
    # chmod -R o+rwx /usr/share/doc/php-doc/html


    Third: refresh docrc-file, so that Quanta has a new index

    Install php-cli

    In Ubuntu, type:

    sudo apt-get install php-cli

    Copy the code from this page and save it into the quanta-doc dir as /usr/share/apps/quanta/doc/gendoc.php

    The script uses the php-XML-Reader. Because of that you have to make some html-files XML-valid:

    • Open /usr/share/apps/quanta/doc/php/index.html and /usr/share/apps/quanta/doc/php/funcref.html
    • Change the line
    <meta http-equiv="content-type" content="text/html; charset=UTF-8">

    into

    <meta http-equiv="content-type" content="text/html; charset=UTF-8" />
    • cd into /usr/share/apps/quanta/doc/
    • Execute (as root)
    php gendoc.php php

    That script will update php.docrc and create php_fref.docrc.

    php.docrc is the file for the normal index of the php-documentation.

    php-fref.docrc is an additional index file for all pages, functions are listed in it. I thought it could be convenient.


    Fourth: Optional: Get better look-and-feel for the pages

    It's possible to use a css-file on the documentation. Install and open KFileReplace.

    • Click Customize Search/Replace Session
    • Change Location to /usr/share/doc/php-doc/html
    • Set Filter to *.html
    • Disable including subfolders
    • Set Encoding to utf8
    • Don't type anything in Search or Replace
    • Click Search Later
    • Click on the Add string Button in main window
    • Activate Search and replace mode
    • Search for:
    <!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"


    • Replace with:
    <!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"

    Warning

    Make sure that you don't have a newline at the end!
    • Click on the -> arrow.
    • Click OK
    • Click on the Replace Button (not Simulate) in the main window.
    • Create a style.css-File in /usr/share/doc/php-doc/html

    Here you could modify the appearance.

    If you like the php.net-style, download it from

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

    and modify it. Maybe you want to make the font-size smaller etc.

    Good luck