Developers
AvantGo Channel Developer Guide

A - B - C - D - E - F - G - H - I - J - K - L - M - N - O - P - Q - R - S - T - U - V - W - X - Y - Z

Index

Numerics

150-pixel image size limit 1, 2

    breaking 1, 2

A

about this guide 1

actual size (channel) 1

advertising, designing for AvantGo home page and channels 1, 2

    AvantGo extras 1

    banners 1

    jump pages 1

    overview 1

    timeframes and policies 1

Apache web server

    Location directive 1

      special note for webmasters 1

    restricting access to AvantGo servers only 1

    used by your ISP 1

auto-fill of user's email and zip code 1, 2

AvantGo button, explaining 1

AvantGo Channel Creation Checklist 1

AvantGo Channel Partner

    becoming 1

    benefits 1

AvantGo Client 4.x

    Basic JavaScript support 1, 2

      Document Object Model (DOM) support 1

      PODS URLs support 1

    HTML 3.2 support 1, 2

      unsupported features 1

    tags and attributes supported 1, 2

AvantGo Client 5.x

    features added to AvantGo Client 4.x support 1

    unsupported features

      CSS 1.0 1

      DOM Level 1 1

      HTML 4.01 1

      JavaScript 1

AvantGo Client HTTP request headers

    decoding 1

    retrieving 1

    using to customize content 1, 2

AvantGo DOM API

    W3C DOM spec, features not supported in AvantGo Client 5.x 1

AvantGo JavaScript Engine

    available in AvantGo Client 5.x 1, 2

    JavaScript standard

      unsupported features (AvantGo Client 5.x) 1

AvantGo Marketing Products page 1

AvantGo policies

    Custom Channel 1, 2, 3, 4, 5

AvantGo sync server

    automatic conversion of pages for devices 1

    cookies stored on 1

    form submissions process completely before page requests 1

    function

      as proxy server 1

      in basic channel 1, 2

      with caching 1, 2

      without caching 1, 2

    limits 1

    restricting channel access to 1, 2

avoiding

    collisions in multiple offline form submissions 1

    grabbing pages multiple times 1

    large or detailed images 1

    more than one topic per page 1

    wide tables 1

B

breaking the 150-pixel image size limit 1, 2

C

cache

    client 1, 2

    desktop browser 1

    shared 1

Cache-Control header 1

caching 1, 2

    adding HTTP headers to pages 1, 2

    Apache note on Location directive 1

    Cache-Control HTTP header

      no-cache directive 1

      no-store directive 1

      other directives 1

      private directive 1

      using 1

    channel site design 1

    content that cannot be cached 1

    cookies do not block 1

    Date HTTP headers must be valid 1

    desktop browser cache unrelated 1

    disable while testing 1

    Expires HTTP header, using 1

    FAQ 1, 2

    HTTP headers, seeing for page 1

    implementing 1, 2

    introduction 1, 2

    META-HTTP EQUIV tags, using 1

    non-Apache servers 1

    page URLs should be unique 1

    personalized content on user's device 1, 2

    personalized pages, don't cache 1

    server under control of your ISP 1

    set up channel for, before you go live 1

    strategies 1, 2

    tips 1

cascading style sheets (CSS)

    inline, available in AvantGo Client 5.x 1

    not available in AvantGo Client 4.x 1

    unsupported features in AvantGo Client 5.x 1

CENTER tag 1

changing channel settings 1

