{ "info": { "author": "Hexagon IT", "author_email": "oss@hexagonit.fi", "bugtrack_url": null, "classifiers": [ "Framework :: Plone", "Programming Language :: Python" ], "description": "============================\nVirtual 3D gallery for Plone\n============================\n\n`hexagonit.virtualgallery` is a Plone add-on that renders a Flash-based 3D virtual gallery.\n\n* `Source code @ GitHub `_\n* `Releases @ PyPI `_\n* `Sphinx docs @ ReadTheDocs `_\n\nInstallation\n============\n\nTo install ``hexagonit.virtualgallery`` you simply add\n``hexagonit.virtualgallery`` to the list of eggs in your buildout, run\nbuildout and restart Plone. Then, install `hexagonit.virtualgallery` using the\nAdd-ons control panel.\n\nRequirements\n============\n\n * `Plone `_ 4.1 or newer\n * `Flash player `_ 10.2 or newer\n\nBasic usage\n===========\n\nThis package adds the `Virtual 3D gallery` display mode to Folder and\nCollection. So, go to any folder or collection that contains images and select\n``Virtual 3D gallery`` from the display drop-down menu.\n\nIn the gallery each room has enough space for 17 images. If the image source\n(Folder or Collection) contains more images then additional rooms will be\nautomatically created and doors allow the user to travel between the rooms.\n\nThe gallery can be navigated either by using the mouse or the keyboard. Use\nthe arrow keys to move within the space (hold down shift to strafe). Clicking\nan image with the mouse will concentrate on that image and the image metadata\nwill become visible when hovering over the image.\n\nYou can view each image in turn by clicking on the arrow buttons on the left\nand right side of the viewer. The viewer can also be put in fullscreen mode\nby clicking on the fullscreen button on the top right corner.\n\n.. image:: https://github.com/hexagonit/hexagonit.virtualgallery/raw/master/hexagonit/virtualgallery/docs/images/screenshot.png\n\nConfiguration\n=============\n\nEach gallery may be configured to use a particular image scale (provided by\n`plone.app.imaging `_) by\nchoosing the appropriate scale on the ``Virtual gallery settings`` page. A\nlink to the settings page will become visible when the context is using the\nvirtual gallery display.\n\nBy default the gallery uses the original scale of the images but in case of\nlarge images this may slow down the gallery significantly. Using a smaller\nscale version of the images usually improves the loading time and performance.\n\nYou can also configure new image scales in ``Site setup \u203a Image handling``.\nFor example, you could define a \"HD\" scale at 1200x1200 pixels which would\ngive most current day users a good quality image even in the fullscreen mode.\n\nAdvanced usage\n==============\n\nThe Flash viewer is independent of Plone and may be used in any web context,\neven another framework or a language environment. The viewer requires two\ndistinct parts to work:\n\n * The HTML code to embed the viewer and pass parameters\n * JSON configuration which configures the viewer.\n\nEmbed code\n----------\n\nThe HTML code needs to embed the ``Virtual3DGallery.swf`` viewer and pass a\nsingle `flashvars `_ variable\ncalled ``dataURL`` to the viewer. This variable must contain the URL to the\nJSON configuration file which configures the viewer.\n\nIf you are embedding the viewer within a page that contains other content it\nis also recommended set the ``wmode=window`` flash parameter so that HTML\nelements can be positioned above the flash content.\n\nBy default, this package uses the `SWFObject\n`_ Javascript library to do the\nembedding.\n\nJSON configuration\n------------------\n\nThe Flash viewer is driven by the JSON configuration which contains the list\nof images to display in the gallery, associated image metadata (title, author,\ndescription) and translations for the UI textual elements, e.g.::\n\n {\"images\": [\n {\"url\": \"http://my.server.com/images/image1.png\",\n \"title\": \"Nice scenery\",\n \"description\": \"Lorem lipsum..\",\n \"author\": \"dokai\"},\n {\"url\": \"http://my.server.com/images/image2.png\",\n \"title\": \"Screenshot of Foo\",\n \"description\": \"Lorem lipsum..\",\n \"author\": \"dokai\"}\n ],\n \"ui\": {\n \"enterRoomToolTip\": \"Click to enter\",\n \"fullscreen\": \"Fullscreen\",\n \"loadingImg\": \"Loading image:\",\n \"enterRoom\": \"Entering room [x] of [y]\",\n \"anaglyph\": \"Anaglyph\"\n },\n \"settings\": {\n \"anaglyphModeEnabled\": \"false\"\n }}\n\nThe viewer does not care where the images and associated metadata come from so\nyou can implement any custom logic that puts together the list (custom catalog\nqueries, structural hierarchies, etc) as long as the resulting JSON document\nis valid.\n\nThe package contains an associated `JSON schema `_ document which can be used to validate the JSON\nconfiguration, e.g.::\n\n from hexagonit.virtualgallery.schema import GALLERY_DATA_SCHEMA\n from validictory import validate\n import json\n\n try:\n # Assuming the `my_custom_config` contains the Python\n # data structure with the image information.\n validate(my_custom_config, GALLERY_DATA_SCHEMA)\n json_config = json.dumps(my_custom_config)\n except ValueError:\n # Validation failed, do something.\n pass\n\n\nYou might want to display the gallery somewhere else or possibly in a\ntoolbarless new window. To keep all Plone stuff away from the virtual gallery\nuse a URL like below to only get the title of the gallery and the Flash object\nthat displays it::\n\n http:///////virtualgallery?ajax_load=1&ajax_include_head=1\n\n\nTODO\n====\n\n* cross-browser testing\n* use in the wild\n\nCredits\n=======\n\n* Idea, skeleton and sponsoring provided by Hexagon IT Oy.\n* Flash part of the gallery developed by Michal Zwieruho, BlackMoon Design.\n* Plone integration by Nejc Zupan, NiteoWeb Ltd.\n\nChangelog\n=========\n\n1.0 (2011-08-26)\n----------------\n\n- Added support for configuring the image scale used in the gallery\n on per-context basis.\n [dokai]\n\n- Updated documentation\n [dokai]\n\n- Updated Finnish translations.\n [dokai]\n\n- Support for translations added.\n [zupo]\n\n- Fixed the Flash window mode so that Plone dropdown menus are visible\n on top of the Flash movie.\n [dokai]\n\n- Updated the Flash movie to a new version. Highlights:\n\n * No more empty frames on walls.\n * The default position when entering a room shows the middle box\n with the room number better.\n * Redundant tooltips (prev, next, forward, backward, etc) removed.\n * Traversal through doors using mouse clicks.\n * Repositioned the prev/next and fullscreen buttons.\n * Fixed a bug with image info popups being sticky in fullscreen mode.\n * Fixed a bug with empty galleries.\n * Fixed a bug with tooltips not expanding correctly over different\n sized text.\n * Fixed a bug where in some cases clicking on an image would zoom-in\n on a wrong one.\n * Traversing through doors is possible with a single click.\n\n Removed also the now redundant entries in the JSON configuration.\n\n [dokai]\n\n1.0b4 (2011-08-10)\n------------------\n\n- Really fix the packaging error. The setuptools ``unpack_tarfile`` function\n filters out symlinks when unpacking so they will not be present in the\n unpacked package. This, combined with some weirdness in either ``tar``\n itself or the Python tar module which reverses the order of the link,\n caused the targets of the symlinks to be removed from the final unpacked\n package.\n [dokai]\n\n1.0b3 (2011-08-10)\n------------------\n\n- Fixed packaging error in 1.0b2.\n [dokai]\n\n- JSON schema validation.\n [zupo]\n\n\n1.0b2 (2011-08-04)\n------------------\n\n- Code cleanups.\n [zupo]\n\n- More comments and documentation.\n [zupo]\n\n- More tests.\n [zupo]\n\n\n1.0b1 (2011-08-04)\n------------------\n\n- Initial release.\n [zupo]\n\nLicense\n=======\n\nCopyright (c) 2011, Hexagon IT Oy\nAll rights reserved.\n\nRedistribution and use in source and binary forms, with or without\nmodification, are permitted provided that the following conditions are met:\n\n * Redistributions of source code must retain the above copyright notice,\n this list of conditions and the following disclaimer.\n\n * Redistributions in binary form must reproduce the above copyright\n notice, this list of conditions and the following disclaimer in the\n documentation and/or other materials provided with the distribution.\n\n * Neither the name of Hexagon IT Oy nor the names of its contributors may\n be used to endorse or promote products derived from this software\n without specific prior written permission.\n\nTHIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS \"AS IS\"\nAND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE\nIMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE\nDISCLAIMED. IN NO EVENT SHALL HEXAGON IT OY BE LIABLE FOR ANY DIRECT,\nINDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,\nBUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,\nDATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY\nOF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING\nNEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,\nEVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.", "description_content_type": null, "docs_url": null, "download_url": "UNKNOWN", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "UNKNOWN", "keywords": "", "license": "BSD", "maintainer": null, "maintainer_email": null, "name": "hexagonit.virtualgallery", "package_url": "https://pypi.org/project/hexagonit.virtualgallery/", "platform": "UNKNOWN", "project_url": "https://pypi.org/project/hexagonit.virtualgallery/", "project_urls": { "Download": "UNKNOWN", "Homepage": "UNKNOWN" }, "release_url": "https://pypi.org/project/hexagonit.virtualgallery/1.0/", "requires_dist": null, "requires_python": null, "summary": "Virtual 3D image gallery for Plone", "version": "1.0" }, "last_serial": 887019, "releases": { "1.0": [ { "comment_text": "", "digests": { "md5": "b35a585ee036b5432daa203e8b1678f6", "sha256": "72f691d26b81ee1bdb8e0c9ad1b23198761bdc12c700390320afd76a880fd7c9" }, "downloads": -1, "filename": "hexagonit.virtualgallery-1.0.zip", "has_sig": false, "md5_digest": "b35a585ee036b5432daa203e8b1678f6", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 1311446, "upload_time": "2011-08-26T10:29:57", "url": "https://files.pythonhosted.org/packages/60/da/3c52328935c469869a417341ba6f7f4e9669249b215b9676b1eace5fe801/hexagonit.virtualgallery-1.0.zip" } ], "1.0b1": [], "1.0b2": [ { "comment_text": "", "digests": { "md5": "aa1476ec169021ad10d970a5c5556362", "sha256": "58de47842d4200192dc97592ae001ac0d9f8622e5dde17746c0cca9655e6ce84" }, "downloads": -1, "filename": "hexagonit.virtualgallery-1.0b2.tar.gz", "has_sig": false, "md5_digest": "aa1476ec169021ad10d970a5c5556362", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 7611, "upload_time": "2011-08-04T14:09:20", "url": "https://files.pythonhosted.org/packages/7b/93/70b20bb09fdfb64a934b2bbabe53de6bc218f6e6de3c82352cd9bac00992/hexagonit.virtualgallery-1.0b2.tar.gz" } ], "1.0b3": [ { "comment_text": "", "digests": { "md5": "428580904d73520c89e9b4c593ad23b3", "sha256": "14e145afc265db37225469b3ec9838758f8e10ee487ae7a0832fa23ca2543ef1" }, "downloads": -1, "filename": "hexagonit.virtualgallery-1.0b3.tar.gz", "has_sig": false, "md5_digest": "428580904d73520c89e9b4c593ad23b3", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 769122, "upload_time": "2011-08-10T14:43:08", "url": "https://files.pythonhosted.org/packages/09/c7/e1978b4da5500d360635a8add050e411dd294d764bf1d371db836e9d2b4a/hexagonit.virtualgallery-1.0b3.tar.gz" } ], "1.0b4": [ { "comment_text": "", "digests": { "md5": "690ea9ce2289a883b7973b359fbbb6ed", "sha256": "f40552922202dcef548d85a1657fcc5e6c3a50cf1d17e3bd23168f983acc38bc" }, "downloads": -1, "filename": "hexagonit.virtualgallery-1.0b4.tar.gz", "has_sig": false, "md5_digest": "690ea9ce2289a883b7973b359fbbb6ed", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 769703, "upload_time": "2011-08-11T09:15:37", "url": "https://files.pythonhosted.org/packages/8d/fd/bba18ca8c9a47f31886058b1fcc354af8b4ad75f9aa42957d7c07808914a/hexagonit.virtualgallery-1.0b4.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "b35a585ee036b5432daa203e8b1678f6", "sha256": "72f691d26b81ee1bdb8e0c9ad1b23198761bdc12c700390320afd76a880fd7c9" }, "downloads": -1, "filename": "hexagonit.virtualgallery-1.0.zip", "has_sig": false, "md5_digest": "b35a585ee036b5432daa203e8b1678f6", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 1311446, "upload_time": "2011-08-26T10:29:57", "url": "https://files.pythonhosted.org/packages/60/da/3c52328935c469869a417341ba6f7f4e9669249b215b9676b1eace5fe801/hexagonit.virtualgallery-1.0.zip" } ] }