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

Clarify usage of abstracts #182

Merged
3 commits merged into from
Jan 20, 2022
Merged

Clarify usage of abstracts #182

3 commits merged into from
Jan 20, 2022

Conversation

cwickert
Copy link
Member

@cwickert cwickert commented Dec 9, 2021

This came up in the context of various bug reports about truncated chapter 'previews' both in the part overview pages and the single page HTML. Turns out the chapters lacked an abstract. We then use the first paragraph instead, but if longer than 500 (?) chars, it gets truncated.

This PR strives to give more guidance for abstracts, mainly that they are also required for chapters.

@cwickert cwickert marked this pull request as draft December 9, 2021 14:33
@cwickert
Copy link
Member Author

cwickert commented Dec 9, 2021

As agreed in today's style & language committee meeting, we should

I'll rework the PR accordingly.

@jfaltenbacher
Copy link
Contributor

suggests to add some info that the abstract is shown in the TOC of the parent part and in the search hitlist of any search engine in order to explain why it needs to be reduced to this certain amount of characters

@cwickert
Copy link
Member Author

@jfaltenbacher I'm afraid that is out of scope.

  1. Our Style Guide is already (too) long, we should keep it short and simple.
  2. How abstracts are displayed in 'parents' depends on both document type (set, book, part, and article) and its parent.
  3. The display might change and I don't want to touch the style guide again.
  4. The 70-155 char range is explained on the website that is linked in the remark.

@jfaltenbacher
Copy link
Contributor

ok, thanks

@cwickert cwickert marked this pull request as ready for review December 21, 2021 06:35
@ghost ghost changed the title Clarify usage or abstracts Clarify usage of abstracts Jan 4, 2022
Copy link

@ghost ghost left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Typo fixes

Also, as Jana will join today and we can talk about metadata again, I guess it makes sense not to merge before the meeting...

xml/docu_styleguide.outline.xml Outdated Show resolved Hide resolved
xml/docu_styleguide.outline.xml Outdated Show resolved Hide resolved
xml/docu_styleguide.outline.xml Outdated Show resolved Hide resolved
xml/docu_styleguide.outline.xml Outdated Show resolved Hide resolved
xml/docu_styleguide.outline.xml Outdated Show resolved Hide resolved
@ghost ghost force-pushed the cwickert-abstracts branch from 0aac414 to 9290854 Compare January 20, 2022 14:45
@ghost ghost merged commit 9290854 into main Jan 20, 2022
@ghost
Copy link

ghost commented Jan 20, 2022

Thank you all for the discussion today. Merged.

This pull request was closed.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants