Re: proposal: convert comments in documents to html comments

2022-07-06 Thread Noboru Saito
> I can add that markup, instead of SGML comments, when I create the > release notes. Great! Thank you. 2022年7月6日(水) 4:48 Bruce Momjian : > > On Wed, Jun 29, 2022 at 01:33:08PM +0100, Peter Eisentraut wrote: > > On 29.06.22 09:29, Noboru Saito wrote: > > > Comments aren't really associated with a

Re: proposal: convert comments in documents to html comments

2022-07-05 Thread Bruce Momjian
On Wed, Jun 29, 2022 at 01:33:08PM +0100, Peter Eisentraut wrote: > On 29.06.22 09:29, Noboru Saito wrote: > > Comments aren't really associated with anything, so it's difficult to > > associate them correctly. > > > > I think it is better to stop commenting xml (sgml) and format it as > > follows

Re: proposal: convert comments in documents to html comments

2022-06-29 Thread Peter Eisentraut
On 29.06.22 09:29, Noboru Saito wrote: Comments aren't really associated with anything, so it's difficult to associate them correctly. I think it is better to stop commenting xml (sgml) and format it as follows (tags are tentative). Yeah, with the exception of the release notes, XML comments w

Re: proposal: convert comments in documents to html comments

2022-06-29 Thread Noboru Saito
> Hmm. Could it be better to tweak git_changelog so as the commit ID is > reordered in the contents generated then? Then the doc rules could be > tweaked to feed on that? I have noticed that your patch is not able > to put a commit with its correct item. The first item of a section is > not ali

Re: proposal: convert comments in documents to html comments

2022-06-27 Thread Michael Paquier
On Tue, Jun 28, 2022 at 12:42:08PM +0900, Noboru Saito wrote: > If you want to separate hashes or add links, > I think it would be better to stop the current comment and make it a paragraph > (I think it is possible to keep them folded > when converted to html even if they are paragraphs). > I agr

Re: proposal: convert comments in documents to html comments

2022-06-27 Thread Noboru Saito
If you want to separate hashes or add links, I think it would be better to stop the current comment and make it a paragraph (I think it is possible to keep them folded when converted to html even if they are paragraphs). I agree with doing it that way, but it may not be possible right away. Html

Re: proposal: convert comments in documents to html comments

2022-06-27 Thread Alvaro Herrera
On 2022-Jun-27, Noboru Saito wrote: > > I don't have much of a clue about our docbook toolchain, beyond the > > basics (plus I have no front-end experience). Is anybody else aware of > > a reasonable approach to making git hashes discoverable from the html > > release notes? > > If you simply wan

Re: proposal: convert comments in documents to html comments

2022-06-26 Thread Peter Geoghegan
On Sun, Jun 26, 2022 at 6:02 PM Tom Lane wrote: > I seem to recall some discussion of letting the commit info pop up > as a tooltip. Not sure that that counts as "unobtrusive", though. I believe that I suggested this during the 2019 dev meeting at pgCon. This happened during a general discussion

Re: proposal: convert comments in documents to html comments

2022-06-26 Thread Tom Lane
Peter Geoghegan writes: > If this was available already, I would use it from time to time. > Ideally we'd have something more complete than this, that makes > the same information directly discoverable from the website (without > being obtrusive). But this patch is a start. I seem to recall some

Re: proposal: convert comments in documents to html comments

2022-06-26 Thread Peter Geoghegan
On Sun, Jun 26, 2022 at 5:12 PM Michael Paquier wrote: > Another is that you cannot notice those comments except when looking > at the HTML source, which is something that most users won't really > notice, while others willing to look at those particular commits could > just ping this information

Re: proposal: convert comments in documents to html comments

2022-06-26 Thread Peter Geoghegan
On Sun, Jun 26, 2022 at 5:19 AM Noboru Saito wrote: > The release notes have the git commit information in the comments, > it would be great to have it in the html comments as well. > > That can be done with the attached patch. Sounds like a good idea to me. -- Peter Geoghegan

Re: proposal: convert comments in documents to html comments

2022-06-26 Thread Michael Paquier
On Sun, Jun 26, 2022 at 09:19:21PM +0900, Noboru Saito wrote: > Currently the comments in the document are removed when converting to html. > I propose to keep them as html comments. OK. The format of the HTML pages is rather clean, so this would be rather readable. > The release notes have the