[prev in list] [next in list] [prev in thread] [next in thread] 

List:       fedora-docs-list
Subject:    Re: Semantic Tagging in AsciiDoc
From:       Sylvia <bhkohane () gmail ! com>
Date:       2016-09-12 7:27:24
Message-ID: 1473665244.2255.7.camel () gmail ! com
[Download RAW message or body]

[Attachment #2 (multipart/alternative)]


Hi Brian!

Sorry to say your link is not working.   It returns   (to me at least)   a
404 error.


Cheers,
Sylvia

On Thu, 2016-09-08 at 15:40 +0200, Brian Exelbierd wrote:
> Hi Sumedh,
> 
> 
> 
> On Thu, Sep 8, 2016, at 03:29 AM, sumedh deshpande wrote:
> 
> > > > I don't know about XML doctype & what I have to do right now .
please explain it in simple way and my work at all
> 
> > I am not 100% sure what you're asking, so I will provide you with
several answers:
> 
> 
> 
> > > > 1) If you are looking to contribute to documentation today, right
now, there is no need to do anything with this information.  
Documentation is in DocBook today and as long as you use DocBook you
will be fine.
> 
> 
> 
> > > > > > 2) If you want to influence how documentation will be written after
the conversion to AsciiDoc, then please visit the wikipage and review
the DocBook tags in the table.   If there is a tag you feel like we
should keep for whatever reason (typically consistency of
presentation, signals to localizers, or automated testing) add the
explanation in the third column.
> 
> 
> 
> > > If you're going to edit the table, don't forget that we don't want to
recreate DocBook in AsciiDoc and so we want to try and strive for the
smallest semantic markup tag set possible.
> 
> 
> 
> You may also want to read my blog post on this, which I just wrote:
> 
> 
> 
> http://www.winglemeyer.org/2016/09/08/semantic-asciidoc/
> 
> 
> 
> regards,
> 
> 
> 
> bex
> 
> 
> 
> > 
> > > > On Sep 8, 2016 1:38 AM, "Brian Exelbierd" <bex@pobox.com> wrote:
> > 
> > Hi All,
> > 
> > 
> > 
> > > > A chance conversation today led me to thinking about semantic
markup and
> > 
> > > > AsciiDoc.   AsciiDoc is easier to write because it has fewer tags.  
It is
> > 
> > > > also easier because it has fewer keystrokes.   However, it doesn't
offer
> > 
> > a lot of options for marking up elements to:
> > 
> > 
> > 
> > > > * ensure consistency of localization by passing element information
to
> > 
> > the localizer
> > 
> > > > * ensure consistency of formatting by ensuring all of the same
elements,
> > 
> > for example command names, are marked up the same way
> > 
> > * allow for future automated testing with a project like `emender`
> > 
> > 
> > 
> > > > I went through the Installation Guide and found 97 DocBook XML
tags.
> > 
> > I've put them in the table on this wiki page:
> > 
> > 
> > 
> > https://fedoraproject.org/wiki/Docs_Tag_Discussion
> > 
> > 
> > 
> > > > Please visit the page and edit it to weigh in on preferences about
the
> > 
> > tags.
> > 
> > 
> > 
> > > > I believe this will help us complete our AsciiDoc style guide and
do the
> > 
> > conversions more rapidly and effectively.
> > 
> > 
> > 
> > > > Today, if you want to discuss implementation of these tags in
AsciiDoc,
> > 
> > please start a separate email thread.
> > 
> > 
> > 
> > Thank you.
> > 
> > 
> > 
> > regards,
> > 
> > 
> > 
> > bex
> > 
> > --
> > 
> > docs mailing list
> > 
> > docs@lists.fedoraproject.org
> > 
> > To unsubscribe:
> > 
> > > > https://lists.fedoraproject.org/admin/lists/docs@lists.fedoraprojec
t.org
> > 
> > 
> > 
> > 
> > 
> > --
> > 
> > docs mailing list
> > 
> > docs@lists.fedoraproject.org
> > 
> > To unsubscribe:
> > 
> > > > https://lists.fedoraproject.org/admin/lists/docs@lists.fedoraprojec
t.org
> > 
> 
> 
> 
> --
> docs mailing list
> docs@lists.fedoraproject.org
> To unsubscribe:
> > https://lists.fedoraproject.org/admin/lists/docs@lists.fedoraproject.
org