channel

    creating and testing 1, 2

      Follow Off-Site Links setting 1

      Include Images setting 1

      Link Depth setting 1

      Location setting 1

      Maximum Channel Size setting 1

      Refresh setting 1

      settings, changing 1

      settings, specifying 1, 2

      Title setting 1

    creating content 1, 2

      designing graphics for channel pages 1, 2

      designing pages for the channel site 1, 2

      designing the channel site 1, 2

    creating your first 1, 2

    custom channel vs. M-Business channel 1

    detailed definition 1, 2

    FAQ 1, 2

      advanced topics 1

      AvantGo Client wireless 1

      basic questions 1

      JavaScript 1

      other 1

      promotions and page tracking 1

      security 1

    form submissions, managing 1, 2

      collisions in multiple offline submissions, avoiding 1, 2

      offline forms 1, 2

      online forms 1

      personal channels used to bypass Forms Manager 1, 2

      submitting forms the right way 1, 2

      Wine Finder Channel example 1, 2

    rolling out 1, 2

      AvantGo button, explaining 1

      AvantGo Channel Partner, becoming 1

      caching, set up 1

      channel ID, looking up 1

      link that subscribes users 1

      linking to and promoting 1

      restricting access to AvantGo servers only 1

      things to do before you go live 1, 2

    separate template for channel pages 1

    set up for caching before you go live 1

    special features, adding 1, 2

      email and zip code auto-fill 1, 2

      using PIM POD to insert an event into a user's calendar 1

    subscribing users 1, 2

      .subs files phased out 1

      adding any web page to user's mobile device with a simple link 1, 2

      adding any web page to user's mobile device with add_channel.pl link 1, 2

      with a sign-up process 1, 2

      with a simple link 1

    testing 1, 2

      syncing just one channel 1, 2

      testing on different devices 1

      testing on emulators 1, 2

    troubleshooting and debugging 1, 2

      caching prevents me from counting user syncs 1

      need to remove all cookie information from your AvantGo account 1

      not sure cookie is being set properly 1, 2

      not sure forms are being sent properly 1

      only last offline submission of same form works 1

      page not available message on another device 1

      page not available message on your test device 1, 2

      server timeouts encountered 1

      tips for debugging cookies 1

    user-submitted (phased out) 1

channel development

    differences from desktop web development 1, 2

      AvantGo limitations 1

      hardware differences 1

      offline differences 1

    introduction 1, 2

channel ID

    getting 1

    looking up 1, 2

channel size

    actual 1

    dowloaded 1

    Maximum Channel Size limit 1

channel URLs

    control case 1

    make all URLs pointing to same page identical 1

checklist

    AvantGo Channel Creation Checklist 1

choosing channel content 1

client cache 1, 2

1

collisions of cookies in multiple offline form submissions, avoiding 1, 2

compressed size (page) 1

considering online/offline mode 1

content

    choosing for channel 1

control case of channel URLs 1

conventions, used in this guide 1

cookies

    collisions in multiple offline form ubmissions, avoiding 1, 2

    do not block caching 1

    expiring differently for desktop vs. channel viewers 1

    keeping page requests in sync with preferences 1

    multiple 1

      with relative expiration dates 1

    personalization example

      Movie Review Channel 1, 2

        design concept 1

        implementation details 1, 2

        keeping page requests in sync with preferences 1

    Wine Finder Channel 1, 2

      setting in HTTP headers 1

      storing information in cookie vs. database 1

      storing only user ID, other user information in database 1

      using to support personal channels 1, 2

creating and testing a channel 1, 2

