{ "info": { "author": "Ben Whalley", "author_email": "benwhalley@gmail.com", "bugtrack_url": null, "classifiers": [], "description": "Pan\n==============================================================================\n\nA python command line tool with sane defaults for building academic articles \nfrom markdown using pandoc and (optionally) Stata.\n\n\nInstallation\n--------------------\n\nYou will need to install pandoc first: http://johnmacfarlane.net/pandoc/installing.html\n\nThe install with pip::\n\t\n\tsudo pip install pan\n\t\nSudo is only needed to install for the system python to make the command line \ntool available everywhere; you can install in a virtualenv without sudo.\n\n\n\n\n\nOutput formats\n------------------\n\nrtf\n\nhtml\n\nplain\n\npdf (default)\n\n\n\n\nMarkdown header block options\n------------------------------------\n\n\nXXX \n\n\n\n\nInstructor-only content\n------------------------------------\n\nSometimes presentations or worksheets will have content for instructors only \n(e.g. suggested answers). You can hide this content by wrapping it in a div tag with the `.instructor` class::\n\n\t
Content for you only
\n\t\nThen pass in the --instructor flag (or set it in the header block) when building to get the hidden stuff too.\n\nNote: `.instructor` content is hidden by default.\n\n\t\n\n\n\nWeaving documents with Stata\n------------------------------------\n\nPan includes a Stata filter for pandoc to 'weave' documents with markdown, \nStata code and LaTeX into pdfs. This means you can include a block like this in \nyour markdown::\n\n\t~~~{.stata .run}\n\tdi 2*2\n\t~~~\n\t\nAnd see the following output in your pdf::\n\n\t. di 2*2\n\t4\n\n\nIf you want to hide some setup commands, add `>>>` after the comands you want hidden::\n\n\t~~~{.stata .run}\n\tuse somedatafile\n\t>>>\n\tdi \"this text will not be shown because it does not follow the last >>>\"\n\t>>>\n\t* but this will be shown\n\tdescribe\n\t~~~\n\nHere, the loading command will not appear in the output. Only the block of code after the last `>>>` will be displayed.\n\nYou can also add a `.hide` class to the code block and the filter will run but not display results for the code. This is useful when generating graphs etc. \n\nNote exporting png or pdf will not work when running Stata in headless mode, so use .eps instead. Data will not persist between code blocks, so will need to be loaded each time, and intermediate steps stored in temporary files.\n\n\n\n\nReferencing\n------------------------------------\n\nInclude a file called `references.bib` somewhere in the folder hierarchy of your project\nand pan will find it and pass to pandoc use it to generate a reference list. For example,\nif you have a structure like this::\n\n\treferences.bib\n\tstudies\n\t\tclever_study\n\t\t\tarticle.markdown\n\t\t\t\n\nThe pan will pass the file references.bib from the top level when you build article.markdown.\nSee the `csl` header attribute below to change citation formats.", "description_content_type": null, "docs_url": null, "download_url": "UNKNOWN", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "http://pypi.python.org/pypi/pan/", "keywords": null, "license": "LICENSE.txt", "maintainer": null, "maintainer_email": null, "name": "pan", "package_url": "https://pypi.org/project/pan/", "platform": "UNKNOWN", "project_url": "https://pypi.org/project/pan/", "project_urls": { "Download": "UNKNOWN", "Homepage": "http://pypi.python.org/pypi/pan/" }, "release_url": "https://pypi.org/project/pan/0.1.1/", "requires_dist": null, "requires_python": null, "summary": "Command line tool with sane defaults for building academic articles from markdown using pandoc.", "version": "0.1.1" }, "last_serial": 911447, "releases": { "0.1.0": [ { "comment_text": "", "digests": { "md5": "0adff2142722cfcf027259bd24185918", "sha256": "38766e6223c1b241410b822cb6d3e90d572a30a2fe7ae35301a445e4e29db2fd" }, "downloads": -1, "filename": "pan-0.1.0.tar.gz", "has_sig": false, "md5_digest": "0adff2142722cfcf027259bd24185918", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 6195, "upload_time": "2013-10-26T21:39:30", "url": "https://files.pythonhosted.org/packages/95/57/193af63457c7ffb6450d565f1db6ffe08b24661abad40532273d955e1cb7/pan-0.1.0.tar.gz" } ], "0.1.1": [ { "comment_text": "", "digests": { "md5": "d8c99f511582cee4c789b5095a13866e", "sha256": "07a24b89b88519ad76cae0b8cabc192f15dfe85bab38f96e30df40435e34ae3f" }, "downloads": -1, "filename": "pan-0.1.1.tar.gz", "has_sig": false, "md5_digest": "d8c99f511582cee4c789b5095a13866e", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 7898, "upload_time": "2013-11-05T09:34:20", "url": "https://files.pythonhosted.org/packages/08/d9/18f9e48533e4afab237572ba4e8418567131a23aee2b89f135246985d1d6/pan-0.1.1.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "d8c99f511582cee4c789b5095a13866e", "sha256": "07a24b89b88519ad76cae0b8cabc192f15dfe85bab38f96e30df40435e34ae3f" }, "downloads": -1, "filename": "pan-0.1.1.tar.gz", "has_sig": false, "md5_digest": "d8c99f511582cee4c789b5095a13866e", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 7898, "upload_time": "2013-11-05T09:34:20", "url": "https://files.pythonhosted.org/packages/08/d9/18f9e48533e4afab237572ba4e8418567131a23aee2b89f135246985d1d6/pan-0.1.1.tar.gz" } ] }