Browser Tutorial Development (en) Browser - TYPO3 without PHP

Transcription

1 Browser Tutorial Development (en) Browser - TYPO3 without PHP Develop the Browser - the TYPO3-Frontend-Engine. This is a manual, how to use the SVN-Repository. Version: Extension Key: browser_tut_development_en Language: en Keywords: browser, typo3 without php, development, svn Copyright , Dirk Wildt, Die Netzmacher, < This document is published under the Open Content License available from The content of this document is related to TYPO3 - a GNU/GPL CMS/Framework available from 1

2 Table of Contents Browser Tutorial Development (en)... 1 Introduction... 3 What does it do?... 3 The Browser and SVN... 4 Repository URL... 4 Download / checkout of the Browser... 4 Update your Browser version... 4 Upload / commit the Browser... 4 The first time initial check out... 4 Resolve a conflict and other problems... 5 Branches... 6 Tags... 6 Update extensions without TYPO TYPO3 Extension Utils Upload extension... 7 Help... 7 DRS - Development Reporting System... 8 Develop the DRS and gets support for yourself... 8 dev_var_dump... 9 Prompting for my IP only... 9 Minify *.css and *.js Precondition Samples Reference Completely browser reference Further Information Tutorials Forum SVN Helpful suggestions Change log Illustration Index Alphabetical Index

3 Introduction What does it do? This is a tutorial for the extension Browser (extkey: browser). It is a manual for developing the browser especially how to use the SVN repository on forge.typo3.org 3

4 The Browser and SVN Repository URL Download / checkout of the Browser $ cd typo3conf/ext/ $ svn co browser If you are need an initial checkout, please take a look in the section "The first time initial check out" on page 4 below. Update your Browser version $ svn update U foo.c U bar.c Updated to revision 2. $ Upload / commit the Browser First you have to checkout the Browser (see above). Comment $ cd typo3conf/ext/browser $ svn add * $ svn st $ svn commit m 'my comment' ChangeLog ext_conf_template.txt ext_emconf.php lib/class.tx_browser_extmanager.php lib/locallang.xml pi1/class.tx_browser_pi1.php pi1/class.tx_browser_pi1_filter.php pi1/class.tx_browser_pi1_marker.php pi1/class.tx_browser_pi1_template.php pi1/class.tx_browser_pi1_views.php pi1/class.tx_browser_pi1_wrapper.php pi1/class.tx_browser_pi1_zz.php static/setup.txt Übertrage Daten... Revision übertragen. svn add *: add all (new and changed) files to your local svn index svn st: display your local svn index svn commit: commit / upload your changings The first time initial check out If you have a local version of the browser but without any SVN folder, you can initiate a local SVN version this way: $ mv browser browser.bak $ svn co browser $ mv u browser.bak/* browser $ cd browser $ svn add * 4

5 Resolve a conflict and other problems Sometimes there is a conflict between the files of your working directory and the files in the repository. Maybe you can resolve the conflict with the following steps... is out of date You try to commit your files, and there is an conflict, you will get a message like: Example Item '/org/trunk/res/html/doc' is out of date [dwildt@localhost org]$ svn commit m '2.0.9 mv document module to download module' Anmeldebereich: < TYPO3 SVN Access Passwort für»dwildt«: ChangeLog... Ersetze res/html/doc svn: Übertragen schlug fehl (Details folgen): svn: Item '/org/trunk/res/html/doc' is out of date Step 1: Update Make a update. Example [dwildt@localhost org]$ svn update C static/doc C res/html/doc Revision Konfliktübersicht: Baumkonflikte: 2 Step 2: Resolve the conflict Try to resolve the conflict like in the example below. Take the parameter: base if the repository is the proper version working if your working directory is the proper version Example [dwildt@localhost org]$ svn resolve accept=working org/org/res/html/doc Konflikt von»org/org/res/html/doc«aufgelöst Step 3: Commit your files Now commit your files again.... version control Example $ svn add res/e payment/ svn: warnung:»res/e payment«befindet sich bereits unter Versionskontrolle Solutions $ svn revert res/e payment/ Rückgängig gemacht:»res/e payment«$ svn revert depth infinity res/e payment/ Rückgängig gemacht:»res/e payment«5

6 Hard Core Resolving Remove the SVN management $ mv deal deal.bak $ cd deal.bak $ find. name ".svn" print xargs /bin/rm Rf Another Initial Checkout Next step see "The first time initial check out" on page 4 above. Branches Englisch German New If you have a local version of the browser but without any SVN folder, you can initiate a local SVN version this way: $ mv browser browser.bak $ svn co browser $ cd browser... Tags Add a tag $ svn copy \ \ m "Release " Delete a tag $ svn delete \ m "4.5.0 is deprecated" 6

7 Update extensions without TYPO3 TYPO3 Extension Utils Upload extension upload username password introductionplus "1.2.0 Feature detachable multi columns menu, bugfix chrome and IE" /var/www/typo3_62.local/typo3conf/ext/introductionplus Result in case of success array(3) { ["resultcode"]=> string(5) "10504" ["resultmessages"]=> array(1) { [0]=> string(118) "Please note that it might take a while (up to an hour) until your extension and the documentation appear on TYPO3.org." } ["version"]=> string(5) "1.2.0" } Help root@gera:/opt/scripts/typo3#./t3xutils.phar Usage:./t3xutils.phar help./t3xutils.phar version./t3xutils.phar updateinfo./t3xutils.phar info <extensionkey> [<version>]./t3xutils.phar fetch <extensionkey> [<version>] [<destinationpath>]./t3xutils.phar upload <typo3.org username> <typo3.org password> <extensionkey> "<uploadcomment>" <pathtoextension>./t3xutils.phar extract <t3x file> <destinationpath>./t3xutils.phar listfiles <t3x file> [details]./t3xutils.phar create <extensionkey> <sourcepath> <t3x file>./t3xutils.phar checkforupdate./t3xutils.phar selfupdate 7

8 DRS - Development Reporting System Develop the DRS and gets support for yourself... 8

9 dev_var_dump Prompting for my IP only dev_var_dump enables you to prompt content into the frontend, which will displayed for a visitor with your IP only. Characteristics The Browser has an own var_dump method for developing. It is similar to var_dump: but it prompts the given content into the frontend It checks weather the current IP is in the list of the allowed IPs (configurable by the extension manager). If the current IP isn't proper, dev_var_dump will return nothing. dev_var_dump wraps the content with <pre>...</pre> If you prompt an array, you will have a tree view. dev_var_dump reports a security warning to devlog. Parameters Content for prompting. Type is mixed. Amount of parameters is unlimited. PHP snippet $my_prompt = array('hello world', array( 'green', 'red' ) ); $my_other_prompt = array('hallo Welt', array( 'gruen', 'rot' ) ); $this >pobj >dev_var_dump( $my_prompt, $my_other_prompt ); Result <pre>tx_browser_pi1_sql::init (line 119): type: array array ( 0 => 'Hello world', 1 => array ( 0 => 'green', 1 => 'red', ), )... </pre> 9

10 Minify *.css and *.js Precondition Intalled JavaScript/CSS minifier yui-compressor Samples Sample directory $ tree L 1. jquery map tx_browser_pi1_ajax js tx_browser_pi1_ajax_languages.js tx_browser_pi1.js Minify a *.js-file $ java jar /usr/share/yui compressor/yui compressor.jar type js v tx_browser_pi1.js o 'tx_browser_pi1 min.js' $ tree L 1. all min.js jquery map tx_browser_pi1_ajax js tx_browser_pi1_ajax_languages.js tx_browser_pi1.js Minify all *.js-files $ java jar /usr/share/yui compressor/yui compressor.jar type js v *.js o '.js$: min.js' $ tree L 1. all min.js jquery map tx_browser_pi1_ajax js tx_browser_pi1_ajax_languages.js tx_browser_pi1.js Minify and merge all *.js-files $ java jar /usr/share/yui compressor/yui compressor.jar type js v *.js o 'all min.js' $ tree L 1. all min.js jquery map tx_browser_pi1_ajax js tx_browser_pi1_ajax_languages.js tx_browser_pi1.js 10

11 Reference Completely browser reference HTML PDF: 11

12 Further Information Tutorials This tutorial in PDF format You find this tutorial as a PDF file at doc/manual.pdf Tutorial Overview Forum The Browser has its own forum (leading language is German). You are welcome to post any question, bug or snippet code at SVN TYPO3-Frontend-Engine Browser: Forum SVN book English German Illustration 1: The TYPO3-Frontend-Engine Browser Forum Quickstart Basic Work Cycle Reference 12

13 Helpful suggestions If you have helpful suggestions, feel free to publish any question, bug or code snippet on Posts are welcome in English and German. 13

14 Change log Update for Browser Initial release 14

15 Illustration Index Illustration 1: The TYPO3-Frontend-Engine Browser Forum

16 Alphabetical Index 16