DEPRECATION WARNING

This documentation is not using the current rendering mechanism and is probably outdated. The extension maintainer should switch to the new system. Details on how to use the rendering mechanism can be found here.

EXT: Show Code Snippets¶

Created:	2010-02-18T17:33:18
Changed by:	Alex Kellner
Changed:	2011-09-09T17:00:27.410000000
Classification:	in2snippets
Keywords:	snippets
Author:	David Richter
Email:	david.richter@in2code.de
Info 4:
Language:	en

EXT: Show Code Snippets - in2snippets

EXT: Show Code Snippets¶

Extension Key: in2snippets

Language: en

Keywords: snippets

This document is published under the Open Content License

available from http://www.opencontent.org/opl.shtml

The content of this document is related to TYPO3

- a GNU/GPL CMS/Framework available from www.typo3.org

Table of Contents¶

EXT: Show Code Snippets 1

Extension Key: in2snippets 1

Language: en 1

Keywords: snippets 1

This document is published under the Open Content License 1

available from http://www.opencontent.org/opl.shtml 1

The content of this document is related to TYPO3 1

- a GNU/GPL CMS/Framework available from www.typo3.org1

`Introduction 3 <#__RefHeading__2286_832525242>`_

What does it do? 3

Who is responsible for in2facebook? 3

The in2code team offers creates this extension for the TYPO3 community 3

Visit us on http://www.in2code.de 3

Screenshots 4

`Installation 6 <#__RefHeading__2300_832525242>`_

Quickstart 6

Step by Step 7

`Configuration 8 <#__RefHeading__2306_832525242>`_

TypoScript 8

`Administration 10 <#__RefHeading__2310_832525242>`_

FAQ 10

We're sorry. Manual will be updated soon! 10

`Known problems 11 <#__RefHeading__2314_832525242>`_

`To-Do list 12 <#__RefHeading__2316_832525242>`_

Adding snippets in the frontend 12

It's up to you to give us some feedback! 12

Are there any further feature requests or bugs? Write us an email... See www.in2code.de 12

`Additional links 13 <#__RefHeading__2322_832525242>`_

You can use one of the following links, to get more information about this plugin: 13

Company which created this plugin: http://www.in2code.de 13

Do you need help with this plugin: http://www.typo3.net 13

Don't miss the best TYPO3 blogging page: http://www.typo3blogger.de 13

`ChangeLog 14 <#__RefHeading__2326_832525242>`_

0.1.0 14

2011-09-09 14

alpha 14

Initial upload into TER 14

Introduction¶

What does it do?¶

Introduction¶

This TYPO3 Frontend Plugin shows your snippets in the frontend

All details at a glance¶

RSS Feed
Comments function integrated
Facebook and Twitter function integrated
TipAFriend integrated
Voting integrated
AJAX search (if wanted)
Extbase / Fluid is needed
jQuery is needed for all functions

Who is responsible for in2facebook?¶

Creation Team¶

The in2code team offers creates this extension for the TYPO3 community

Visit us on http://www.in2code.de

Screenshots¶

Frontend: Basic element of the FE Plugin is a Searchfield¶

Frontend: Searching for a snippet via AJAX¶

Frontend: Detail View of a snippet with some code Highlighting¶

Installation¶

Quickstart¶

Be sure to use TYPO3 4.5 or newer
Install the extensions extbase and fluid (system extensions)
Download and install the extension in2snippets
Include the needed static templates in your main TypoScript (main needed / ajax, rss and css if wanted)
Add a new sysfolter to your system
Sysfolder: Add some categories
Sysfolder: Add some snippets
Add the FE Plugin to a normal page
Make some settings in the constant editor
that's it

Configuration¶

TypoScript¶

Setup: Main Template (in2snippets)¶

plugin.tx_in2snippets {
        view {
                templateRootPath = {$plugin.tx_in2snippets.view.templateRootPath}
                partialRootPath = {$plugin.tx_in2snippets.view.partialRootPath}
                layoutRootPath = {$plugin.tx_in2snippets.view.layoutRootPath}
        }

        persistence {
        enableAutomaticCacheClearing = 1
    updateReferenceIndex = 0

                storagePid = {$plugin.tx_in2snippets.persistence.storagePid}
                classes {
                        Tx_In2snippets_Domain_Model_User {
                                mapping {
                                        tableName = be_users
                                        recordType = Tx_In2snippets_Domain_Model_User
                                        columns {
                                                username.mapOnProperty = username
                                                name.mapOnProperty = name
                                                uid.mapOnProperty = uid
                                        }
                                }
                        }
                }
        }

        settings {
                pid {
                        list = {$plugin.tx_in2snippets.settings.pid.list}
                        detail = {$plugin.tx_in2snippets.settings.pid.detail}
                }

                rss {
                        title = {$plugin.tx_in2snippets.settings.rss.title}
                        baseurl = {$plugin.tx_in2snippets.settings.rss.baseurl}
                        description = {$plugin.tx_in2snippets.settings.rss.description}
                        language = {$plugin.tx_in2snippets.settings.rss.language}
                }

                tipafriend {
                        ### Normal mail ###
                        senderEmail = {$plugin.tx_in2snippets.settings.tipafriend.senderEmail}
                        senderName = {$plugin.tx_in2snippets.settings.tipafriend.senderName}
                        subject = {$plugin.tx_in2snippets.settings.tipafriend.subject}
                        templateName = {$plugin.tx_in2snippets.settings.tipafriend.templateName}
                        ### Confirmation mail ###
                        subjectConf = {$plugin.tx_in2snippets.settings.tipafriend.subjectConf}
                        templateNameConf = {$plugin.tx_in2snippets.settings.tipafriend.templateNameConf}
                }

                staticTemplate = 1
        }
}

page {
        #include external jQuery
        includeJSFooter.jQuery_162_min = http://code.jquery.com/jquery-1.6.2.min.js
        includeJSFooter.jQuery_162_min.external = 1

        #include SyntaxHighlighter files
        #includeJSFooter.in2snippets_syntaxhighlighter_beatyofcode = EXT:in2snippets/Resources/Public/Tools/SyntaxHighlighter/jquery.beautyOfCode.js
        includeJSFooter.in2snippets_syntaxhighlighter_beatyofcode_min = EXT:in2snippets/Resources/Public/Tools/SyntaxHighlighter/jquery.beautyOfCode-min.js

        #include default extension files
        includeJSFooter.in2snippets_default_essential_js = EXT:in2snippets/Resources/Public/JS/in2snippets_essential.js
}

lib.detailLink = COA
lib.detailLink {
                rawUrlEncode = 1
        10 = TEXT
        10 {
                value = {$plugin.tx_in2snippets.settings.baseurl}
                wrap = |
        }

        20 = TEXT
        20 {
                typolink.parameter = {$plugin.tx_in2snippets.settings.pid.detail}
                typolink.returnLast = url
                typolink.additionalParams.cObject = TEXT
                typolink.additionalParams.cObject.wrap = &tx_in2snippets_pi1[snippet]=|&tx_in2snippets_pi1[action]=detail
                typolink.additionalParams.cObject.field = uid
        }
}

Constants: Main Template (in2snippets)¶

plugin.tx_in2snippets {
        view {
                # cat=plugin.tx_in2snippets/file; type=string; label=Path to template root (FE)
                templateRootPath = EXT:in2snippets/Resources/Private/Templates/
                # cat=plugin.tx_in2snippets/file; type=string; label=Path to template partials (FE)
                partialRootPath = EXT:in2snippets/Resources/Private/Partials/
                # cat=plugin.tx_in2snippets/file; type=string; label=Path to template layouts (FE)
                layoutRootPath = EXT:in2snippets/Resources/Private/Layouts/
        }
        persistence {
                # cat=plugin.tx_in2snippets//a; type=int+; label=Default storage PID
                storagePid =
        }
        settings {
                # cat=plugin.tx_in2snippets//0100; type=text; label=Baseurl: Baseurl used for Twitter and Facebook share
                baseurl = http://datest.in2code.de/

                # cat=plugin.tx_in2snippets//0100; type=int+; label=PID list: PageID for list-plugin
                pid.list = 3

                # cat=plugin.tx_in2snippets//0110; type=int+; label=PID detail: PageID for detail-plugin
                pid.detail = 3

                # cat=plugin.tx_in2snippets//0300; type=string; label=TipAFriend SenderEmail: Sender Email for tipafriend form
                tipafriend.senderEmail = info@in2code.de

                # cat=plugin.tx_in2snippets//0310; type=string; label=TipAFriend SenderName: Sender Name for tipafriend form
                tipafriend.senderName = in2snippets

                # cat=plugin.tx_in2snippets//0320; type=string; label=TipAFriend Subject: Subject for tipafriend email
                tipafriend.subject = A Friend of you sent you a Snippet-Link!

                # cat=plugin.tx_in2snippets//0330; type=string; label=TipAFriend TemplateName: Template Name for Email-Template
                tipafriend.templateName = Mail

                # cat=plugin.tx_in2snippets//0340; type=string; label=TipAFriend Subject: Subject for tipafriend confirmation-email
                tipafriend.subjectConf = Your Snippet-Link was sent!

                # cat=plugin.tx_in2snippets//0350; type=string; label=TipAFriend TemplateName: Template Name for Email-Template of onfirmation-email
                tipafriend.templateNameConf = MailConf
        }
}

Administration¶

FAQ¶

Q: Why is this such a short manual?¶

We're sorry. Manual will be updated soon!

Known problems¶

No problems known at the moment

To-Do list¶

Adding snippets in the frontend
It's up to you to give us some feedback!
Are there any further feature requests or bugs? Write us an email... See www.in2code.de

Additional links¶

You can use one of the following links, to get more information about this plugin:

Company which created this plugin: http://www.in2code.de

Do you need help with this plugin: http://www.typo3.net
Don't miss the best TYPO3 blogging page: http://www.typo3blogger.de

ChangeLog¶

0.1.0¶

Version

0.1.0

Date

2011-09-09

State

alpha

Changes

Initial upload into TER

13