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.

Sign up for GitHub

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

Jump to bottom

docs: Add the "Tasks extras" and other improvements to Styling docs #3198

Merged
merged 7 commits into from
Nov 22, 2024
Merged

docs: Add the "Tasks extras" and other improvements to Styling docs #3198

merged 7 commits into from
Nov 22, 2024

Conversation

claremacrae
Copy link
Collaborator

@claremacrae claremacrae commented Nov 22, 2024 •
edited
Loading

Types of changes

Changes visible to users:

  • Documentation (prefix: docs - improvements to any documentation content for users)

Internal changes:

  • Tests (prefix: test - additions and improvements to unit tests and the smoke tests)

Description

Improve Styling docs:

  • Add some missing recent fields to the documentation (id, dependsOn and onCompletion).
  • Show the HTML for a full Tasks query block, instead of just for a single task.
  • It shows the classes added to the ul in the Sample HTML in Styling doc
  • It also adds the "Tasks extras" to the Sample HTML in Styling docs:
    • Urgency
    • Backlink
    • Edit button
    • Postpone button

Motivation and Context

I had to look some of this up for a user support query, so I thought I might as well save it.

Though it turned out to be a larger task than I had expected!

How has this been tested?

  • Viewing the documentation in Obsidian

Screenshots

The bits marked in red are the new bits:

image

Checklist

Terms

@claremacrae
docs: Add some recent fields to the Styling docs
50ca871
@claremacrae
refactor: ! Rework rendering of urgency so it can be called from tests.
ba14a6d 
This removes the use of Obsidian convenience function createSpan()
@claremacrae
test: - Update the fake date in QueryResultsRenderer.test.ts
937ec8d 
This makes the date closer to the task dates being rendered - specifically
to match the date used in TaskLineRenderer.test.ts, so that I can later
embed QueryResultsRenderer.test.ts approved files in the Styling docs.
@claremacrae
test: - Show CSS class used when rendering urgency.
3e1cb90
@claremacrae
test: - Add QueryResultsRenderer approval test for short-mode
5dbf7e8
@claremacrae
test: - QueryResultsRenderer.test.ts now includes markdown in approve…
b271a03 
…d files

For consistency with similar TaskLineRenderer approved files.
@claremacrae
docs: Add the "Tasks extras" to the Sample HTML in Styling docs.
69f6ea5
@claremacrae claremacrae added the scope: documentation Improvements or additions to documentation label Nov 22, 2024
@sonarqubecloud SonarQubeCloud
Copy link

sonarqubecloud bot commented Nov 22, 2024 •
edited
Loading

Quality Gate Passed Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
No data about Coverage
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

@claremacrae claremacrae merged commit 848d8bb into main Nov 22, 2024
3 checks passed
@claremacrae claremacrae deleted the docs-for-styling branch November 22, 2024 22:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
scope: documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@claremacrae