{"id":13443197,"url":"https://github.com/nobiot/org-transclusion","last_synced_at":"2025-05-15T00:12:42.597Z","repository":{"id":38089644,"uuid":"302860903","full_name":"nobiot/org-transclusion","owner":"nobiot","description":"Emacs package to enable transclusion with Org Mode","archived":false,"fork":false,"pushed_at":"2025-02-25T08:18:39.000Z","size":13287,"stargazers_count":990,"open_issues_count":77,"forks_count":50,"subscribers_count":21,"default_branch":"main","last_synced_at":"2025-04-13T21:34:07.488Z","etag":null,"topics":["emacs","org-mode","org-roam","transclude","transclusion","writing"],"latest_commit_sha":null,"homepage":"https://nobiot.github.io/org-transclusion/","language":"Emacs Lisp","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/nobiot.png","metadata":{"files":{"readme":"README-elpa","changelog":"CHANGELOG","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-10-10T09:06:31.000Z","updated_at":"2025-04-12T18:15:34.000Z","dependencies_parsed_at":"2024-01-13T17:09:58.170Z","dependency_job_id":"98925c44-4657-4a21-99bf-4852805c75da","html_url":"https://github.com/nobiot/org-transclusion","commit_stats":null,"previous_names":[],"tags_count":7,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nobiot%2Forg-transclusion","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nobiot%2Forg-transclusion/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nobiot%2Forg-transclusion/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nobiot%2Forg-transclusion/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/nobiot","download_url":"https://codeload.github.com/nobiot/org-transclusion/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254249206,"owners_count":22039029,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["emacs","org-mode","org-roam","transclude","transclusion","writing"],"created_at":"2024-07-31T03:01:57.396Z","updated_at":"2025-05-15T00:12:37.589Z","avatar_url":"https://github.com/nobiot.png","language":"Emacs Lisp","funding_links":[],"categories":["Emacs Lisp","Experimental/Advanced"],"sub_categories":[],"readme":"                      ━━━━━━━━━━━━━━━━━━━━━━━━━━━\n                       README – ORG-TRANSCLUSION\n                      ━━━━━━━━━━━━━━━━━━━━━━━━━━━\n\n\nTable of Contents\n─────────────────\n\n1. Example Use Cases \u0026 Main Features\n2. Installation\n3. Contributing\n4. License\n\n\nOrg-transclusion lets you insert a copy of text content via a file link\nor ID link within an Org file. It lets you have the same content present\nin different buffers at the same time without copy-and-pasting it. Edit\nthe source of the content, and you can refresh the transcluded copies to\nthe up-to-date state. Org-transclusion keeps your files clear of the\ntranscluded copies, leaving only the links to the original content.\n\nA complete user manual is available [online] or Emacs in-system as an\nInfo node `(org-transclusion)': (`C-h i' and find the `Org-transclusion'\nnode).\n\nFor installation and minimum configuration, refer to [Installation]\nbelow or the user manual: [online] or Info node\n`(org-transclusion)Installation'\n\nGetting Started in the user manual will get you started in 5 minutes:\n[online] or Info node `(org-transclusion)Getting Started'.\n\nFor customization, refer to the customization group `org-transclusion'\nor user manual: [online] or Info node `(org-transclusion)Customizing'.\n\n\n[online] \u003chttps://nobiot.github.io/org-transclusion/\u003e\n\n[Installation] See section 2\n\n[online] \u003chttps://nobiot.github.io/org-transclusion/#Installation\u003e\n\n[online] \u003chttps://nobiot.github.io/org-transclusion/#Getting-Started\u003e\n\n[online] \u003chttps://nobiot.github.io/org-transclusion/#Customizing\u003e\n\n\n1 Example Use Cases \u0026 Main Features\n═══════════════════════════════════\n\n  Here are some real use cases that users have shared with the author,\n  including his own.\n\n  Book writing\n        You have a collection of notes. You can quickly transclude\n        paragraphs and sections from your notes and put together a\n        draft. As transclusions are links, it's easy to re-organize them\n        into different sequences to see which way works the best.\n\n  Academic writing\n        You have a collection of quotes and notes from your research and\n        literature review. Transclude relevant elements of quotes and\n        notes into different papers. You can keep your collection as the\n        central repository of your research.\n\n  Technical writing\n        You write technical documents for software. Transclude relevant\n        lines of code into the document. As the code is only\n        transcluded, you can keep the document up-to-date as the code\n        evolves.\n\n  Project status reports\n        You work on multiple projects at the same time and need to\n        report to different project managers. Transclude relevant parts\n        of your work notes and logs into respective project reports. You\n        can keep a single collection of your work notes and logs.\n\n  Main Features:\n\n  • Insert a copy of text content via a file link or ID link into an Org\n    file\n\n  • Work with any text file such as program source code, plain text,\n    Markdown, or other Org files\n\n  • With version 1.4, a transclusion works with hyper:// links (see\n    [hyperdrive.el])\n  or \u003chttp://\u003e links. Splitting the org-transclusion-add into two parts\n  enables functions in org-transclusion-add-functions to be\n  asynchronous. With this change, content can be transcluded over a\n  network, using \u003chttp://\u003e, hyper://, or other protocols. For a\n  proof-of-concept integration with hyperdrive.el, see [this file].\n\n  • Keep the file system clear of the copies of text content –\n    Org-transclusion tries hard to save only the links to the file\n    system\n\n  • For Org files, use different headline levels from the source Org\n    file\n\n  • For Org files, use filters to include only relevant elements (e.g.\n    filter out properties in the transclusions)\n\n  • For program source and plain text files, transclude a certain lines\n    or dynamically specify the from/to lines to keep the transclusion\n    always up-to-date with the evolving source files\n\n  • For program source files, transclude parts or whole code directly\n    into Org's source block to leverage the rich Org features including\n    noweb style syntax\n\n  • Extend Org-transclusion with its extension framework\n\n\n[hyperdrive.el] \u003chttps://git.sr.ht/~ushin/hyperdrive.el\u003e\n\n[this file]\n\u003chttps://git.sr.ht/~ushin/hyperdrive.el/tree/org-transclusion/item/hyperdrive-org-transclusion.el\u003e\n\n\n2 Installation\n══════════════\n\n  This package is available on:\n\n  • [GNU ELPA] (releases only; equivalent to MELPA-Stable)\n  • [GNU-devel ELPA] (unreleased development branch; equivalent to\n    MELPA)\n\n  GNU ELPA should be already set up in your Emacs by default. If you\n  wish to add GNU-devel ELPA, simply add its URL to `package-archives'\n  like this:\n\n  ┌────\n  │ (add-to-list 'package-archives\n  │              '(\"gnu-devel\" . \"https://elpa.gnu.org/devel/\") :append)\n  └────\n\n  Refresh the archive with `M-x package-refresh-contents RET' and you\n  can do `M-x package-install RET org-transclusion' to install it.\n  Alternatively, you can use `package-list-packages'.\n\n  After installation, you can start using Org-transclusion with no\n  additional configuration. Below are some example keybindings that can\n  be put into your Emacs configuration.\n\n  ┌────\n  │ (define-key global-map (kbd \"\u003cf12\u003e\") #'org-transclusion-add)\n  │ (define-key global-map (kbd \"C-n t\") #'org-transclusion-mode)\n  └────\n\n  For Doom users, you would need to do something like this below to\n  install the package and configure the keybindings.\n\n  ┌────\n  │ ;; ~/.doom.d/package.el\n  │ (package! org-transclusion)\n  └────\n\n  ┌────\n  │ ;; ~/.doom.d/config.el\n  │ (use-package! org-transclusion\n  │   :after org\n  │   :init\n  │   (map!\n  │    :map global-map \"\u003cf12\u003e\" #'org-transclusion-add\n  │    :leader\n  │    :prefix \"n\"\n  │    :desc \"Org Transclusion Mode\" \"t\" #'org-transclusion-mode))\n  └────\n\n\n[GNU ELPA] \u003chttps://elpa.gnu.org/packages/org-transclusion.html\u003e\n\n[GNU-devel ELPA] \u003chttps://elpa.gnu.org/devel/org-transclusion.html\u003e\n\n\n3 Contributing\n══════════════\n\n  • Get involved in a discussion in [Org-roam forum] (the package is\n    originally aimed for its users, the author included)\n\n  • Create issues, discussion, and/or pull requests. All welcome.\n\n  Org-transclusion is part of GNU ELPA and thus copyrighted by the [Free\n  Software Foundation] (FSF). This means that anyone who is making a\n  substantive code contribution will need to \"assign the copyright for\n  your contributions to the FSF so that they can be included in GNU\n  Emacs\" ([Org Mode website]).\n\n  Thank you.\n\n\n[Org-roam forum]\n\u003chttps://org-roam.discourse.group/t/prototype-transclusion-block-reference-with-emacs-org-mode/830\u003e\n\n[Free Software Foundation] \u003chttp://fsf.org\u003e\n\n[Org Mode website] \u003chttps://orgmode.org/contribute.html#copyright\u003e\n\n\n4 License\n═════════\n\n  Org-transclusion is licensed under a GPLv3 license. For a full copy of\n  the license, refer to [LICENSE].\n\n\n[LICENSE] \u003c./LICENSE\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnobiot%2Forg-transclusion","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnobiot%2Forg-transclusion","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnobiot%2Forg-transclusion/lists"}