[Attachment #5 (text/html)]

<html><head>
<title></title>
</head>
<body bgcolor="#ffffff" text="#000000" link="#f07746" \
vlink="#f07746"><div><br></div><div><br></div><div>Hi \
Brian!</div><div><br></div><div>Sorry to say your link is not working. &nbsp;It \
returns &nbsp;(to me at least) &nbsp;a 404 \
error.</div><div><br></div><div><br></div><div>Cheers,</div><div>Sylvia</div><div><br></div><div \
class="-x-evo-paragraph -x-evo-top-signature-spacer"><br></div><div>On Thu, \
2016-09-08 at 15:40 +0200, Brian Exelbierd wrote:</div><blockquote \
type="cite"><div>Hi Sumedh,<br></div> <div><br></div>
<div>On Thu, Sep 8, 2016, at 03:29 AM, sumedh deshpande wrote:<br></div>
<blockquote type="cite"><p dir="ltr">I don't know about XML doctype &amp; what I have \
to do right now . please explain it in simple way and my work at \
all<br></p></blockquote><div><br></div> <div>I am not 100% sure what you're asking, \
so I will provide you with several answers:<br></div> <div><br></div>
<div>1) If you are looking to contribute to documentation today, right now, there is \
no need to do anything with this information.&nbsp; Documentation is in DocBook today \
and as long as you use DocBook you will be fine.<br></div> <div><br></div>
<div>2) If you want to influence how documentation will be written after the \
conversion to AsciiDoc, then please visit the wikipage and review the DocBook tags in \
the table.&nbsp; If there is a tag you feel like we should keep for whatever reason \
(typically consistency of presentation, signals to localizers, or automated testing) \
add the explanation in the third column.<br></div> <div><br></div>
<div>If you're going to edit the table, don't forget that we don't want to recreate \
DocBook in AsciiDoc and so we want to try and strive for the smallest semantic markup \
tag set possible.<br></div> <div><br></div>
<div>You may also want to read my blog post on this, which I just wrote:<br></div>
<div><br></div>
<div><a href="http://www.winglemeyer.org/2016/09/08/semantic-asciidoc/">http://www.winglemeyer.org/2016/09/08/semantic-asciidoc/</a><br></div>
 <div><br></div>
<div>regards,<br></div>
<div><br></div>
<div>bex<br></div>
<div><br></div>
<blockquote type="cite"><div><div><br></div>
<div><div>On Sep 8, 2016 1:38 AM, "Brian Exelbierd" &lt;<a \
href="mailto:bex@pobox.com">bex@pobox.com</a>&gt; wrote:<br></div> <blockquote \
style="margin-top:0px;margin-right:0px;margin-bottom:0px;margin-left:0.8ex;border-left-width:1px;border-left-style:solid;border-left-color:rgb(204, \
204, 204);padding-left:1ex;"><div>Hi All,<br></div> <div><br></div>
<div>A chance conversation today led me to thinking about semantic markup \
and<br></div> <div>AsciiDoc.&nbsp; AsciiDoc is easier to write because it has fewer \
tags.&nbsp; It is<br></div> <div>also easier because it has fewer keystrokes.&nbsp; \
However, it doesn't offer<br></div> <div>a lot of options for marking up elements \
to:<br></div> <div><br></div>
<div>* ensure consistency of localization by passing element information to<br></div>
<div>the localizer<br></div>
<div>* ensure consistency of formatting by ensuring all of the same \
elements,<br></div> <div>for example command names, are marked up the same \
way<br></div> <div>* allow for future automated testing with a project like \
`emender`<br></div> <div><br></div>
<div>I went through the Installation Guide and found 97 DocBook XML tags.<br></div>
<div>I've put them in the table on this wiki page:<br></div>
<div><br></div>
<div><a href="https://fedoraproject.org/wiki/Docs_Tag_Discussion">https://fedoraproject.org/<wbr>wiki/Docs_Tag_Discussion</a><br></div>
 <div><br></div>
<div>Please visit the page and edit it to weigh in on preferences about the<br></div>
<div>tags.<br></div>
<div><br></div>
<div>I believe this will help us complete our AsciiDoc style guide and do \
the<br></div> <div>conversions more rapidly and effectively.<br></div>
<div><br></div>
<div>Today, if you want to discuss implementation of these tags in \
AsciiDoc,<br></div> <div>please start a separate email thread.<br></div>
<div><br></div>
<div>Thank you.<br></div>
<div><br></div>
<div>regards,<br></div>
<div><br></div>
<div>bex<br></div>
<div>--<br></div>
<div>docs mailing list<br></div>
<div><a href="mailto:docs@lists.fedoraproject.org">docs@lists.fedoraproject.org</a><br></div>
 <div>To unsubscribe:<br></div>
<div><a href="https://lists.fedoraproject.org/admin/lists/docs@lists.fedoraproject.org \
">https://lists.fedoraproject.<wbr>org/admin/lists/docs@lists.<wbr>fedoraproject.org</a><br></div>
 </blockquote></div>
</div>
<div>--<br></div>
<div>docs mailing list<br></div>
<div><a href="mailto:docs@lists.fedoraproject.org">docs@lists.fedoraproject.org</a><br></div>
 <div>To unsubscribe:<br></div>
<div><a href="https://lists.fedoraproject.org/admin/lists/docs@lists.fedoraproject.org \
">https://lists.fedoraproject.org/admin/lists/docs@lists.fedoraproject.org</a><br></div>
 </blockquote><div><br></div>


<pre>--
docs mailing list
<a href="mailto:docs@lists.fedoraproject.org">docs@lists.fedoraproject.org</a>
To unsubscribe:
<a href="https://lists.fedoraproject.org/admin/lists/docs@lists.fedoraproject.org">htt \
ps://lists.fedoraproject.org/admin/lists/docs@lists.fedoraproject.org</a></pre></blockquote></body></html>



[Attachment #6 (text/plain)]

--
docs mailing list
docs@lists.fedoraproject.org
To unsubscribe:
https://lists.fedoraproject.org/admin/lists/docs@lists.fedoraproject.org

[prev in list] [next in list] [prev in thread] [next in thread] 

Configure | About | News | Add a list | Sponsored by KoreLogic