Creating Linkinus Styles

Introduction

This page is currently a work in progress. The vital info is here and assumes that you are familiar with HTML and CSS. An example style isn't included yet, but you can use Whisper for best results. Linkinus styles are made up of a combination of HTML, CSS, and Javascript. Due to the advancements in Safari 4, many advanced features of HTML 5 and CSS 3 are available to you that would otherwise not be available for general web development. This set of technology allows for great freedom and customization of Linkinus to fit your needs. Documentation on this page assumes familiarity with current web development technologies.

Basic Style Structure

While creating Linkinus styles gives a great amount of freedom in what can be done, there is a basic structure that must be followed in order to make an effective style. The directory structure is as follows:

  • Style Name.lnk2Style/
    • Contents/
      • Info.plist
      • Resources/
        • img/
          • emoticons/
          • hintbox/
          • embed/
        • css/
          • common.css
          • embedkit.css
          • hintbox.css
          • style.css
        • js/
          • controllers/
            • index.js
            • console.js
            • global.js
            • query.js
            • logviewer.js
          • definitions/
            • commmon.js
            • custom.js
          • helpers/
            • helpers.js
            • hintbox.js
            • embed.js
          • jquery/
            • 1.3.2.min.js
            • simplemodal.min.js
        • index.html
        • console.html
        • global.html
        • query.html
        • logviewer.html

This directory and file structure isn't terribly rigid, though it's recommended that you use the javascript supplied with the default styles to maintain full compatibility with the feature-set. Additionally, only the index.html file is required, but once again it is recommended you use the example structure given above.

HTML Structure

Look at the example style :P

CSS Hints

Will write when I port my own style.

Javascript Documentation

Required JavaScript Methods

  • function setEmoticonsEnabled(enabled)
  • function setCombinedMessagesEnabled(enabled)
  • function setSpotlightUserMessagesOnHoverEnabled(enabled)
  • function setFontSize(size)
  • function scrollToBottom(ignorePosition)
  • function appendMessage(messageDetails)
  • function unfocus()
  • function focus()
  • function scrollTo(id)
  • function prevHighlight()
  • function nextHighlight()
  • function addBreak()
  • function removeLastBreak()
  • function scrollToLastBreak()
  • function deleteFirstMessage()
  • function removeMessage(uuid)
  • function showConnectionHintBox(network, server, nickname, realname)
  • function hideConnectionHintBox()

Accessible Linkinus Methods

  • window.linkinus.focus()
  • window.linkinus.clickPost_(postId) - available only in Highlights & Stars window
  • window.linkinus.starPosts_(id)
  • window.linkinus.unstarPosts_(id)
  • window.linkinus.showInspector()
  • window.linkinus.showStylePreferences()
  • window.linkinus.displayChannelList()
  • window.linkinus.displayJoinDialog()
  • window.linkinus.setDisableConnectionHintBox_(shouldDisable)
 
creating_styles.txt · Last modified: 2011/04/28 02:22 by btipling
 
Recent changes RSS feed Donate Powered by PHP Valid XHTML 1.0 Valid CSS Driven by DokuWiki