{
"info": {
"author": "Daniil Minukhin",
"author_email": "ddddsa@gmail.com",
"bugtrack_url": null,
"classifiers": [
"Development Status :: 5 - Production/Stable",
"Environment :: Console",
"Intended Audience :: Developers",
"License :: OSI Approved :: MIT License",
"Operating System :: OS Independent",
"Programming Language :: Python",
"Topic :: Documentation",
"Topic :: Utilities"
],
"description": "\n\n# Confluence backend for Foliant\n\nConfluence backend generates confluence articles and uploads them on your confluence server. It can create and edit pages in Confluence with content based on your Foliant project.\n\nIt also has a feature of restoring the user inline comments, added for the article, even after the commented fragment was changed.\n\nThis backend adds the `confluence` target for your Foliant `make` command.\n\n## Installation\n\n```bash\n$ pip install foliantcontrib.confluence\n```\n\n> The backend requires [Pandoc](https://pandoc.org/) to be installed in your system. Pandoc is needed to convert Markdown into HTML.\n\n## Usage\n\nTo upload a Foliant project to Confluence server use `make confluence` command:\n\n```bash\n$ foliant make confluence\nParsing config... Done\nMaking confluence... Done\n\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\nResult:\nhttps://my_confluence_server.org/pages/viewpage.action?pageId=123 (Page Title)\n```\n\n## Config\n\nYou have to set up correct config for this backend to work properly.\n\nSpecify all options in `backend_config.confluence` section:\n\n```yaml\nbackend_config:\n confluence:\n host: 'https://my_confluence_server.org'\n login: user\n password: user_password\n id: 124443\n title: Title of the page\n space_key: \"~user\"\n parent_id: 124442\n parent_title: Parent\n notify_watchers: false\n toc: false\n restore_comments: true\n resolve_if_changed: false\n pandoc_path: pandoc\n```\n\n`host`\n: **Required** Host of your confluence server.\n\n`login`\n: Login of the user who has permissions to create and update pages. If login is not supplied, it will be prompted during build.\n\n`password`\n: Password of the user. If password is not supplied, it will be prompted during build.\n\n`id`\n: ID of the page where the content will be uploaded. *Only for already existing pages*\n\n`title`\n: Title of the page to be created or updated.\n\n> Remember that page titles in the space have to be unique.\n\n`space_key`\n: The space key where the page(s) will be created/edited. *Only for not yet existing pages*.\n\n`parent_id`\n: ID of the parent page under which the new one(s) should be created. *Only for not yet existing pages*.\n\n`parent_title`\n: Another way to define parent of the page. Lower priority than `paren_di`. Title of the parent page under which the new one(s) should be created. Parent should exist under the space_key specified. *Only for not yet existing pages*.\n\n`notify_watchers`\n: If `true` \u2014 watchers will be notified that the page has changed. Default: `false`\n\n`toc`\n: Set to `true` to add table of contents to the beginning of the document. Default: `false`\n\n`restore_comments`\n: Attempt to restore inline comments near the same places after updating the page. Default: `true`\n\n`resolve_if_changed`\n: Delete inline comment from the source if the commented text was changed. This will automatically mark comment as resolved. Default: `false`\n\n`pandoc_path`\n: Path to Pandoc executable (Pandoc is used to convert Markdown into HTML).\n\n# User's guide\n\n## Uploading articles\n\nBy default if you specify `id` or `space_key` and `title` in foliant.yml, the whole project will be built and uploaded to this page.\n\nIf you wish to upload separate chapters into separate articles, you need to specify the respective `id` or `space_key` and `title` in *meta section* of the chapter.\n\nMeta section is a YAML-formatted field-value section in the beginning of the document, which is defined like this:\n\n```yaml\n---\nfield: value\nfield2: value\n---\n\nYour chapter md-content\n```\n\nIf you want to upload a chapter into confluence, add its properties under the `confluence` key like this:\n\n```yaml\n---\nconfluence:\n title: My confluence page\n space_key: \"~user\"\n---\n\nYou chapter md-content\n```\n\n> **Important notice!**\n> Both modes work together. If you specify the `id1` in foliant.yml and `id2` in chapter's meta \u2014 the whole project will be uploaded to the page with `id1`, and the specific chapter will also be uploaded to page with `id2`.\n\n## Creating pages\n\nIf you want a new page to be created for content in your Foliant project, just supply in foliant.yml the space key and a title which does not yet exist in this space. Remember that in Confluence page titles are unique inside one space. If you use a title of an already existing page, the backend will attempt to edit it and replace its content with your project.\n\nExample config for this situation is:\n\n```yaml\nbackend_config:\n confluence:\n host: https://my_confluence_server.org\n login: user\n password: pass\n title: My unique title\n space_key: \"~user\"\n```\n\nNow if you change the title in your config, confluence will *create a new page with the new title*, leaving the old one intact.\n\nIf you want to change the title of your page, the answer is in the following section.\n\n## Updating pages\n\nGenerally to update the page contents you may use the same config you used to create it (see previous section). If the page with specified title exists, it will be updated.\n\nAlso, you can just specify the id of an existing page. After build its contents will be updated.\n\n```yaml\nbackend_config:\n confluence:\n host: https://my_confluence_server.org\n login: user\n password: pass\n id: 124443\n```\n\nThis is also *the only* way to edit a page title. If `title` param is specified, the backend will attempt to change the page's title to the new one:\n\n```yaml\nbackend_config:\n confluence:\n host: https://my_confluence_server.org\n login: user\n password: pass\n id: 124443\n title: New unique title\n```\n\n## Updating part of a page\n\nConfluence backend can also upload an article into the middle of a Confluence page, leaving all the rest of it intact. To do this you need to add an *Anchor* into your page in the place where you want Foliant content to appear.\n\n1. Go to Confluence web interface and open the article.\n2. Go to Edit mode.\n3. Put the cursor in the position where you want your Foliant content to be inserted and start typing `{anchor` to open the macros menu and locate the Anchor macro.\n4. Add an anchor with the name `foliant`.\n5. Save the page.\n\nNow if you upload content into this page (see two previous sections), Confluence backend will leave all text which was before and after the anchor intact, and add your Foliant content in the middle.\n\nYou can also add two anchors: `foliant_start` and `foliant_end`. In this case all text between these anchors will be replaced by your Foliant content.\n\n## Inserting raw confluence tags\n\nIf you want to supplement your page with confluence macros or any other storage-specific html, you may do it by wrapping them in the `` tag.\n\nFor example, if you wish to add a table of contents into the middle of the document for some reason, you can do something like this:\n\n```html\nLorem ipsum dolor sit amet, consectetur adipisicing elit. Odit dolorem nulla quam doloribus delectus voluptate.\n\n\n\nLorem ipsum dolor sit amet, consectetur adipisicing elit. Officiis, laboriosam cumque soluta sequi blanditiis, voluptatibus quaerat similique nihil debitis repellendus.\n```\n\n\n",
"description_content_type": "text/markdown",
"docs_url": null,
"download_url": "",
"downloads": {
"last_day": -1,
"last_month": -1,
"last_week": -1
},
"home_page": "https://github.com/foliant-docs/foliantcontrib.confluence",
"keywords": "",
"license": "MIT",
"maintainer": "",
"maintainer_email": "",
"name": "foliantcontrib.confluence",
"package_url": "https://pypi.org/project/foliantcontrib.confluence/",
"platform": "any",
"project_url": "https://pypi.org/project/foliantcontrib.confluence/",
"project_urls": {
"Homepage": "https://github.com/foliant-docs/foliantcontrib.confluence"
},
"release_url": "https://pypi.org/project/foliantcontrib.confluence/0.6.3/",
"requires_dist": [
"foliant (>=1.0.8)",
"atlassian-python-api",
"foliantcontrib.utils.combined-options (>=1.0.6)",
"foliantcontrib.utils.preprocessor-ext (>=1.0.2)",
"foliantcontrib.flatten (>=1.0.5)",
"foliantcontrib.meta (>=1.1.0)",
"beautifulsoup4"
],
"requires_python": "",
"summary": "Confluence backend for Foliant documentation generator.",
"version": "0.6.3"
},
"last_serial": 5937905,
"releases": {
"0.4.0": [
{
"comment_text": "",
"digests": {
"md5": "e19a7ed630c45150c33de8846bc7c5ab",
"sha256": "e46d9fa0e055c6b017977ab343a8618586c377156d81aa83b1c4b4b160f175f5"
},
"downloads": -1,
"filename": "foliantcontrib.confluence-0.4.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "e19a7ed630c45150c33de8846bc7c5ab",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 13100,
"upload_time": "2019-08-23T12:23:20",
"url": "https://files.pythonhosted.org/packages/2b/7a/5dd50fdab923ef3967fedb8dd18edca5539c0e096dfcb85b38f3ba83f2bb/foliantcontrib.confluence-0.4.0-py3-none-any.whl"
},
{
"comment_text": "",
"digests": {
"md5": "61eec1a17e5d5e78e5d6d659e36eae56",
"sha256": "b378efa98809da346f7ae621747a9f40c9e73e897d0f63c11aa60914589650e5"
},
"downloads": -1,
"filename": "foliantcontrib.confluence-0.4.0.tar.gz",
"has_sig": false,
"md5_digest": "61eec1a17e5d5e78e5d6d659e36eae56",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 13233,
"upload_time": "2019-08-23T12:23:23",
"url": "https://files.pythonhosted.org/packages/5e/6c/40b0c18ac7847e4b38b2702e49e0b6cb55b061f2aede8d8aa4528a043ae4/foliantcontrib.confluence-0.4.0.tar.gz"
}
],
"0.4.1": [
{
"comment_text": "",
"digests": {
"md5": "a0c523d94adf750d2f0d9ede1f4767cf",
"sha256": "90c878365e380361095ed6635a7b564129d2684c4faec46a62db74bd8b6079ac"
},
"downloads": -1,
"filename": "foliantcontrib.confluence-0.4.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "a0c523d94adf750d2f0d9ede1f4767cf",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 12585,
"upload_time": "2019-08-26T13:43:48",
"url": "https://files.pythonhosted.org/packages/a3/f1/4b1f7acc21cda3f7ce49cebc2cfe226e081b61913da457178eb7f4377d9e/foliantcontrib.confluence-0.4.1-py3-none-any.whl"
},
{
"comment_text": "",
"digests": {
"md5": "088ac6da90d25c728fd88bd3f3e8558b",
"sha256": "56897c245a46370fbaf9d5eb116104d8c0f15969f75b02d53bd95683b1f54049"
},
"downloads": -1,
"filename": "foliantcontrib.confluence-0.4.1.tar.gz",
"has_sig": false,
"md5_digest": "088ac6da90d25c728fd88bd3f3e8558b",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 13055,
"upload_time": "2019-08-26T13:43:50",
"url": "https://files.pythonhosted.org/packages/17/c2/2f52ba9084de5d793758e27e912098d3604f977bf4d167566c9e2d25c099/foliantcontrib.confluence-0.4.1.tar.gz"
}
],
"0.5.2": [
{
"comment_text": "",
"digests": {
"md5": "67b9e67f753500335f0f746f513f9863",
"sha256": "4be6d28e6fae55f40ffb40e94e4c1823ca2ab34329cc15ff79741d66d1b71d5a"
},
"downloads": -1,
"filename": "foliantcontrib.confluence-0.5.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "67b9e67f753500335f0f746f513f9863",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 16934,
"upload_time": "2019-09-23T07:18:06",
"url": "https://files.pythonhosted.org/packages/f2/e2/7cbec5c1a52fd504694e99e0997ff0be288f5d0a32e1edc7197b03f85a36/foliantcontrib.confluence-0.5.2-py3-none-any.whl"
},
{
"comment_text": "",
"digests": {
"md5": "476b611a87b584c681d7b93c71cf4ffe",
"sha256": "a63ce36cae487dcc90c1206d32be58fbf03b27f1569a92977629bf1a93879e84"
},
"downloads": -1,
"filename": "foliantcontrib.confluence-0.5.2.tar.gz",
"has_sig": false,
"md5_digest": "476b611a87b584c681d7b93c71cf4ffe",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 17391,
"upload_time": "2019-09-23T07:18:08",
"url": "https://files.pythonhosted.org/packages/f4/90/d9dc4bd3969f90b4407737e92e32a7c329ae302fca0bd3be9a9fe01fbebf/foliantcontrib.confluence-0.5.2.tar.gz"
}
],
"0.6.0": [
{
"comment_text": "",
"digests": {
"md5": "53725b5545965790c2ce233452cffa45",
"sha256": "6923f216ca8eedcf1d8dc31ef7a80509d140b3e10cd50747a583481cc33160b6"
},
"downloads": -1,
"filename": "foliantcontrib.confluence-0.6.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "53725b5545965790c2ce233452cffa45",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 20625,
"upload_time": "2019-09-30T13:41:58",
"url": "https://files.pythonhosted.org/packages/77/d2/fcc205d01badb4d7b50daf75758d39febb61a2ce5f803a6f2271969d8fd2/foliantcontrib.confluence-0.6.0-py3-none-any.whl"
},
{
"comment_text": "",
"digests": {
"md5": "4653ba48e7e235540f35fc4e43d50e0e",
"sha256": "e308ca973b926a3992513b90d975d31f7e560f072c75ef18f1bfe328dbf06e12"
},
"downloads": -1,
"filename": "foliantcontrib.confluence-0.6.0.tar.gz",
"has_sig": false,
"md5_digest": "4653ba48e7e235540f35fc4e43d50e0e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 20122,
"upload_time": "2019-09-30T13:41:59",
"url": "https://files.pythonhosted.org/packages/f1/15/0052dcbdb1fcc5ac459b5d45dd1acdd2125de3e21be8e4853b03bdb3593e/foliantcontrib.confluence-0.6.0.tar.gz"
}
],
"0.6.1": [
{
"comment_text": "",
"digests": {
"md5": "aa128695b8c7acd51df55096ddb4f42d",
"sha256": "ef04fea81c5ab791e63ce1253c7952b07cccfc08558d57b7d3cc5577d688e84c"
},
"downloads": -1,
"filename": "foliantcontrib.confluence-0.6.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "aa128695b8c7acd51df55096ddb4f42d",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 20906,
"upload_time": "2019-10-01T09:15:30",
"url": "https://files.pythonhosted.org/packages/d8/04/66890bf4561431376fe6971d271671ba0f840d6697b5a094d4c6a57cf332/foliantcontrib.confluence-0.6.1-py3-none-any.whl"
},
{
"comment_text": "",
"digests": {
"md5": "da1628338b821e7947f05b3e0b9a0614",
"sha256": "6244f42f2b592447a535b2250a06229094685ba7f7688ce15c7808c47005ba20"
},
"downloads": -1,
"filename": "foliantcontrib.confluence-0.6.1.tar.gz",
"has_sig": false,
"md5_digest": "da1628338b821e7947f05b3e0b9a0614",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 20453,
"upload_time": "2019-10-01T09:15:32",
"url": "https://files.pythonhosted.org/packages/83/5a/8f1d2fac1bb954928aa64d479d2cd6ffb5464fe8b4b443aa55c98680d193/foliantcontrib.confluence-0.6.1.tar.gz"
}
],
"0.6.2": [
{
"comment_text": "",
"digests": {
"md5": "09a9c0af79d17174e0ccfd1b33e74871",
"sha256": "d3e4870ada14610020b8518786c735c4dc7819e5ebefbd85e60d4580f76095e2"
},
"downloads": -1,
"filename": "foliantcontrib.confluence-0.6.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "09a9c0af79d17174e0ccfd1b33e74871",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 20905,
"upload_time": "2019-10-01T09:56:40",
"url": "https://files.pythonhosted.org/packages/82/a9/e1ccfd1059e1a64fef7f1b041b6e60ad32c7d5849c5583e104189f316701/foliantcontrib.confluence-0.6.2-py3-none-any.whl"
},
{
"comment_text": "",
"digests": {
"md5": "8a25fe225af72c4f7c0191b5446e91d6",
"sha256": "05f8314b8d6ab579d4ae2a7053f0350438b5b8df092df591a9a9761ca4100065"
},
"downloads": -1,
"filename": "foliantcontrib.confluence-0.6.2.tar.gz",
"has_sig": false,
"md5_digest": "8a25fe225af72c4f7c0191b5446e91d6",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 20454,
"upload_time": "2019-10-01T09:56:41",
"url": "https://files.pythonhosted.org/packages/1c/91/c4ea4bc013fa44ff1c0a143ddd86f3345d1f528b2140118987895da06117/foliantcontrib.confluence-0.6.2.tar.gz"
}
],
"0.6.3": [
{
"comment_text": "",
"digests": {
"md5": "fb448941991bd73d0729f9b78c6bb1e3",
"sha256": "be63675abb297cfbc38f7a3e54723cb9f22a2362ed606c2463405f4810de120b"
},
"downloads": -1,
"filename": "foliantcontrib.confluence-0.6.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "fb448941991bd73d0729f9b78c6bb1e3",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 21051,
"upload_time": "2019-10-07T09:44:27",
"url": "https://files.pythonhosted.org/packages/77/89/b8b0b79bb392db78e8c6b5c69f2e2a1527697f6cb77cf2eb9b18e9365db6/foliantcontrib.confluence-0.6.3-py3-none-any.whl"
},
{
"comment_text": "",
"digests": {
"md5": "51c3df5fd65ba1592b3fbb2126e30cd2",
"sha256": "4cb4140242ee8e83c7dbb31f3fb54bbfe4ad36341ef892d5998802a20b3d36c5"
},
"downloads": -1,
"filename": "foliantcontrib.confluence-0.6.3.tar.gz",
"has_sig": false,
"md5_digest": "51c3df5fd65ba1592b3fbb2126e30cd2",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 17789,
"upload_time": "2019-10-07T09:44:29",
"url": "https://files.pythonhosted.org/packages/68/91/2e889e19f00f8b1dd9a21104a2d4884b3593aab42e99926e43b54069909e/foliantcontrib.confluence-0.6.3.tar.gz"
}
]
},
"urls": [
{
"comment_text": "",
"digests": {
"md5": "fb448941991bd73d0729f9b78c6bb1e3",
"sha256": "be63675abb297cfbc38f7a3e54723cb9f22a2362ed606c2463405f4810de120b"
},
"downloads": -1,
"filename": "foliantcontrib.confluence-0.6.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "fb448941991bd73d0729f9b78c6bb1e3",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 21051,
"upload_time": "2019-10-07T09:44:27",
"url": "https://files.pythonhosted.org/packages/77/89/b8b0b79bb392db78e8c6b5c69f2e2a1527697f6cb77cf2eb9b18e9365db6/foliantcontrib.confluence-0.6.3-py3-none-any.whl"
},
{
"comment_text": "",
"digests": {
"md5": "51c3df5fd65ba1592b3fbb2126e30cd2",
"sha256": "4cb4140242ee8e83c7dbb31f3fb54bbfe4ad36341ef892d5998802a20b3d36c5"
},
"downloads": -1,
"filename": "foliantcontrib.confluence-0.6.3.tar.gz",
"has_sig": false,
"md5_digest": "51c3df5fd65ba1592b3fbb2126e30cd2",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 17789,
"upload_time": "2019-10-07T09:44:29",
"url": "https://files.pythonhosted.org/packages/68/91/2e889e19f00f8b1dd9a21104a2d4884b3593aab42e99926e43b54069909e/foliantcontrib.confluence-0.6.3.tar.gz"
}
]
}