Authorship tagging

View: New views
3 Messages — Rating Filter:   Alert me  

Authorship tagging

by cronopios :: Rate this Message:

Reply to Author | View Threaded | Show Only this Message

In the documentation there are many stanzas like this:

<author>
<firstname>Fred</firstname>
<surname>Flintstone</surname>
<affiliation>
<address>
<email>fred@...</email>
</address>
</affiliation>
</author>

Shouldn't they be rewritten like this (i.e., using personname and
dropping affiliation and address, and making use of entities if
possible)?

<author>
<personname>
<firstname>Fred</firstname>
<surname>Flintstone</surname>
</personname>
<email>fred@...</email>
</author>
_______________________________________________
kde-docbook mailing list
kde-docbook@...
https://mail.kde.org/mailman/listinfo/kde-docbook

Re: Authorship tagging

by Burkhard Lück :: Rate this Message:

Reply to Author | View Threaded | Show Only this Message

Am Samstag 01 November 2008 20:34:35 schrieb Enrique Matías Sánchez (Quique):

> In the documentation there are many stanzas like this:
>
> <author>
> <firstname>Fred</firstname>
> <surname>Flintstone</surname>
> <affiliation>
> <address>
> <email>fred@...</email>
> </address>
> </affiliation>
> </author>
>
> Shouldn't they be rewritten like this (i.e., using personname and
> dropping affiliation and address, and making use of entities if
> possible)?
>
> <author>
> <personname>
> <firstname>Fred</firstname>
> <surname>Flintstone</surname>
> </personname>
> <email>fred@...</email>
> </author>

Yes, quoting kdelibs/kdoctools/template.docbook:
<authorgroup>
<author>
<!-- This is just put in as an example.  For real documentation, please
     define a general entity in entities/contributor.entities, e.g.
<!ENTITY
George.N.Ugnacious "<personname><firstname>George</firstname><othername>N.</othername><surname>Ugnacious</surname></personname>">
<!ENTITY George.N.Ugnacious.mail "<email>gnu@...</email>">
and use `&George.N.Ugnacious; &George.N.Ugnacious.mail;' in the author
element.
 -->
<personname>
<firstname>George</firstname>
<othername>N.</othername>
<surname>Ugnacious</surname>
</personname>
<email>gnu@...</email>
</author>
</authorgroup>

--
Burkhard Lück
_______________________________________________
kde-docbook mailing list
kde-docbook@...
https://mail.kde.org/mailman/listinfo/kde-docbook

Re: Authorship tagging

by Éric Bischoff :: Rate this Message:

Reply to Author | View Threaded | Show Only this Message

Le lundi 03 novembre 2008 12:07:34 Burkhard Lück, vous avez écrit :

> Yes, quoting kdelibs/kdoctools/template.docbook:
> <authorgroup>
> <author>
> <!-- This is just put in as an example.  For real documentation, please
>      define a general entity in entities/contributor.entities, e.g.
> <!ENTITY
> George.N.Ugnacious
> "<personname><firstname>George</firstname><othername>N.</othername><surname
>>Ugnacious</surname></personname>"> <!ENTITY George.N.Ugnacious.mail
> "<email>gnu@...</email>">
> and use `&George.N.Ugnacious; &George.N.Ugnacious.mail;' in the author
> element.
>  -->
> <personname>
> <firstname>George</firstname>
> <othername>N.</othername>
> <surname>Ugnacious</surname>
> </personname>
> <email>gnu@...</email>
> </author>
> </authorgroup>

The problem with <personname> is that it did not exist when we converted KDE
documentation to DocBook, so we were using <affiliation>.

Then we reported to Norman Walsh that using <affiliation> everywhere was
painful, and also that an author could be unaffiliated (private persons). They
invented <personname> to solve this, and this new element made its way into
the DocBook specification.

So, not only KDE should use <personname>, but we were the ones to invent it
;-).

(last sentence is simplifying a lot)

--
Éric Biscchoff - ^H^H zut ! ^H^H ^Q ^[ .. :w :q :wq :wq!
^d X^? exit X Q ^C ^c ^? :quitbye CtrlAltDel ~~q :~q logout
save/quit :!QUIT ^[zz ^[ZZZZZZ ^H man vi ^@ ^L ^[c ^# ^E ^X ^I ^T
? help helpquit ^D ^d man help ^C exit ?Quit ?q CtrlShftDel "Au sec
_______________________________________________
kde-docbook mailing list
kde-docbook@...
https://mail.kde.org/mailman/listinfo/kde-docbook