{ "info": { "author": "Suzumizaki-Kimitaka(\u9234\u898b\u54b2 \u541b\u9ad8)", "author_email": "info@h12u.com", "bugtrack_url": null, "classifiers": [ "Development Status :: 5 - Production/Stable", "Environment :: Console", "Environment :: Web Environment", "Framework :: Sphinx", "Framework :: Sphinx :: Extension", "Intended Audience :: Developers", "Intended Audience :: Education", "License :: OSI Approved :: BSD License", "Operating System :: OS Independent", "Programming Language :: Python", "Programming Language :: Python :: 2", "Programming Language :: Python :: 3", "Topic :: Documentation", "Topic :: Documentation :: Sphinx", "Topic :: Text Processing", "Topic :: Utilities" ], "description": "unicode_ids extension\n=====================\n\n.. note::\n\n Japanese version of this document is also available, on the `site\n `_ or the doc\n folder of this package.\n\n.. role:: fn_rst\n\nIntroduction\n------------\nCurrently, June 3, 2015, Sphinx 1.3.1 generates 'id' attributes\nin HTML without Non-ASCII characters. This behavior is requirement\nof HTML4.01.\n\nBut today, these characters can be usable with latest web browsers\nand HTML5 specification.\n\nAlso, the Sphinx replaces non-ASCII URLs into ASCII only with\nimcompatible way against current web standards.\n\nThis extension fixes both problems above at every runtime.\nThe patchs is applied to both docutils and Sphinx to make ideal\nbehavior.\n\nLicense\n-------\n2-clause BSD, same as the Sphinx project.\n\nInstallation\n------------\nYou can install or uninstall this package like another Python packages.\nAlso, you can use this package without installing this package on your Python\nsystems, the configuration file of Sphinx(:fn_rst:`conf.py`) enable you to use.\n\nSystem requirements\n...................\nTested with 32bit version of Python 2.7.10 and 64bit version of 3.4.3,\nboth on the Microsoft Windows 8.1 Pro 64bit edition. But with another\nversions and on another OSs would be usable.\n\nPython 3 is required if you need full unicode support.\nWhen used with Python 2, the usable character set is limited\nwith local encoding.\n\nThere's a thing important to know: This extension depends on both\ndocutils 0.12 and Sphinx 1.3.1. The patching is usable *UNTIL* the\nsome functions keep same as ones on these versions.\n\nHow to install\n..............\nYou can install this package as you will do with another one.\n\n#. Open a console and do :code:`pip install unicode_ids`.\n\n On the MS-Windows,\n :code:`\\Scripts\\pip.exe install unicode_ids`.\n\n#. Or when you get zip archive like :fn_rst:`unicode_ids-2.0.5(.zip)`\n where '2.0.5' is version number,\n change current directiory to the folder that has the zip file,\n and do :code:`pip install unicode_ids-2.0.5.zip`.\n\n On the MS-Windows,\n :code:`\\Scripts\\pip.exe install unicode_ids-2.0.5.zip`.\n\n#. Or, this way is the Sphinx specific, you can use this package just extracted\n any folder you want. the :fn_rst:`conf.py` enables you to use the themes and\n extensions.\n\nHow to use\n----------\nAs another extensions, you can use this extension by editing :fn_rst:`conf.py`.\n\nFirst, you should add:\n\n.. code-block:: python\n\n # add 3 lines below\n import distutils.sysconfig\n site_package_path = distutils.sysconfig.get_python_lib()\n sys.path.insert(0, os.path.join(site_package_path, 'sphinxcontrib/unicode_ids'))\n\nOr, when you don't install with pip or like,\n\n.. code-block:: python\n\n # add just 1 line below\n sys.path.insert(0, '')\n\nNext, add unicode_ids extension into :code:`extension` list:\n\n.. code-block:: python\n\n extension = ['unicode_ids', ] # Of course you can add another extensions.\n\nHow to know Unicode is acceptable with identifiers\n--------------------------------------------------\nThis section is written at 2015-06-03(JST, UTC+9).\n\nURI general with HTML\n.....................\nHTML4.01 [HTML401]_ restricts usable characters :code:`A-Za-z0-9_:.`\nand hypen `-`. But also recommends how to do with\n`B.2.1 Non-ASCII characters in URI attribute values\n`_.\n\nBy transforming as told at the section, the URIs consist of\nASCII 7 bit characters only. In the HTML4.01, we should always\nUTF-8 to encode/decode URIs, but also be noted some old documents\nmay expect another local encoding to encode/decode.\n\nHTML5 [HTML5]_ [HTML51]_ specification has the section `2.5 URLs\n`_.\nThe section shows more complex way to determine the encodings.\nWhen the URL is given with local encodings or source documents are\nencoded with local encoding, we should use that one instead of UTF-8.\n\nConsidering both specifications, we should always make HTML files with\nUTF-8 encoded, to make clear percent hexadecimal arrays represent unicode\nstring transformed by UTF-8. \n\nThere're another standards, W3C URL [W3CURL]_ and \nWHATWG URL Living Standard [WHATWGURL]_ .\nThey also defines URL code units, URL code points and percent-encoded bytes.\nThey say the percent-encoded bytes should represent UTF-8 sequences.\n\nIdentifiers (anchors) on HTML\n.............................\nHTML5 defines 'id' attribute(see `3.2.5.1 The id attribute\n`_) as \nthe `unique identifier `_.\n\nIn the explanation of the word 'DOM' described the\n`2.2.2 Dependencies\n`_\nsection, you can know 'The concept of an element\\'s unique\nidentifier (ID)' is one of the 'features are defined in the\nDOM specification'.\n\nIn DOM4 [DOM4]_ , `5.8 Interface Element\n`_\ndefines the 'id' attribute as :code:`DOMString` and the\nspecification says the `Elements can have an associated unique\nidentifier (ID) `_.\n\nAs described at `9 Historical/9.2 DOM Core\n`_, :code:`DOMString` is now\n'defined in Web IDL'.\n\nWith W3C WebIDL [WebIDL]_ \nat `3.10.15 DOMString\n`_ section,\nthe DOMString is defined as a sequence of code units.\nThe `code unit `_\nis also defined on the WebIDL as a 16 bit unsigned integer,\nand is corresponding to UTF-16 encoding.\n\nAs shown, we can know the IDs of the HTML elements can be\nwritten with unicode characters. That can be considered\nUTF-16 encoded internally. Note that current CSS3 does not\nallow starting with digits, two hyphens or a hyphen followed\nby a digit(see next section).\n\nNote that DOM3 defines :code:`DOMString` at DOM3CORE [DOM3CORE]_,\nsee the section `1.2.1 The DOMString Type\n`_.\n\nIdentifiers on CSS\n..................\nCascading Style Sheet(CSS) is now level 3. Starts from CSS3, the stability is\ndefined module by module which are defined CSS 2.1.(see\nthe `1.1 Introduction `_ section of\nCSS Snapshot 2010 [CSSSnapshot]_ .\n\nOn CSS2.1 [CSS21]_ [CSS22]_ `4.1.3 Characters and case\n`_ section\nshows the set of the characters we can use to define identifiers.\nThe 2nd paragraph says:\n\n In CSS, identifiers (including element names, classes, and IDs in selectors)\n can contain only the characters [a-zA-Z0-9] and ISO 10646 characters U+00A0\n and higher, plus the hyphen (-) and the underscore (_); they cannot start\n with a digit, two hyphens, or a hyphen followed by a digit ...(snip)\n\nAs shown above, we can use Non-ASCII characters for identifiers. ISO 10646 is\nalmost same with Unicode. And currently, CSS3 seems to use same definition for\nthe identifiers.\n\nIdentifiers on JavaScript/ECMAScript\n....................................\nECMAScript [ECMAScript]_ is the name of global standard of JavaScript, roughly to say :)\n\nIn the specification of the ECMAScript, the section `7.6 Identifier Names\nand Identifiers `_\nshows usable characters for identifiers.\n\nThe section clearly allows use Unicode characters. It seems some character\ngroup are not able to use, but in fact, the rule contains 'Unicode escape\nsequence'. This means finally any character we can use.\n\nRelated products\n----------------\n- `sphinx_html5_basic_theme `_\n\nAuthor\n------\nSuzumizaki-Kimitaka, 2011-2015\n\nHistory\n-------\n2.0.5(2015-07-04):\n\n - Extracted alone from Yogosyu_ extension.\n - First uploaded to PyPI.\n\n2013-12-07:\n\n Add Python 3 support.\n\n2013-12-06:\n\n updated to meet Sphinx 1.2.\n\n2011-05-24:\n\n First release. Included in Yogosyu_ extension.\n\n.. _Yogosyu: https://pypi.python.org/pypi/yogosyu\n\nReferences\n----------\n.. [HTML401] `HTML 4.01 `_, \\\n `1999-12-24REC `_\n\n.. [HTML5] `HTML 5 `_, \\\n `2014-10-28REC `_ \n\n.. [HTML51] `HTML 5.1 `_, \\\n `2015-05-06WD `_\n\n.. [W3CURL] `W3C URL `_, \\\n `2015-12-09WD `_\n\n.. [WHATWGURL] `WHATWG URL Living Standard `_\n\n.. [DOM4] `W3C DOM 4 `_, \\\n `2015-04-28LC `_\n\n.. [WebIDL] `(W3C) WebIDL `_, \\\n `2012-04-19CR `_\n\n.. [DOM3CORE] `DOM Level 3 Core `_, \\\n `2004-04-07REC `_\n\n.. [CSSSnapshot] `CSS Snapshot 2010 `_, \\\n `2011-05-12NOTE `_\n\n.. [CSS21] `CSS 2.1 `_, \\\n `2011-06-07REC `_ \n\n.. [CSS22] `CSS 2.2 `_, \\\n 2015-05-28WD(only permalink is broken)\n\n.. [ECMAScript] `ECMAScript 5.1 `_", "description_content_type": null, "docs_url": null, "download_url": "UNKNOWN", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "http://h12u.com/sphinx/unicode_ids/", "keywords": null, "license": "BSD", "maintainer": null, "maintainer_email": null, "name": "unicode_ids", "package_url": "https://pypi.org/project/unicode_ids/", "platform": "any", "project_url": "https://pypi.org/project/unicode_ids/", "project_urls": { "Download": "UNKNOWN", "Homepage": "http://h12u.com/sphinx/unicode_ids/" }, "release_url": "https://pypi.org/project/unicode_ids/2.0.5/", "requires_dist": null, "requires_python": null, "summary": "Enable Sphinx to generate non-ASCII identifiers", "version": "2.0.5" }, "last_serial": 1618898, "releases": { "2.0.5": [ { "comment_text": "", "digests": { "md5": "264182fb22cfefcd18f34e62e033bba4", "sha256": "385dec8bd853d4c45f168a7f07249fe70fa36e835cce66478ec71c9dc1277797" }, "downloads": -1, "filename": "unicode_ids-2.0.5-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "264182fb22cfefcd18f34e62e033bba4", "packagetype": "bdist_wheel", "python_version": "2.7", "requires_python": null, "size": 246033, "upload_time": "2015-07-04T03:47:41", "url": "https://files.pythonhosted.org/packages/74/aa/bd89f9e15b3077a4aeaa414bdbb5a6012b53609eef3cb7a8bc447c07c1bf/unicode_ids-2.0.5-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "0082c60418a84d7326d81711fcce5bde", "sha256": "45f7392baeaf55e448603b91ceb940509745e9d892422e5ec10b9f48fa155b6b" }, "downloads": -1, "filename": "unicode_ids-2.0.5.zip", "has_sig": false, "md5_digest": "0082c60418a84d7326d81711fcce5bde", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 312974, "upload_time": "2015-07-04T03:47:37", "url": "https://files.pythonhosted.org/packages/7c/d5/385a85a3d4976b4d978365c3fdf56d4c590858b829fbf135d8ed0bbef818/unicode_ids-2.0.5.zip" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "264182fb22cfefcd18f34e62e033bba4", "sha256": "385dec8bd853d4c45f168a7f07249fe70fa36e835cce66478ec71c9dc1277797" }, "downloads": -1, "filename": "unicode_ids-2.0.5-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "264182fb22cfefcd18f34e62e033bba4", "packagetype": "bdist_wheel", "python_version": "2.7", "requires_python": null, "size": 246033, "upload_time": "2015-07-04T03:47:41", "url": "https://files.pythonhosted.org/packages/74/aa/bd89f9e15b3077a4aeaa414bdbb5a6012b53609eef3cb7a8bc447c07c1bf/unicode_ids-2.0.5-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "0082c60418a84d7326d81711fcce5bde", "sha256": "45f7392baeaf55e448603b91ceb940509745e9d892422e5ec10b9f48fa155b6b" }, "downloads": -1, "filename": "unicode_ids-2.0.5.zip", "has_sig": false, "md5_digest": "0082c60418a84d7326d81711fcce5bde", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 312974, "upload_time": "2015-07-04T03:47:37", "url": "https://files.pythonhosted.org/packages/7c/d5/385a85a3d4976b4d978365c3fdf56d4c590858b829fbf135d8ed0bbef818/unicode_ids-2.0.5.zip" } ] }