{"id":16237805,"url":"https://github.com/marcus67/rechtschreibung","last_synced_at":"2025-03-19T16:30:31.045Z","repository":{"id":98035813,"uuid":"47426432","full_name":"marcus67/rechtschreibung","owner":"marcus67","description":"A little Python app to test different rule sets for German spelling","archived":false,"fork":false,"pushed_at":"2017-11-08T23:38:53.000Z","size":5252,"stargazers_count":5,"open_issues_count":11,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-03-17T08:51:16.711Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/marcus67.png","metadata":{"files":{"readme":"README.md","changelog":null,"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":"2015-12-04T20:10:21.000Z","updated_at":"2020-12-14T21:12:37.000Z","dependencies_parsed_at":null,"dependency_job_id":"cd2502a3-ea37-41aa-93c0-9f17e8a7140d","html_url":"https://github.com/marcus67/rechtschreibung","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/marcus67%2Frechtschreibung","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/marcus67%2Frechtschreibung/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/marcus67%2Frechtschreibung/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/marcus67%2Frechtschreibung/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/marcus67","download_url":"https://codeload.github.com/marcus67/rechtschreibung/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244463564,"owners_count":20456912,"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":[],"created_at":"2024-10-10T13:37:13.083Z","updated_at":"2025-03-19T16:30:31.037Z","avatar_url":"https://github.com/marcus67.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cIMG SRC=\"https://raw.githubusercontent.com/marcus67/rechtschreibung/master/lib/rechtschreibung_64.png\"\u003e\n\n# rechtschreibung\nA little Python app to be used with Pythonista to test different rule sets for German spelling.\n\n## CircleCI Continuous Integration Status\n\n\u003cA HREF=\"https://circleci.com/gh/marcus67/rechtschreibung/tree/master\"\u003e\u003cIMG SRC=\"https://img.shields.io/circleci/project/github/marcus67/rechtschreibung.svg?label=Python3%20master\"\u003e\u003c/A\u003e \u003cA HREF=\"https://circleci.com/gh/marcus67/rechtschreibung/tree/dev-mr\"\u003e\u003cIMG SRC=\"https://img.shields.io/circleci/project/github/marcus67/rechtschreibung/dev-mr.svg?label=Python3%20dev-mr\"\u003e\u003c/A\u003e \u003cA HREF=\"https://circleci.com/gh/marcus67/rechtschreibung/tree/dev-mr-python-2\"\u003e\u003cIMG SRC=\"https://img.shields.io/circleci/project/github/marcus67/rechtschreibung/dev-mr-python-2.svg?label=Python2%20dev-mr-python-2\"\u003e\u003c/A\u003e\n\nNote that the status above only covers source code not relying on proprietary Pythonista packages.\n\n## GitHub Status\n\n\u003cA HREF=\"https://github.com/marcus67/rechtschreibung\"\u003e\u003cIMG SRC=\"https://img.shields.io/github/forks/marcus67/rechtschreibung.svg?label=forks\"\u003e\u003c/A\u003e \u003cA HREF=\"https://github.com/marcus67/rechtschreibung/stargazers\"\u003e\u003cIMG SRC=\"https://img.shields.io/github/stars/marcus67/rechtschreibung.svg?label=stars\"\u003e\u003c/A\u003e \u003cA HREF=\"https://github.com/marcus67/rechtschreibung/watchers\"\u003e\u003cIMG SRC=\"https://img.shields.io/github/watchers/marcus67/rechtschreibung.svg?label=watchers\"\u003e\u003c/A\u003e \u003cA HREF=\"https://github.com/marcus67/rechtschreibung/issues\"\u003e\u003cIMG SRC=\"https://img.shields.io/github/issues/marcus67/rechtschreibung.svg\"\u003e\u003c/A\u003e \u003cA HREF=\"https://github.com/marcus67/rechtschreibung/pulls\"\u003e\u003cIMG SRC=\"https://img.shields.io/github/issues-pr/marcus67/rechtschreibung.svg\"\u003e\u003c/A\u003e\n\n## Requirements\n\nYou need to have [Pythonista](https://itunes.apple.com/us/app/pythonista/id528579881?mt=8) installed on iOS.\n\n## Basic Functionality\n\nThis project allows you to test different combinations of German spelling rules with a simple GUI. Each change of rules is immediately reflected in a text especially written for this purpose. The GUI can be used to store favorite combinations and compare them.\n\n\u003cCENTER\u003e\n\u003cIMG SRC=\"https://raw.githubusercontent.com/marcus67/rechtschreibung/master/doc/main_screen.png\" WIDTH=\"800px\"\u003e\n\u003c/CENTER\u003e\n\n## Installation\n\nThe source code is available as a self-extracting Python script. See file `build/rechtschreibung_zip.py`. Download this file and follow the instructions contained therein.\n\n## Usage\n\n### Main View\n\nThe main view is shown upon start of the application. It looks different for small devices (iPhone) and large devices (iPad). We'll concentrate on the version for larger devices first.\n\n\u003cCENTER\u003e\n\u003cIMG SRC=\"https://raw.githubusercontent.com/marcus67/rechtschreibung/master/doc/main_screen.png\" WIDTH=\"800px\"\u003e\n\u003c/CENTER\u003e\n\nOn the left an especially designed text (see screenshot above) is displayed. It serves two purposes. The first purpose is to explain the motivation behind the app and introduce two fictional characters (Casimir and Wendy) representing the two opposing positions in the discussion about German spelling: Casimir is the conservative person trying to main the status quo and Wendy is the progressive person trying to change rules to make them easier and more consistent.\n\nThe second purpose is to display the impact of the various rules on a concrete text, which is to say that every time the user changes one of the rules the changes in the text are immediately reflected. For a short period of time the actual changes are highlighted: letters which are to be deleted are shown with grey background and striked out. Letters which are to be inserted are shown with green background. (see screenshot below) Usually (unless deactivated) the highlighted sections are removed after a certain delay (e.g. 5 seconds). \n\n\u003cCENTER\u003e\n\u003cIMG SRC=\"https://raw.githubusercontent.com/marcus67/rechtschreibung/master/doc/highlighted_rule_change.png\" WIDTH=\"480px\"\u003e\n\u003c/CENTER\u003e\n\n\nSince some of the rules have very little impact on a standard text, it has been seen to it that in the conversation between \nCasimir and Wendy there are especially designed sample sentences showing the differences.\n\n#### Rule Sets\n\nThe spelling rules are organized in currently six sections (see upper right navigation area in screen shot above). Actually, the term \"spelling\" is a little wider than just the correct use of letters for words. The rule sets also contain aspects of punctuation (\"Zeichensetzung\") and layout.\n\nThere is a [summary](http://htmlpreview.github.com?https://raw.githubusercontent.com/marcus67/rechtschreibung/master/doc/rules.html) of all rules in German.\n\n##### App Control View\n\nThe App Control view in the lower right corner shows some setting influencing the behaviour of the app.\n\n\u003cCENTER\u003e\n\u003cIMG SRC=\"https://raw.githubusercontent.com/marcus67/rechtschreibung/master/doc/control_view.png\" WIDTH=\"320px\"\u003e\n\u003c/CENTER\u003e\n\n##### Highlighting of Changes\nThere are three modes for highlighting the changes after an applied rule change:\n\n + The highlighting is off (\"aus\").\n + The highlighting is done compared to the immediately previous rule set (\"Delta\").\n + The highlighting is done compared to the reference rule set (\"Referenz\"). The initial reference rule set is the currently valid spelling rule set as proposed by the book \"Duden\". It can be changed by loading other rule sets (see below).\n\nThe switch next to the clock icon enables the \"auto off\" mode for highlighting of changes. When set to \"on\" the highlighting will automatically disappear after a certain time delay. If set to \"off\" the highlighting will remain active indefinitely.\n\n##### Speaking the Text\nThe play button will make the iDevice read the current text. This can be quite entertaining if the user has chosen a rule combination that the built-in pronunciation logic cannot handle. Of course, the pause button will make the playback stop.\n\n##### Loading the Reference Rule Set\n\nThe icon next to the \"Referenz\" rule set will open a view to load a new reference rule set.\n\n\u003cCENTER\u003e\n\u003cIMG SRC=\"https://raw.githubusercontent.com/marcus67/rechtschreibung/master/doc/load_configuration.png\" WIDTH=\"320px\"\u003e\n\u003c/CENTER\u003e\n\nThe user can a pick a rule set from the list by tapping on the list entry.\n\n##### Loading the Working Rule Set (\"Current\")\n\nThe first icon next to the \"Aktuell\" rule set will open a view to load the working rule set which will be compared to the reference rule set.\n\n\u003cCENTER\u003e\n\u003cIMG SRC=\"https://raw.githubusercontent.com/marcus67/rechtschreibung/master/doc/load_configuration.png\" WIDTH=\"320px\"\u003e\n\u003c/CENTER\u003e\n\nThe user can a pick a rule set from the list by tapping on the list entry. Tapping on the information icons on the right end of the list entries will show the comment that has been saved with the rule set.\n\n##### Loading the Working Rule Set (\"Current\")\n\nThe second icon next to the \"Aktuell\" rule set will open a view to save the working rule set.\n\n\u003cCENTER\u003e\n\u003cIMG SRC=\"https://raw.githubusercontent.com/marcus67/rechtschreibung/master/doc/save_configuration.png\" WIDTH=\"320px\"\u003e\n\u003c/CENTER\u003e\n\nThe user will have to choose a name (if not already present) and optionally a comment. Tapping on a list entry will fetch the name and the comment of the chosen rule set for overwriting. The button will show \"Überschreiben\" if a saved rule set with the given name exists or \"Speichern\" otherwise. Note: The labels of the button will be adapted to the current rule set! :-)\n\n#### Statistics\n\nAt the bottom of the control view\n\n\u003cCENTER\u003e\n\u003cIMG SRC=\"https://raw.githubusercontent.com/marcus67/rechtschreibung/master/doc/stat_text.png\" WIDTH=\"320px\"\u003e\n\u003c/CENTER\u003e\n\nthe user has access to both a statistical summary of the current rule set with respect to the reference rule set and a graphical output containing three charts.\n\n##### Pie Charts Showing the Letter Usage\n\nThe first two charts show a comparison of the letter usage for the reference and the current rule sets.\n\n\u003cCENTER\u003e\n\u003cIMG SRC=\"https://raw.githubusercontent.com/marcus67/rechtschreibung/master/doc/stat_view_1.png\" WIDTH=\"640px\"\u003e\n\u003c/CENTER\u003e\n \n##### Bar Chart Showing the Relative Changes in Letter Usage\n\nThe third chart shows the relative change of the letter usage of the current rule set with respect to the reference rule sets. Changes over a threshold (usually 5%) are shown as bars. Smaller changes are just mentioned in the legend.\n\n\u003cCENTER\u003e\n\u003cIMG SRC=\"https://raw.githubusercontent.com/marcus67/rechtschreibung/master/doc/stat_view_2.png\" WIDTH=\"640px\"\u003e\n\u003c/CENTER\u003e\n \n\nHave fun!\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmarcus67%2Frechtschreibung","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmarcus67%2Frechtschreibung","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmarcus67%2Frechtschreibung/lists"}