# Manim Devangari
Manim plugin for adding devanagari script.
# Table of Contents:
- [Installation](#installation)
- [Usage Devanagari](#usage-devanagari)
# Installation
- Install `pip install manim`
- Install font - `Noto Sans` and `Noto Sans Devanagari`
# Usage Devanagari
## Devanagari Template
`manim_devanagari.devanagari` supported Hindi, English and Math
### Example :
```python
from manim import *
import manim_devanagari
class DevanagariTex(Scene):
def construct(self):
dev_tex = VGroup(
Tex("धन्यावद", tex_template=manim_devanagari.devanagari),
Tex("धन्यावद (Thank you!)", tex_template=manim_devanagari.devanagari),
Tex(r"द्विघात सुत्र (Quadratic formula) \\ $x = \dfrac{-b \pm \sqrt{b^2 - 4ac}}{2a}$", tex_template=manim_devanagari.devanagari),
MathTex(r"\text{भिन्न} = \dfrac{\text{अंश}}{\text{हर}}", tex_template=manim_devanagari.devanagari)
).arrange(DOWN)
self.add(dev_tex)
```
## Devanagari Class
- A string compiled with LaTeX in normal mode
```python
manim_devanagari.Deva_Tex(...)
```
- A string compiled with LaTeX in math mode.
```python
manim_devanagari.Deva_MathTex(...)
```
### Example :
```python
from manim import *
import manim_devanagari
class Devanagari_ClassTex(Scene):
def construct(self):
dev_tex = VGroup(
manim_devanagari.Deva_Tex("धन्यावद", font_size=DEFAULT_FONT_SIZE),
manim_devanagari.Deva_Tex("धन्यावद (Thank you!)", font_size=DEFAULT_FONT_SIZE),
manim_devanagari.Deva_Tex(r"द्विघात सुत्र (Quadratic formula) \\ $x = \dfrac{-b \pm \sqrt{b^2 - 4ac}}{2a}$", font_size=DEFAULT_FONT_SIZE),
manim_devanagari.Deva_MathTex(r"\text{भिन्न} = \dfrac{\text{अंश}}{\text{हर}}", font_size=DEFAULT_FONT_SIZE)
).arrange(DOWN)
self.add(dev_tex)
```
## Cancel Class
```python
manim_devanagari.Cancel(...)
```
### Example :
```python
from manim import *
import manim_devanagari
class Cancel_Math(Scene):
def construct(self):
cancel_tex = VGroup(
manim_devanagari.Deva_MathTex(r"{{(1 + x)",r"(2 - x^2)}",r"\over",r"{(1 + x)}}", font_size=DEFAULT_FONT_SIZE),
MathTex(r"{{(1 + x)",r"(2 - x^2)}",r"\over",r"{(2 - x^2)}}")
).arrange(DOWN)
self.add(cancel_tex)
self.add(manim_devanagari.Cancel(cancel_tex[0][0]))
self.add(manim_devanagari.Cancel(cancel_tex[0][3]))
self.add(manim_devanagari.Cancel(cancel_tex[1][1]))
self.add(manim_devanagari.Cancel(cancel_tex[1][3]))
```
## Addition Feature
- Question Header
```python
manim_devanagari.Question_Header(question_no, ...)
```
- Solution Header
```python
manim_devanagari.Solution_Header() # उत्तर :
```
```python
manim_devanagari.Solution_Header(ans=False) # हल :
```
### Example :
```python
from manim import *
import manim_devanagari
class Addition_feature(Scene):
def construct(self):
footer = Rectangle(
width=self.camera.frame_width,
height=0.8,
stroke_opacity=0,
fill_color=GREEN,
fill_opacity=1,
).to_edge(DOWN / 10)
cancel_tex = VGroup(
manim_devanagari.Question_Header(1, font_size=DEFAULT_FONT_SIZE),
manim_devanagari.Solution_Header(font_size=DEFAULT_FONT_SIZE),
manim_devanagari.Solution_Header(ans=False, font_size=DEFAULT_FONT_SIZE)
).arrange(DOWN)
self.add(cancel_tex, footer)
```
# Light Mode and Custom Font Size
```python
from manim_devanagari import *
_LIGHT_MODE = True # Light Mode is true
config.background_color = WHITE
_SET_FONT_SIZE = 30
```
# Groups
## Question Group
```python
Question_Group(question_number, item_1, item_2, ..., item_n)
```
```python
Question_Group(question_number, item_1, item_2, ..., item_n)
```
## Solution Group
```python
Solution_Group((question_number, item_1), item_2, ..., item_n)
```
```python
Solution_VGroup(question_number, item_1,(item_2, ..., item_n))
```
## Answer Group
```python
Answer_Group((question_number, item_1), item_2, ..., item_n)
```
```python
Answer_VGroup(question_number, item_1,(item_2, ..., item_n))
```
# String
## String Join
Space or newline is defalult
```python
Str_Join(item_1,item_2, ..., item_n, space=False)
```
## Bookmark
```python
Bookmark(mark)
```
```
<bookmark mark='{mark}'>
```
Raw data
{
"_id": null,
"home_page": "https://github.com/avnlearn/manim-devanagari",
"name": "manim-devanagari",
"maintainer": null,
"docs_url": null,
"requires_python": "<3.13,>=3.9",
"maintainer_email": null,
"keywords": "davanagari, hindi, latex, latex cancel tag, manim",
"author": "AvN Learn",
"author_email": "avnlearn@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/00/1f/5c25cd0d6690ddde29eeb10db142e3527a4f19d140ce02cccda46deb0a4e/manim_devanagari-0.0.3.tar.gz",
"platform": null,
"description": "# Manim Devangari\n\nManim plugin for adding devanagari script.\n\n# Table of Contents:\n\n- [Installation](#installation)\n- [Usage Devanagari](#usage-devanagari)\n\n# Installation\n\n- Install `pip install manim`\n- Install font - `Noto Sans` and `Noto Sans Devanagari`\n\n# Usage Devanagari\n\n## Devanagari Template\n\n`manim_devanagari.devanagari` supported Hindi, English and Math\n\n### Example :\n\n```python\nfrom manim import *\nimport manim_devanagari\n\nclass DevanagariTex(Scene):\n def construct(self):\n dev_tex = VGroup(\n Tex(\"\u0927\u0928\u094d\u092f\u093e\u0935\u0926\", tex_template=manim_devanagari.devanagari),\n Tex(\"\u0927\u0928\u094d\u092f\u093e\u0935\u0926 (Thank you!)\", tex_template=manim_devanagari.devanagari),\n Tex(r\"\u0926\u094d\u0935\u093f\u0918\u093e\u0924 \u0938\u0941\u0924\u094d\u0930 (Quadratic formula) \\\\ $x = \\dfrac{-b \\pm \\sqrt{b^2 - 4ac}}{2a}$\", tex_template=manim_devanagari.devanagari),\n MathTex(r\"\\text{\u092d\u093f\u0928\u094d\u0928} = \\dfrac{\\text{\u0905\u0902\u0936}}{\\text{\u0939\u0930}}\", tex_template=manim_devanagari.devanagari)\n ).arrange(DOWN)\n\n self.add(dev_tex)\n```\n\n\n\n## Devanagari Class\n\n- A string compiled with LaTeX in normal mode\n\n```python\nmanim_devanagari.Deva_Tex(...)\n```\n\n- A string compiled with LaTeX in math mode.\n\n```python\nmanim_devanagari.Deva_MathTex(...)\n```\n\n### Example :\n\n```python\nfrom manim import *\nimport manim_devanagari\n\nclass Devanagari_ClassTex(Scene):\n def construct(self):\n dev_tex = VGroup(\n manim_devanagari.Deva_Tex(\"\u0927\u0928\u094d\u092f\u093e\u0935\u0926\", font_size=DEFAULT_FONT_SIZE),\n manim_devanagari.Deva_Tex(\"\u0927\u0928\u094d\u092f\u093e\u0935\u0926 (Thank you!)\", font_size=DEFAULT_FONT_SIZE),\n manim_devanagari.Deva_Tex(r\"\u0926\u094d\u0935\u093f\u0918\u093e\u0924 \u0938\u0941\u0924\u094d\u0930 (Quadratic formula) \\\\ $x = \\dfrac{-b \\pm \\sqrt{b^2 - 4ac}}{2a}$\", font_size=DEFAULT_FONT_SIZE),\n manim_devanagari.Deva_MathTex(r\"\\text{\u092d\u093f\u0928\u094d\u0928} = \\dfrac{\\text{\u0905\u0902\u0936}}{\\text{\u0939\u0930}}\", font_size=DEFAULT_FONT_SIZE)\n ).arrange(DOWN)\n\n self.add(dev_tex)\n```\n\n\n\n## Cancel Class\n\n```python\nmanim_devanagari.Cancel(...)\n```\n\n### Example :\n\n```python\nfrom manim import *\nimport manim_devanagari\n\nclass Cancel_Math(Scene):\n def construct(self):\n cancel_tex = VGroup(\n manim_devanagari.Deva_MathTex(r\"{{(1 + x)\",r\"(2 - x^2)}\",r\"\\over\",r\"{(1 + x)}}\", font_size=DEFAULT_FONT_SIZE),\n MathTex(r\"{{(1 + x)\",r\"(2 - x^2)}\",r\"\\over\",r\"{(2 - x^2)}}\")\n ).arrange(DOWN)\n\n self.add(cancel_tex)\n self.add(manim_devanagari.Cancel(cancel_tex[0][0]))\n self.add(manim_devanagari.Cancel(cancel_tex[0][3]))\n\n self.add(manim_devanagari.Cancel(cancel_tex[1][1]))\n self.add(manim_devanagari.Cancel(cancel_tex[1][3]))\n```\n\n\n\n## Addition Feature\n\n- Question Header\n\n```python\nmanim_devanagari.Question_Header(question_no, ...)\n```\n\n- Solution Header\n\n```python\nmanim_devanagari.Solution_Header() # \u0909\u0924\u094d\u0924\u0930 :\n```\n\n```python\nmanim_devanagari.Solution_Header(ans=False) # \u0939\u0932 :\n```\n\n### Example :\n\n```python\nfrom manim import *\nimport manim_devanagari\n\nclass Addition_feature(Scene):\n def construct(self):\n footer = Rectangle(\n width=self.camera.frame_width,\n height=0.8,\n stroke_opacity=0,\n fill_color=GREEN,\n fill_opacity=1,\n ).to_edge(DOWN / 10)\n\n cancel_tex = VGroup(\n manim_devanagari.Question_Header(1, font_size=DEFAULT_FONT_SIZE),\n manim_devanagari.Solution_Header(font_size=DEFAULT_FONT_SIZE),\n manim_devanagari.Solution_Header(ans=False, font_size=DEFAULT_FONT_SIZE)\n ).arrange(DOWN)\n self.add(cancel_tex, footer)\n```\n\n\n\n# Light Mode and Custom Font Size\n\n```python\nfrom manim_devanagari import *\n\n_LIGHT_MODE = True # Light Mode is true\nconfig.background_color = WHITE\n_SET_FONT_SIZE = 30\n```\n\n# Groups\n\n## Question Group\n\n```python\nQuestion_Group(question_number, item_1, item_2, ..., item_n)\n```\n\n```python\nQuestion_Group(question_number, item_1, item_2, ..., item_n)\n```\n\n## Solution Group\n\n```python\nSolution_Group((question_number, item_1), item_2, ..., item_n)\n```\n\n```python\nSolution_VGroup(question_number, item_1,(item_2, ..., item_n))\n```\n\n## Answer Group\n\n```python\nAnswer_Group((question_number, item_1), item_2, ..., item_n)\n```\n\n```python\nAnswer_VGroup(question_number, item_1,(item_2, ..., item_n))\n```\n\n# String\n\n## String Join\n\nSpace or newline is defalult\n\n```python\nStr_Join(item_1,item_2, ..., item_n, space=False)\n```\n\n## Bookmark\n\n```python\nBookmark(mark)\n```\n\n```\n<bookmark mark='{mark}'>\n```\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Devanagari plugin for manim",
"version": "0.0.3",
"project_urls": {
"Documentation": "https://github.com/avnlearn/manim-devanagari/blob/master/README.md",
"Homepage": "https://github.com/avnlearn/manim-devanagari",
"Repository": "https://github.com/avnlearn/manim-devanagari"
},
"split_keywords": [
"davanagari",
" hindi",
" latex",
" latex cancel tag",
" manim"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "4edf540d1ff9de0f3c6c5d0031ddd61114402720f7d47bc9645b8e2d533c31b3",
"md5": "d0a59db8633d43b85a5b04a1eff28ea6",
"sha256": "528113d66a9d519183b998d6c38a1a7454b9275d1a66d876cac673d1e0083c04"
},
"downloads": -1,
"filename": "manim_devanagari-0.0.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "d0a59db8633d43b85a5b04a1eff28ea6",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<3.13,>=3.9",
"size": 8573,
"upload_time": "2024-09-15T10:05:42",
"upload_time_iso_8601": "2024-09-15T10:05:42.506621Z",
"url": "https://files.pythonhosted.org/packages/4e/df/540d1ff9de0f3c6c5d0031ddd61114402720f7d47bc9645b8e2d533c31b3/manim_devanagari-0.0.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "001f5c25cd0d6690ddde29eeb10db142e3527a4f19d140ce02cccda46deb0a4e",
"md5": "bc4e513413006b548d5a9cd06799b902",
"sha256": "a6900d0a4dbb20385630d33f606efe5e7316356e43103d9b14e96dbd706283c8"
},
"downloads": -1,
"filename": "manim_devanagari-0.0.3.tar.gz",
"has_sig": false,
"md5_digest": "bc4e513413006b548d5a9cd06799b902",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<3.13,>=3.9",
"size": 7560,
"upload_time": "2024-09-15T10:05:43",
"upload_time_iso_8601": "2024-09-15T10:05:43.386126Z",
"url": "https://files.pythonhosted.org/packages/00/1f/5c25cd0d6690ddde29eeb10db142e3527a4f19d140ce02cccda46deb0a4e/manim_devanagari-0.0.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-09-15 10:05:43",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "avnlearn",
"github_project": "manim-devanagari",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "manim-devanagari"
}
JSON
