{"id":24746871,"url":"https://github.com/nilqed/jeditide","last_synced_at":"2025-08-17T13:08:12.033Z","repository":{"id":145481071,"uuid":"356382367","full_name":"nilqed/jeditIDE","owner":"nilqed","description":"jedit IDE howto (example for FriCAS)","archived":false,"fork":false,"pushed_at":"2021-04-11T23:06:45.000Z","size":3968,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-07-03T05:05:21.862Z","etag":null,"topics":["fricas","ide","jedit"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/nilqed.png","metadata":{"files":{"readme":"README.rst","changelog":null,"contributing":null,"funding":null,"license":null,"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":"2021-04-09T19:47:19.000Z","updated_at":"2024-05-31T10:24:59.000Z","dependencies_parsed_at":"2023-03-28T20:48:33.454Z","dependency_job_id":null,"html_url":"https://github.com/nilqed/jeditIDE","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/nilqed/jeditIDE","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nilqed%2FjeditIDE","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nilqed%2FjeditIDE/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nilqed%2FjeditIDE/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nilqed%2FjeditIDE/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/nilqed","download_url":"https://codeload.github.com/nilqed/jeditIDE/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nilqed%2FjeditIDE/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":270850909,"owners_count":24656618,"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","status":"online","status_checked_at":"2025-08-17T02:00:09.016Z","response_time":129,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":["fricas","ide","jedit"],"created_at":"2025-01-28T04:35:30.615Z","updated_at":"2025-08-17T13:08:12.007Z","avatar_url":"https://github.com/nilqed.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"===============\njEdit IDE HowTo\n===============\n\n:jEdit Homepage: http://www.jedit.org/\n:Wikipedia: https://en.wikipedia.org/wiki/JEdit\n\njEdit is a mature programmer's text editor with hundreds (counting the time developing plugins) of person-years of development behind it. \n\nIn less than no time it can be configured into an IDE for almost any language. For this ``HowTo`` we will use the computer algebra system \n``FriCAS``. Hence we assume you have ``fricas`` installed and you are using some Lin(ux) or Windows 10/WSL. The editor ``jEdit`` can be installed by ``apt/deb`` (used below) or by a method described on the jEdit Homepage.\n\n.. image:: docs/pics/jeditIDE.png\n  :alt: jeditIDE\n \n\n\nInstall jEdit\n=============\n\n::\n\n  $ sudo apt install jedit \n  \n  $ apt list jedit \n  Listing... Done\n  jedit/bionic,bionic,now 5.5.0+dfsg-1 all [installed]\n  \n  $ jedit -version\n  jEdit 5.5.0\n  $ jedit -usage\n\n\n:Start: jEdit \n\n::\n\n  $ jedit \u0026\n\n\n.. image:: docs/pics/jedit1.png\n  :width: 200px\n  :height: 100px\n  :align: center\n  :alt: jedit1\n \nInstall Plugins\n===============\n\n:Mark: [x] the plugins in the Plugin Manager. \n\n.. image:: docs/pics/jedit2.png\n  :width: 400\n  :alt: jedit2\n\nMandatory\n---------\n\n* Console\n* ContextMenu\n* ProjectViewer\n* Templates\n* TextFilter\n* GnuRegexp\n\n.. image:: docs/pics/jedit3.png\n  :width: 400\n  :alt: jedit3\n  \nRecommended/Optional\n--------------------\n\n* BufferList\n* CharacterMap\n* Code2HTML\n* ImageViewer\n* InfoViewer\n* JDiffPlugin\n* MarkdownPlugin\n* SpellCheck\n  \n.. image:: docs/pics/jedit4.png\n  :width: 400\n  :alt: jedit4\n\n\nCheck the appearance\n--------------------\n\nNow you should see some new (docked) windows, ``BufferList``\nfor instance. \n\n.. image:: docs/pics/jedit5.png\n  :width: 400\n  :alt: jedit5\n  \n:Click: on ``BufferList`` in the right docking area.\n\nIt will expand.\n\n.. image:: docs/pics/jedit6.png\n  :width: 400\n  :alt: jedit6\n\nSame for the ``Console``.\n\n.. image:: docs/pics/jedit7.png\n  :width: 400\n  :alt: jedit7\n  \n:Enter: some commands, and check if ``~/.jedit`` is available.\n\n:Warning: This is crucial for the further installation. \n\n.. image:: docs/pics/jedit8.png\n  :width: 400\n  :alt: jedit8\n  \nInstall an Edit Mode\n--------------------\nCopy the ``mode/spad.xml`` file to ``~/.jedit/modes/`` (see below) and\nadd ::\n\n   \u003cMODE NAME=\"spad\" FILE=\"spad.xml\" FILE_NAME_GLOB=\"*.{spad,input}\" /\u003e\n   \nto the file ``~/.jedit/modes/catalog``. The code below will just perform these steps.\n\n::\n\n  $ cp -v spad.xml ~/.jedit/modes/\n\n  $ export jcat_tmp=~/.jedit/modes/catalog\n  $ cat $jcat_tmp add_spad_to_catalog.txt \u003e $jcat_tmp\n\n\n:NOTE: Now **retart** jEdit, i.e. close and reopen (``jedit \u0026``).\n\nOpen a new file\n---------------\n\n:Menu: ``File -\u003e New In Mode``\n\nFind ``spad`` (hopefully).\n\n.. image:: docs/pics/jedit9.png\n  :width: 400\n  :alt: jedit9\n\n**Syntax highlighting**: Enter some keywords.\n\nThe color scheme can be adjusted of course.\n\n\n.. image:: docs/pics/jedit10.png\n  :width: 400\n  :alt: jedit10\n  \n  \n.. image:: docs/pics/jedit11.png\n  :width: 400\n  :alt: jedit11\n\n\n\nConfigure the Console\n---------------------\nPlugin -\u003e Console -\u003e compile \u0026 run\n\n.. image:: docs/pics/jedit12.png\n  :width: 400\n  :alt: jedit12\n\nConfigure the Context Menu\n--------------------------\nAs above, configure the context menu.\n\n.. image:: docs/pics/jedit13.png\n  :width: 400\n  :alt: jedit13\n  \nPress the [+] button.\n  \n.. image:: docs/pics/jedit14.png\n  :width: 400\n  :alt: jedit14\n\nLook for ``Run current buffer ...``\n\n.. image:: docs/pics/jedit15.png\n  :width: 400\n  :alt: jedit15\n\nRepeat the above steps in order to add\n``Compile current buffer ...``\n\n.. image:: docs/pics/jedit16.png\n  :width: 400\n  :alt: jedit16\n  \nNow the menu item ``spad`` (or whatever label you have given) should appear.\n\n.. image:: docs/pics/jedit17.png\n  :width: 400\n  :alt: jedit17\n  \nInstalling the Templates\n------------------------\nFirst, copy the templates to the ``~/.jedit/templates`` folder ::\n\n  $ cp -v templates/spad_* ~/.jedit/templates/\n  'templates/spad_category.vm' -\u003e '/home/kfp/.jedit/templates/spad_category.vm'\n  'templates/spad_domain.vm' -\u003e '/home/kfp/.jedit/templates/spad_domain.vm'\n  'templates/spad_package.vm' -\u003e '/home/kfp/.jedit/templates/spad_package.vm'\n  'templates/spad_unittest.vm' -\u003e '/home/kfp/.jedit/templates/spad_unittest.vm'\n\n\n\nPlugins -\u003e Templates -\u003e Template Tree \n  \n.. image:: docs/pics/jedit18.PNG\n  :width: 400\n  :alt: jedit18\n\nDock the floating ``template tree window`` to the **left** docking area_. \n\n.. image:: docs/pics/jedit19.png\n  :width: 400\n  :alt: jedit19\n  \nChoose ``refresh templates``, and you will see the installed templates.\n\n.. image:: docs/pics/jedit20.png\n  :width: 400\n  :alt: jedit20\n\n.. image:: docs/pics/jedit21.png\n  :width: 400\n  :alt: jedit21\n  \nInstall the Macros\n------------------\nIn this example only one macro will be installed (lookup FriCAS API).\n::\n\n  $ mkdir ~/.jedit/macros/FriCAS\n  $ cp -v  macros/fricas_api.bsh ~/.jedit/macros/FriCAS \n  'macros/fricas_api.bsh' -\u003e '/home/kfp/.jedit/macros/FriCAS/fricas_api.bsh'\n\n  Choose ``Macros -\u003e Rescan Macros`` and you should find the folder ``FriCAS`` containing the macro files (bean shell, .bsh)\n  ``fricas_api``:\n  \n.. image:: docs/pics/jedit22.png\n  :width: 400\n  :alt: jedit22\n  \nAdd it to the ``contex menu`` **spad** ([+] button)  \n\n.. image:: docs/pics/jedit23.png\n  :width: 400\n  :alt: jedit23\n\nAdd a ``separator`` for convenience,\n\n.. image:: docs/pics/jedit24.png\n  :width: 400\n  :alt: jedit24\n\nfind the ``Macros`` menu entry,\n\n.. image:: docs/pics/jedit25.png\n  :width: 400\n  :alt: jedit25\n\nand look for ``fricas_api``.\n\n.. image:: docs/pics/jedit26.png\n  :width: 400\n  :alt: jedit26\n  \nNow press OK.  \n  \n.. image:: docs/pics/jedit27.png\n  :width: 400\n  :alt: jedit27\n\nWe want to use it. Mouse-Select a FriCAS Type (e.g. Integer), and\n::\n\n   Menu: spad -\u003e fricas_api \n \n\n.. image:: docs/pics/jedit28.png\n  :width: 400\n  :alt: jedit28\n  \nshould display (in Firefox, otherwise edit the script) the corresponding FriCAS API webpage.\n\n.. image:: docs/pics/jedit29.png\n  :width: 400\n  :alt: jedit29\n\nFinally, customize jEdit to your needs, e.g. by arranging the dockable windows and so on.\n\n.. image:: docs/pics/jedit30.png\n  :width: 400\n  :alt: jedit30\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnilqed%2Fjeditide","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnilqed%2Fjeditide","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnilqed%2Fjeditide/lists"}