creating channel content 1, 2

    designing graphics for channel pages 1, 2

      alt tags 1

      best quality strategy 1

      designing images 1

      image color guidelines (on color devices) 1

      image color guidelines (on grayscale devices) 1

      image colors 1

      image detail 1

      image size 1

      lowest common denominator strategy 1

      simulating image maps 1

    designing pages for the channel site 1, 2

      HTML 3.2 supported by AvantGo Client 4.x 1

      HTML 4 supported by AvantGo Client 5.x 1

      META HandheldFriendly tag 1

      page layout 1

    designing the channel site 1, 2

      AvantGo sync server

            limits 1

      avoiding grabbing pages multiple times 1

      caching 1

      choosing content 1

      considering online/offline mode 1

      downloading a page beyond channel's Link Depth 1

      organizing pages 1

      pages returned in upredictable order 1

      size limit issues 1

    creating your first channel 1, 2

    CSS (cascading style sheets)

      inline, available in AvantGo Client 5.x 1

      not available in AvantGo Client 4.x 1

      unsupported features in AvantGo Client 5.x 1

    custom channel

      difference from M-Business channel 1

    Custom Channel policy 1, 2, 3, 4, 5

    customizing channel content 1, 2

      for different devices 1, 2

      for different users 1, 2, 3

      using AvantGo Client HTTP request headers 1, 2

      using cookies to support personal channels 1, 2

      using server URL macros 1, 2, 3

    D

    1

    decoding AvantGo Client HTTP request headers 1

    designing

      advertising for AvantGo home page and channels 1, 2

        AvantGo extras 1

        banners 1

        jump pages 1

        overview 1

        timeframes and policies 1

      channel site 1, 2

      graphics for channel pages 1, 2

      pages

        for channel site 1, 2

        for multiple devices 1

    directives

      Files (Apache) 1

      FilesMatch (Apache) 1

      Location (Apache) 1

      max-age (Cache-Control HTTP header) 1

      no-cache (Cache-Control HTTP header) 1

      no-store (Cache-Control HTTP header) 1

      other (Cache-Control HTTP header) 1

      private (Cache-Control HTTP header) 1

    display size (page) 1

    DOM (document object model)

      support in AvantGo Client 4.x 1

      W3C DOM spec, features not supported in AvantGo DOM API (AvantGo Client 5.x) 1

    dowloaded size (channel) 1

    downloading a page beyond channel's Link Depth 1

    E

    email and zip code auto-fill 1, 2

    event attributes (AvantGo Client 5.x) 1

    examples

      Movie Review Channel 1, 2

        design concept 1

        implementation details 1, 2

        keeping page requests in sync with preferences 1

    expiring cookies differently for desktop vs. channel viewers 1

    explaining the AvantGo button 1

    F

    FAQ

      channel 1, 2

        advanced topics 1

        AvantGo Client wireless 1

        basic questions 1

        JavaScript 1

        other 1

        promotions and page tracking 1

        security 1

    Files directive (Apache) 1

    FilesMatch directive (Apache) 1

    Follow Off-Site Links channel setting 1

    forms

      AvantGo Contact Form 1

    Forms Manager 1, 2

      using personal channels to let response pages bypass 1, 2

      what it does 1, 2

      why you should not use it 1

    forms, HTML

      auto-fill of user's email and zip code 1, 2

      submmissions, managing 1, 2

        caching guidelines 1

        collisions in multiple offline submissions, avoiding 1, 2

        Forms Manager 1, 2

        offline forms 1, 2

        online forms 1

        online users, accommodating 1

        personal channels used to bypass Forms Manager 1, 2

        Submit button with submitNoResponse() 1, 2

        submitting forms the right way 1, 2

        Wine Finder Channel example 1, 2

      using in pages 1

    G

    grabbing pages multiple times, avoiding 1

    guidelines

      color images on color devices 1

      color images on grayscale devices 1

    H

    HTML 3.2 (AvantGo Client 4.x) 1, 2

      tags and attributes supported 1, 2

    HTML 4 (AvantGo Client 5.x) 1, 2, 3

      unsupported features 1

    HTML, using

      forms 1

      tabless 1

      TITLE tag 1

    HTTP headers

      Cache-Control 1

      Date 1

      Expires 1

      Last-Modified 1

    I

    image sizes 1

    images

      150-pixel limit 1

        breaking 1, 2

      color images on color devices 1

      color images on grayscale devices 1

      designing for channel pages 1, 2

    Include Images channel setting 1

    J

    JavaScript

      standard

        features not supported in AvantGo Client 5.x 1

    JavaScript (AvantGo Client 4.x)

      data types 1

      Document Object Model (DOM) support 1

      event handlers 1, 2

      methods 1, 2

      PODS URLs support 1

      practical examples 1, 2

        displaying message when form is submitted 1

        hiding form after submission 1

        multiple pieces of JavaScript on one element 1

        submitting form and providing response page 1

      submitting forms 1, 2

    JavaScript support (AvantGo Client 4.x)

      Basic JavaScript 1, 2

        Document Object Model (DOM) support 1

        PODS URLs support 1

    L

    Last-Modified HTTP header 1

    leaks 1

    limitations

      AvantGo 1

      AvantGo sync server 1

      hardware 1

      offlline 1

      size 1

      user 1

    Link Depth channel setting 1

      downloading a page beyond 1

    linking to and promoting your channel 1

      channel ID, looking up 1

      link that subscribes users 1

    links

      Follow Off-Site Links channel setting 1

      Link Depth channel setting 1

        downloading a page beyond 1

      to promote your channel 1

      to subscribe users 1

        with a sign-up process 1, 2

        with a simple link 1

    Location channel setting 1

    Location directive (Apache) 1

    M

    max-age directive 1

    Maximum Channel Size channel setting 1

      designing within 1

    M-Business channel

      difference from custom channel 1

    META Expires tag 1

    META HandheldFriendly tag 1, 2

    Microsoft IIS web server

      restricting access to AvantGo servers only 1

    Mobile Link 1

    mode

      offline 1

        form submissions 1, 2

      online 1

        designing response pages for online users 1

        form submissions 1

      online/offline, in site design 1, 2

    mouse and key event attributes (AvantGo Client 5.x) 1

    multiple cookies 1

      with relative expiration dates 1

    multiple offline form submissions, avoiding collisions in 1

    AvantGo Contact Form 1

    N

    no-cache directive (Cache-Control HTTP header) 1

    O

    offline mode 1

    online mode 1

    organizing pages 1

    original size (page) 1

    P

    page layout 1

    page size

      compressed 1

      display 1

      original 1

    pages

      adding any web page to user's mobile device

        with a simple link 1, 2

        with add_channel.pl link 1, 2

      customizing

        for different devices 1, 2

        for different users 1, 2, 3

      designing 1, 2

        for multiple devices 1

        response pages for online users 1

      organizing 1

      returned in upredictable order 1

      URLs should be unique for caching 1

    personal channels

      creating 1, 2

      to let response pages bypass Forms Manager 1, 2

    PIM POD, using to insert an event into a user's calendar 1

    1

    preferences

      keeping page requests in sync with 1

    private directive (Cache-Control HTTP header) 1

    promoting and linking to your channel 1

      channel ID, looking up 1

      link that subscribes users 1

    publications, related 1

    R

    Refresh channel setting 1

    regular expression tutorial 1

    related publications 1

    restricting access to AvantGo servers only 1, 2

      Apache web server 1

      Microsoft IIS web server 1

    retrieving AvantGo Client HTTP request headers 1

    S

    sample code 1, 2

      Movie Review Channel example 1, 2

        basic version 1, 2

        version 2, supporting online users 1, 2

        version 3, no database, preferences stored in cookie 1, 2

      sample hosted advertisement 1, 2

      Wine Finder Channel example 1, 2

    security 1, 2

      client-to-server 1

        secure sessions 1

        special requirements 1

      futures and options 1

      overview 1

      server 1

        cookie encryption 1

        server protection 1

        transmission checks 1

      server-to-web 1

        authentication to websites 1

        secure connections 1

        trusted hosts 1

    server URL macros

      available list 1

      inserting in channel URL 1

      using to customize content 1

    shared cache 1

    size

      compressed (page) 1

      display (page) 1

      image size limit 1

      images 1

      Maximum Channel Size limit 1

      original (page) 1

      user limitations 1

    size limit issues 1

    special features, adding to channel 1, 2

      email and zip code auto-fill 1, 2

      using PIM POD to insert an event into a user's calendar 1

    specifying channel settings 1, 2

      Follow Off-Site Links setting 1

      Include Images setting 1

      Link Depth setting 1

      Location setting 1

      Maximum Channel Size setting 1

      Refresh setting 1

      Title setting 1

    submitNoResponse(), with Submit button 1, 2

    subscribing users 1, 2

      .subs files phased out 1

      adding any web page to user's mobile device with a simple link 1, 2

      adding any web page to user's mobile device with add_channel.pl link 1, 2

      providing a link 1

      with a sign-up process 1, 2

      with a simple link 1

    T

    tables, using 1

    tags

      CENTER 1

      META Expires 1

      META HandheldFriendly 1, 2

      META-HTTP EQUIV 1

      TITLE 1

    template, separate one for channel pages 1

    testing your channel 1, 2

      syncing just one channel 1, 2

      testing on different devices 1

      testing on emulators 1, 2

    Title channel setting 1

    TITLE tag, using 1

    troubleshooting and debugging your channel 1, 2

      caching prevents me from counting user syncs 1

      need to remove all cookie information from your AvantGo account 1

      not sure cookie is being set properly 1, 2

      not sure forms are being sent properly 1

      only last offline submission of same form works 1

      page not available message on another device 1

      page not available message on your test device 1, 2

      server timeouts encountered 1

      tips for debugging cookies 1

    U

    unsupported features in AvantGo Client 5.x

      CSS 1.0 1

      DOM Level 1 1

      HTML 4.01 1

      JavaScript 1

    1

    URLs, make all pointing to same page identical 1

    user limitations 1

    user-submitted channels (phased out) 1

    W

    W3C DOM spec, features not supported in AvantGo DOM API (AvantGo Client 5.x) 1

    Z

    zip code and email auto-fill 1, 2