EXT: Tag Pack¶

Table of Contents¶

EXT: Tag Pack 1

`Introduction 3 <#1.1.Introduction|outline>`_

What does it do? 3

Screenshots 3

`Installation 4 <#1.2.Installation|outline>`_

Tag Container 4

TSconfig to enable tagging 4

FAQ 4

`Users manual 5 <#1.3.Users%20manual|outline>`_

FAQ 5

`Administration 6 <#1.4.Administration|outline>`_

FAQ 6

`Configuration 7 <#1.5.Configuration|outline>`_

FAQ 7

Reference 7

`Tutorial 10 <#1.6.Tutorial|outline>`_

`Known problems 11 <#1.7.Known%20problems|outline>`_

`To-Do list 12 <#1.8.To-Do%20list|outline>`_

`ChangeLog 13 <#1.9.ChangeLog|outline>`_

Important guidelines 15

`HowTo update a manual to the new layout 16 <#2.1.HowTo%20update%20a %20manual%20to%20the%20new%20layout|outline>`_

`Issues with Open Office documentation for TYPO3 17 <#2.2.Issues%20w ith%20Open%20Office%20documentation%20for%20TYPO3|outline>`_

Inserting images 17

Paragraph styles 17

Linking 18

Meta data and updates 18

Help by documentation.openoffice.org 18

Introduction¶

Installation¶

You can install the Tag Pack with the TYPO3 Extension Manager as usual. Just import it directly through the TER or download it from typo3.org and then import it manually. Now you can install it by clicking on the grey icon with the plus symbol on it.

During the installation you will be asked to enter some information about the tables you want to be taggable and the folder to put the tags in. If you already got the necessary information you can give it now. If you don't know, just ignore the fields, since you can change the values later on by overriding them using TSconfig anyway.

Be sure to enter the necessary stuff at least once (during the installation or within TSconfig ) otherwise you won't be able to tag any record at all!

If you already got a folder for the tags and marked at least one table to be taggable you are now ready to go on, else you will have to do some additional work to enable the tagpack.

tx_tagpack_tags {
  taggedTables = tt_news,tt_content
  getTagsFromPid = 4
}

Users manual¶

• Documentation of how to use the extension, how it works, how to apply it if it's a website plugin. A user manual.
• Language should be non-technical, explaining, using small examples.
• Examples: For the "News" plugin this would be a manual showing how to create the news-items, explaining the options etc.
• Target group: Users, Administrators or Developers in that priority. Depends on the extension.

Administration¶

• Describes how to manage the extension from a superuser point of view. That relates to Page/User TSconfig, permissions, configuration etc. which administrator level users have access to.
• language should be non/semi-technical, explaining, using small examples.
• Target group: Administrators

Configuration¶

• Technical information; Installation, Reference of TypoScript, configuration options on system level, how to extend it, the technical details, how to debug it.
• language should be technical, assuming developer knowledge of TYPO3. Small examples/visuals are always encouraged.
• Target group: Developers

plugin {
  tx_tagpack_pi1 = USER
  tx_tagpack_pi1 {
    userFunc = tx_tagpack_pi1->main
    userFunc {
      tagcloudElements {
        enabledContent = text,image,textpic
        enabledRecords = tt_news
      }
      renderObj = COA_INT
      renderObj {
        10 = USER
        10 {
          userFunc = tx_tagpack_pi1->makeTagCloud
        }
      }
    }
  }
}

parametername = 1

parametername {
  keyname = 1
}

plugin {
  tx_tagpack_pi1 = USER
  tx_tagpack_pi1 {
    userFunc = tx_tagpack_pi1->main
    userFunc {
      tagcloudElements {
        enabledContent = text,image,textpic
        enabledRecords = tt_news
      }
      renderObj = COA_INT
      renderObj {
        10 = USER
        10 {
          userFunc = tx_tagpack_pi1->makeTagCloud
          tagPidList = 4
          targetPid = 123
          minFontSize = 8
          maxFontSize = 20
          maxNumberOfSizes = 20
          modeSwitch = 1
          searchBox = 1
          calendar = 1
          fontColor = #990000
          generalStdWrap {
            wrap = <div class="tx-tagpack-pi1-tagcloud">|</div>
          }
          linkBoxStdWrap {
            wrap = <h3>Tag Cloud</h3><div class="tx-tagpack-pi1-linkbox">|</div>
          }
          linkStdWrap {
            wrap = <span>|</span>
          }
          modeSwitchStdWrap {
            wrap = <h3>Filter Mode</h3><div class="tx-tagpack-pi1-modeswitch">|</div>
          }
          searchBoxStdWrap {
            wrap = <h3>Search Box</h3><div class="tx-tagpack-pi1-searchbox">|</div>
          }
          calendarStdWrap {
            wrap = <h3>Calendar</h3><div class="tx-tagpack-pi1-calendar">|</div>
          }
          calendarFrom = From
          calendarTo = To
          keepGetVars {
            tx_ttnews {
              category = 1
            }
          }
        }
      }
    }
  }
}

Tutorial¶

A full point-a-to-b-to-c walk-through of an application of the extension. Include screendumps.

Language: As tutorials are...

Target group: Whatever fits.

Known problems¶

Use this section for important warnings about bugs, problems or performance issues. This is where you should explain shortcomings of the extension, so people are properly warned. Be honest.

Target group: Mostly Developers

To-Do list¶

• A wish list of things you want to add or fix. This includes smaller problems/bugs which are best described as a todo item.
• Visions for what the extension could become with more development.

ChangeLog¶

0.9.2A new test regarding the manual. Should be better than the last one and contains more useful stuff now ;-)

0.9.1A test regarding the manual to make sure it will be rendered as expected

0.9.0Functionality slightly modified to improve usability.Doubleclicking is now possible where users expect it and ENTER will submit the form while merging.CSS slightly changed as well.

0.8.0Fixed ext_tables.php to match the current versions of plugins and content elements againDowngraded the plugins to the current working versions (sorry for the inconvenience caused by mixed up files)Added the missing static folder again

0.7.1Tag manager module is close to stable now.Merging of tags is now possible while assigning their relations to the replacement tag.”Translate" will be a feature for the 1.x branch though.Bugfix: If one of the tags to be merged and the replacement tag are the same, the tag still was deleted

0.7.0Tag manager module is close to stable now.Merging of tags is now possible while assigning their relations to the replacement tag."Translate" will be a feature for the 1.x branch though.

0.6.2Fixed a small bug (removed JS debug alert from date fields)

0.6.1Fixed a small bug (ext_tables.php including wrong typoscript statics)

0.6.0The new tag manager module is close to completion now - "Examine" and "Edit" are already available, "Merge" will be finished soon, "Translate" is planned for this summerThere's a new tagpack api class for backend and frontend functionality (thanx to Benjamin Mack)Backend functions have been adapted to work with the new api as far as possible, frontend plugins will follow

0.5.5added a check for an empty enabledRecords section in result list configuration to avoid a TCA bug shown in the frontend

0.5.4removed invalid character from static setup.txt of the tagcloud

0.5.3fixed a bug: TS-Setup for result lists using non existing constants

0.5.2fixed a bug TS-Setup for result lists of tagged records of pages and tt_content using wrong constant names

0.5.1added example TS-Setup for result lists of tagged records of pages and tt_contentchanged CSS-classes (they contain the official extension name as a prefix now)

0.5.0added basic settings for the installation with the extension manageradded several constants for the constant editoradded a regular expression for tagnames to get rid of special chars execept space or - (minus)

0.4.2fixed a bug with tags containing the Character - (minus)

0.4.1fixed a bug regarding listing of elements when in tagcrumb-mode

0.4.0added handler for version, inlineLocalizeSynchronize and hidden/unhidden elements with tagsfixed a bug regarding deleting and undeleting of tagged items

0.3.3added some iconsfixed a bug regarding selection of items with multiple tags

0.3.2removed one intval check that prevented new connection of tags if there were no existing tags available

0.3.1removed a debug outputsecured DB queries against possible attacks

0.3.0fixed some bugs with empty datamap entries for the tag fielddatabase operations other than editing don't destroy the relations anymore

0.2.0plugins for the tagcloud and a tagged items list are finalthe tagcloud can be pimped witha searchbox,a switch between filtermode and surfmode as well asa calendar for time frame settingsrecognition for additional URL parameters can be enabled as wellplugin for the nomination of tags still pending

0.1.0Backend works as expectedYou can create Tags and assign them to tables listed inTSconfig 'tx_tagpack_tags.taggedTables'no modules or plugins available yet

HowTo update a manual to the new layout¶

With these steps you get it very fast:

• Copy everything from your old manual except the title page and the table of contents
• Delete contents from new manual but leave the title page and the table of contents there
• Paste your content and check that formatting is correct and images are in place
• Update the page properties with your extension key, e-mail-address, name, language, tagging.In the moment the language- and tagging- properties are not in use by the TER, but findable by search.
• Reload the table of content (right click update index table)
• Insert your extension key below the document title
• Ready.

Hint: When the header-styles are still in the old layout then clear and re-assign the new style. Get help from http://documentation.openoffice.org

Issues with Open Office documentation for TYPO3¶

There are a few important points to make about writing documentation for TYPO3 in Open Office. Please makes sure to follow these.