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: YAG Library Theme¶

Created:	2010-02-18T17:33:18
Changed:	2013-01-25T18:35:48
Classification:	yag_theme_library
Keywords:	yag Yet Another Gallery
Author:	Daniel Lienert
Email:	daniel@lienert.cc
Info 4:
Language:	en

EXT: YAG Library Theme - yag_theme_library

EXT: YAG Library Theme¶

Extension Key: yag_theme_library

Language: en

Keywords: yag Yet Another Gallery

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: Readable name of your extension 1

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

What does it do? 3

Screenshots 3

`Users manual 4 <#1.2.Users%20manual|outline>`_

FAQ 4

`Administration 5 <#1.3.Administration|outline>`_

FAQ 5

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

FAQ 6

Reference 6

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

`Known problems 8 <#1.6.Known%20problems|outline>`_

`To-Do list 9 <#1.7.To-Do%20list|outline>`_

`ChangeLog 10 <#1.8.ChangeLog|outline>`_

Important guidelines 11

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

Inserting images 12

Paragraph styles 12

Linking 13

Meta data and updates 13

HowTo: Update a manual to the new layout 13

HowTo: (alternative) Import the styles from another document 14

`HowTo: Fix the Table Of Contents when it is empty 14 <#2.1.8.HowTo:%2 0Fix%20the%20Table%20Of%20Contents%20when%20it%20is%20empty%20|outline >`_

HowTo: Fix the Table Of Contents when a chapter is missing 14

Help by documentation.openoffice.org 14

Introduction¶

What does it do?¶

The Library theme makes have use of the pt_extlist extension which powers the item-listings of YAG, to implement a filterable image library.

Users manual¶

I think it is self explaining.

Administration¶

Install the extension and include its static template.

Configuration¶

Pt_extlist is a powerful tool to list any kinds of database items with only typoscript configuration. To learn about the configuration options, read the pt_extlist manual and its typoscript refernce.

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.
TYPO3 Forge link to your project

ChangeLog¶

Create a file "ChangeLog" (see e.g. the extension "cal" as example) to inform about changes or
Use this section to document all the changes through the versions.
Alternative to the following list: ChangeLog online (point this link to YOUR extension)

0.1.0¶

Version

0.1.0

Changes

Added / Changed/ Caught error

Important guidelines¶

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.

Inserting images¶

When you insert images you can either:

Make a copy/paste from eg. Photoshop, but it's REALLY IMPORTANT that you insert the image into Open Office by the menu “Edit > Paste Special” and then select “Bitmap”. If you don't do it in this way the image cannot be shown (since it will not be stored as a PNG internally in the SXW file)
Alternatively you can use the traditional way “ Insert > Graphics > From file ” and insert an image from your harddrive. In particular use this if the image is photographic (JPG) since the internal storage as PNG is not good for photographs.

Generally please use copy/paste only for screendumps with large areas of similar color (good png-compression) and JPG-files for photographic images. Go for small images, 72 dpi, medium quality.

Paragraph styles¶

Use the paragraph style “Text body” for bodytext
Use “Heading 1” to “Heading 5” for headers. “Heading 1-3” will be recognized as “sections” on typo3.org. “Heading 4-5” is subheaders, where “Heading 5” is preferrably for “Examples”.
For code listings, use the style “Preformatted Text” (found under “HTML Styles”). For codelistings in tables there is a custom style called “Table Contents/PRE”.

This screenshot shows the only paragraph styles allowed in the documents. The ones grayed out are paragraph styles that are used by default for such as the index table or the footer. The others are the ones you are allowed to use.

Linking¶

You can make hyperlinks in the documents as absolute URLs. Use menu “Insert > Hyperlink”

Meta data and updates¶

There are three fields of meta-data you have to fill in. First of all go to “File > Properties...”.

In the “Description” screen you enter the title of the document. Extension manuals are prefixed “EXT: [extension title]”
In the “User defined” screen you enter your email address as the first field (named “Email” / ”Info 1”)
In the “User defined” screen you enter your full name as the second field (named “Author” / ”Info 2”)

Finally you should also insert the correct extension key in the text below the document title, but this is not a meta-data field, just regular text.

HowTo: Update a manual to the new layout¶

With these steps you get it very fast

Update the extension doc_template (maybe a new one is out)
Hit the F11 key to show the styles
>> 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
Hint: When the header-styles are still in the old layout then clear and re-assign the new style
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.

HowTo: (alternative) Import the styles from another document¶

(!) In some old OpenOffice versions (e.g. 2.4) there's a bug: after the import you need the HowTo “Fix the TOC”
Load your manual, then hit the F11 key to show the styles
Klick on the small arrow top-right
A select box appears , you klick at “Load Styles” and then “From File”
(!) Check all the boxes
Navigate to the “doc_template”/doc” folder and switch the file-type to .sxw “OpenOffice.org 1.0 Textdocument”
Open the manual.sxw, now you can use the new style!

HowTo: Fix the Table Of Contents when it is empty¶

Maybe the outline numbering is broken (german: “Kapitelnummerierung”).

Go to menu "Tools” > “Outline Numbering" and apply the missing "Heading" styles to the empty levels.
Update the TOC, ready.

HowTo: Fix the Table Of Contents when a chapter is missing¶

You have changed the styling of a header. Clear the formatting of the header and re-assign the header-style

Help by documentation.openoffice.org¶

See the international portal for help: http://documentation.openoffice.org

13