Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Optionally display a more detailed version of the help text for a question. #595

Closed
chsinn opened this issue Mar 9, 2023 · 6 comments · Fixed by #612
Closed

Optionally display a more detailed version of the help text for a question. #595

chsinn opened this issue Mar 9, 2023 · 6 comments · Fixed by #612
Assignees
Milestone

Comments

@chsinn
Copy link

chsinn commented Mar 9, 2023

Rationale / Begründung

Long help texts are tiring to read and can be off-putting. A more detailed version of the help text could only be displayed if the user clicks on "Read more".

Minimal functionality

Clicking on "read more" enlarges the text box and more paragraphs appear without reloading the web page.
issues_read_more

References / Verweise

  • rdmo v1.92
@jochenklar
Copy link
Member

I would implement this as a custom markdown tag, something like the <!-- more --> wordpress had, at least when I last used it. We already do that with the [text]{tooltip} syntax.

@MyPyDavid
Copy link
Member

MyPyDavid commented Apr 26, 2023

There is currently a help text in the DFG Checklist catalog that uses the html <details> element. It also has a style="color:blue; cursor:pointer;" hard coded in it which is not so desirable when someone wants to have another color for example.
The <details> and <summary> may behave different depending on browsers (https://www.scottohara.me/blog/2022/09/12/details-summary.html) but it works as html in the helptext.
Could this also be an option and include the style in the rdmo .scss files?

/* in rdmo/core/static/core/css/base.scss */
summary {
    color: $details-summary-color;
    cursor: $details-summary-cursor;
}
/* rdmo/core/static/core/css/variables.scss */
/* details summary */
$details-summary-color: #101F70;
$details-summary-cursor: pointer;

@jochenklar
Copy link
Member

I would not add additional colors, but use those which are already available in variables.scss, we could add something like $summary-color: $link-color; or something. I don't see why details should have a pointer cursor, but maybe I am missing something.

@MyPyDavid
Copy link
Member

ok, good idea to use the $link-color for that. The pointer cursor is there to make it look like a clickable element when hovering over with the mouse I think, otherwise it looks like a normal text..

@MyPyDavid MyPyDavid linked a pull request Apr 26, 2023 that will close this issue
@jochenklar jochenklar self-assigned this Aug 29, 2023
@jochenklar jochenklar added this to the 2.1.0 milestone Aug 29, 2023
@jochenklar
Copy link
Member

I had a look at display/summary again and I would rather go with:

details {
    margin-bottom: 10px;
}

summary {
    display: list-item;
    cursor: pointer;
    margin-bottom: 5px;
}

(not changing the color).

image

@MyPyDavid ok?

@MyPyDavid
Copy link
Member

think it's fine, this will be adaptable in the theme anyway right?

afuetterer added a commit to afuetterer/rdmo that referenced this issue Nov 23, 2023
* refactor: use admin.register decorator

* build: pin django-mptt dependency

* fix: update verbose_name_plural in questionset

* fix rdmorganiser#791 for openid_connect providers and refactor keycloak snippet

* Add custom {more} markdown tag (rdmorganiser#595)

* Adjust details/summary style

* Add ValueConflictValidator and check for conflicts when storing values

* Autosave after eraseValue and removeValue

* Add tests for ValueConflictValidator

* Fix human2bytes utils function

* chore: refactor human2bytes utils func

* Fix ValueQuotaValidator and add tests

* Update HUMAN2BYTES_MAPPER and add test

* Refactor progress bar and take sets and conditions into account (rdmorganiser#596)

* Check is_optional for progress bar (again)

* Add progress_count and progress_total to Project model, compute on POST
when using the API and add progress to the project overview (rdmorganiser#488)

* Add navigation action to ProjectViewSet and refactor navigation (rdmorganiser#299, rdmorganiser#424)

* Always show count in progress bar

* Fix progress bar for questionsets

* Fix progress computation

* Fix progress permissions

* Add tests for progress and navigation

* Add progress to project hierarchy (rdmorganiser#488)

* chore: refactor values query to managers

* Use "count of total" for the progress in projects table

* Add support for BASE_URL to the management react interface (rdmorganiser#815)

* Rename variable

* Refresh navigation after auto-save in interview

* chore: add pytest-playwright dependency

* chore: add custom pytest marker for e2e tests

* chore: enable debug mode per env, default false

* refactor: add "fixtures" fixture to reuse in e2e tests

* test: add frontend-tests with pytest-playwright

Co-authored-by: David Wallace

Fixes: rdmorganiser#715

* ci: run e2e tests in ci

* ci: add dependency groups to dependabot config

* chore: update ruff repo name in pre-commit config

* build: update pre-commit hooks

* chore: fix ruff errors (PGH002, UP032)

---------

Co-authored-by: David Wallace <david.wallace@tu-darmstadt.de>
Co-authored-by: Jochen Klar <mail@jochenklar.de>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
afuetterer added a commit to afuetterer/rdmo that referenced this issue Nov 29, 2023
* Refactor autocomplete and add free autocomplete widget for arbitrary inputs (rdmorganiser#600)

* refactor: use admin.register decorator

* build: pin django-mptt dependency

* fix: update verbose_name_plural in questionset

* fix rdmorganiser#791 for openid_connect providers and refactor keycloak snippet

* Add custom {more} markdown tag (rdmorganiser#595)

* Adjust details/summary style

* Add ValueConflictValidator and check for conflicts when storing values

* Autosave after eraseValue and removeValue

* Add tests for ValueConflictValidator

* Fix human2bytes utils function

* chore: refactor human2bytes utils func

* Fix ValueQuotaValidator and add tests

* Update HUMAN2BYTES_MAPPER and add test

* Refactor progress bar and take sets and conditions into account (rdmorganiser#596)

* Check is_optional for progress bar (again)

* Add progress_count and progress_total to Project model, compute on POST
when using the API and add progress to the project overview (rdmorganiser#488)

* Add navigation action to ProjectViewSet and refactor navigation (rdmorganiser#299, rdmorganiser#424)

* Always show count in progress bar

* Fix progress bar for questionsets

* Fix progress computation

* Fix progress permissions

* Add tests for progress and navigation

* Add progress to project hierarchy (rdmorganiser#488)

* chore: refactor values query to managers

* Use "count of total" for the progress in projects table

* Add support for BASE_URL to the management react interface (rdmorganiser#815)

* Rename variable

* Refresh navigation after auto-save in interview

* chore: add pytest-playwright dependency

* chore: add custom pytest marker for e2e tests

* chore: enable debug mode per env, default false

* refactor: add "fixtures" fixture to reuse in e2e tests

* test: add frontend-tests with pytest-playwright

Co-authored-by: David Wallace

Fixes: rdmorganiser#715

* ci: run e2e tests in ci

* ci: add build-wheel job

Fixes: rdmorganiser#802

* Fix translated strings (Projektaufgaben, Projektansichten) and some
automatic reformatting (rdmorganiser#254)

* Add accept to project import plugins to restrict upload files (to e.g. .xml)

* Add accept=".xml" to management upload form component

* chore: add email to RoleAdmin

* chore: update ruff repo name in pre-commit config

* build: update pre-commit hooks

* chore: fix ruff errors (PGH002, UP032)

* ci: add dependency groups to dependabot config

* ci: update dependabot js groups

* build(deps-dev): bump the babel group with 5 updates

Bumps the babel group with 5 updates:

| Package | From | To |
| --- | --- | --- |
| [@babel/cli](https://github.com/babel/babel/tree/HEAD/packages/babel-cli) | `7.17.10` | `7.23.4` |
| [@babel/core](https://github.com/babel/babel/tree/HEAD/packages/babel-core) | `7.17.10` | `7.23.3` |
| [@babel/preset-env](https://github.com/babel/babel/tree/HEAD/packages/babel-preset-env) | `7.17.10` | `7.23.3` |
| [@babel/preset-react](https://github.com/babel/babel/tree/HEAD/packages/babel-preset-react) | `7.16.7` | `7.23.3` |
| [babel-loader](https://github.com/babel/babel-loader) | `8.2.5` | `9.1.3` |

Updates `@babel/cli` from 7.17.10 to 7.23.4
- [Release notes](https://github.com/babel/babel/releases)
- [Changelog](https://github.com/babel/babel/blob/main/CHANGELOG.md)
- [Commits](https://github.com/babel/babel/commits/v7.23.4/packages/babel-cli)

Updates `@babel/core` from 7.17.10 to 7.23.3
- [Release notes](https://github.com/babel/babel/releases)
- [Changelog](https://github.com/babel/babel/blob/main/CHANGELOG.md)
- [Commits](https://github.com/babel/babel/commits/v7.23.3/packages/babel-core)

Updates `@babel/preset-env` from 7.17.10 to 7.23.3
- [Release notes](https://github.com/babel/babel/releases)
- [Changelog](https://github.com/babel/babel/blob/main/CHANGELOG.md)
- [Commits](https://github.com/babel/babel/commits/v7.23.3/packages/babel-preset-env)

Updates `@babel/preset-react` from 7.16.7 to 7.23.3
- [Release notes](https://github.com/babel/babel/releases)
- [Changelog](https://github.com/babel/babel/blob/main/CHANGELOG.md)
- [Commits](https://github.com/babel/babel/commits/v7.23.3/packages/babel-preset-react)

Updates `babel-loader` from 8.2.5 to 9.1.3
- [Release notes](https://github.com/babel/babel-loader/releases)
- [Changelog](https://github.com/babel/babel-loader/blob/main/CHANGELOG.md)
- [Commits](babel/babel-loader@v8.2.5...v9.1.3)

---
updated-dependencies:
- dependency-name: "@babel/cli"
  dependency-type: direct:development
  update-type: version-update:semver-minor
  dependency-group: babel
- dependency-name: "@babel/core"
  dependency-type: direct:development
  update-type: version-update:semver-minor
  dependency-group: babel
- dependency-name: "@babel/preset-env"
  dependency-type: direct:development
  update-type: version-update:semver-minor
  dependency-group: babel
- dependency-name: "@babel/preset-react"
  dependency-type: direct:development
  update-type: version-update:semver-minor
  dependency-group: babel
- dependency-name: babel-loader
  dependency-type: direct:development
  update-type: version-update:semver-major
  dependency-group: babel
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* build(deps): pin react-bootstrap

---------

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: Jochen Klar <mail@jochenklar.de>
Co-authored-by: David Wallace <david.wallace@tu-darmstadt.de>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants