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

Integrate modification date into published documents #422

Open
tomschr opened this issue Oct 28, 2020 · 2 comments
Open

Integrate modification date into published documents #422

tomschr opened this issue Oct 28, 2020 · 2 comments
Assignees
@tomschr @janajaeger
Labels
effort:M Medium effort format-html html, xhtml, html5, webhelp, jsp support format-pdf pdf support prio:medium topic-smartdocs For SmartDocs

Comments

@tomschr
Copy link
Collaborator

tomschr commented Oct 28, 2020

Problem Description

Our documents show currently the build date on its cover page. This confuses some people and they would like to have something like:

  • First published: dd.mm.yyyy
  • Last modified: dd.mm.yyyy (does NOT mean last published)

Possible Solution

We need a new parameter that can receive the modification date. Additionally, we retrieve the published date and modified date from some DocBook tags.
@tomschr tomschr added format-html html, xhtml, html5, webhelp, jsp support format-pdf pdf support labels Oct 28, 2020
@tomschr tomschr self-assigned this Oct 28, 2020
tomschr added a commit that referenced this issue Oct 29, 2020
@tomschr
Fix #422: Add "last modified" line on cover page
f97a282 
This is a proof-of-concept:

* Introduce parameter "last.modified" for FO and XHTML
  by default it's empty
* Introduce a "last.modified" key in language file
  (currently en ATM)
* When the cover page is created, only add "Last modified"
  line when $last.modified != ''.

Currently, the parameter $last.modified is used "as-is"; it
will be included in the respective line no matter if it's a
date or not.
However, if it's a date, it is currently inconsistent with the
publication date. That date is created from this line:

<date><?dbtimestamp format="B d, Y"?></date>

In other words, to make both dates to be consistent, the
last modified date needs to be transformed into the format
of the PI inside <date>.
@ghost ghost changed the title Integrate modified date into published documents Integrate modification date into published documents May 28, 2021
@janajaeger
Copy link
Contributor

What's the status on this one, @tomschr ?

@tomschr tomschr added effort:M Medium effort topic-smartdocs For SmartDocs labels Nov 28, 2022
@tomschr
Copy link
Collaborator Author

tomschr commented Nov 28, 2022

Two possibilities for markup:

  • <date role="modified">...</date>
  • <meta role="date-modified">...</meta>

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@tomschr tomschr

@janajaeger janajaeger

Labels
effort:M Medium effort format-html html, xhtml, html5, webhelp, jsp support format-pdf pdf support prio:medium topic-smartdocs For SmartDocs
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@tomschr @janajaeger