Currently the documentation is in odt format: Spice_for_newbies.odt Spice_protocol.odt Spice_style.odt Spice_user_manual.odt Vd_interfaces.odt It would be useful to convert it to asciidoc, so it can be easily included on our website.
started converting Spice_style.odt, see https://lists.freedesktop.org/archives/spice-devel/2016-May/028916.html
Created attachment 132486 [details] [review] asciidoctor files Starting to convert the odt files to adoc 3 docs are already done Spice_for_newbies.odt -> Spice_for_newbies.adoc Spice_protocol.odt -> Spice_protocol.adoc Vd_interfaces -> Vd_interfaces.adoc
Hi Thiago, we don't use bugzilla to review the patches, please send them to the mailing list ( https://www.spice-space.org/developers.html#like-to-send-a-patch ) Regarding your patch - I'd suggest splitting it for each odt file. Makefile can be updated to generated documentation from adoc files (like it is done for the spice style document) Have you used a script to convert the files? I noticed some strange characters in the converted files. Thanks for the interest!
(In reply to Pavel Grunt from comment #4) > Hi Thiago, > we don't use bugzilla to review the patches, please send them to the mailing > list ( https://www.spice-space.org/developers.html#like-to-send-a-patch ) > > Regarding your patch - I'd suggest splitting it for each odt file. Makefile > can be updated to generated documentation from adoc files (like it is done > for the spice style document) > > Have you used a script to convert the files? I noticed some strange > characters in the converted files. > > Thanks for the interest! No scripts. What I did: I export to a txt file using the LibreOffice and after that I started working on each document to convert it to the asciidoc format using their website documentation as a guide. Could you tell me more about the strange characters?...so I could have a look :). There are 5 images from the "Spice for newbies" in this patch. Gonna fix the strange characters, put every document in a different patch and send it and follow the "https://www.spice-space.org/developers.html#like-to-send-a-patch" instructions. Thanks for telling me about this. :)
Comment on attachment 132486 [details] [review] asciidoctor files Review of attachment 132486 [details] [review]: ----------------------------------------------------------------- ::: docs/Spice_for_newbies.adoc @@ +1,1 @@ > += Spice for Newbies: Red Hat, Inc ^ strange character @@ +3,5 @@ > +:revdate: 01.01.2009 > +:revremark: Draft 1 > +:imagesdir: ./images/newbies > + > +Copyright © 2009 Red Hat, Inc. + another ^ @@ +74,5 @@ > +ChannelFactory is the base class for all channel factories. Each channel registers its specific factory for enabling RedClient to create channels by channel type. > ++ > +.. Screens and Windows > ++ > +* ScreenLayer â screen layer is attached to specific screen, providing operations on rectangle areas (set, clear, update, invalidate, etc.). Layers are z-ordered (e.g., cursor is above display). another --^ ::: docs/Vd_interfaces.adoc @@ +3,5 @@ > +:revdate: 01.01.2009 > +:revremark: Draft 1 > +:imagesdir: ./images/newbies > + > +Copyright © 2009 Red Hat, Inc. +· another weird character --^
(In reply to Pavel Grunt from comment #6) > Comment on attachment 132486 [details] [review] [review] > asciidoctor files > > Review of attachment 132486 [details] [review] [review]: > ----------------------------------------------------------------- > > ::: docs/Spice_for_newbies.adoc > @@ +1,1 @@ > > += Spice for Newbies: Red Hat, Inc > > ^ strange character > > @@ +3,5 @@ > > +:revdate: 01.01.2009 > > +:revremark: Draft 1 > > +:imagesdir: ./images/newbies > > + > > +Copyright © 2009 Red Hat, Inc. + > > another ^ > > @@ +74,5 @@ > > +ChannelFactory is the base class for all channel factories. Each channel registers its specific factory for enabling RedClient to create channels by channel type. > > ++ > > +.. Screens and Windows > > ++ > > +* ScreenLayer â screen layer is attached to specific screen, providing operations on rectangle areas (set, clear, update, invalidate, etc.). Layers are z-ordered (e.g., cursor is above display). > > another --^ > > ::: docs/Vd_interfaces.adoc > @@ +3,5 @@ > > +:revdate: 01.01.2009 > > +:revremark: Draft 1 > > +:imagesdir: ./images/newbies > > + > > +Copyright © 2009 Red Hat, Inc. +· > > another weird character --^ --> This one: = Spice for Newbies: Red Hat, Inc Can't find it here. --> This one: Copyright © 2009 Red Hat, Inc. + It was me, not a script. I was using the unicode-value: http://asciidoctor.org/docs/asciidoc-writers-guide/#replacements but I can replace it with a (C) --> This one: * ScreenLayer â screen layer is attached to specific screen, providing operations on rectangle areas (set, clear, update, invalidate, etc.). Layers are z-ordered (e.g., cursor is above display). No idea. Gonna fix it. Thanks for showing me :)
(In reply to Pavel Grunt from comment #4) > Hi Thiago, > we don't use bugzilla to review the patches, please send them to the mailing > list ( https://www.spice-space.org/developers.html#like-to-send-a-patch ) > > Regarding your patch - I'd suggest splitting it for each odt file. Makefile > can be updated to generated documentation from adoc files (like it is done > for the spice style document) > > Have you used a script to convert the files? I noticed some strange > characters in the converted files. > > Thanks for the interest! Pavel. I have a question about the patchs. I made 3 patchs to send by email. One per asciidoc file but the first one still a bit big because of the image files. Wondering if it is ok sending it this way. Again: thanks for helping!(In reply to Pavel Grunt from comment #4) > Hi Thiago, > we don't use bugzilla to review the patches, please send them to the mailing > list ( https://www.spice-space.org/developers.html#like-to-send-a-patch ) > > Regarding your patch - I'd suggest splitting it for each odt file. Makefile > can be updated to generated documentation from adoc files (like it is done > for the spice style document) > > Have you used a script to convert the files? I noticed some strange > characters in the converted files. > > Thanks for the interest! Pavel. I have a question about the patchs. I made 3 patchs to send by email. One per asciidoc file but the first one still a bit big because of the image files. Wondering if it is ok sending it this way. Again: thanks for helping!
(In reply to Thiago Mendes from comment #7) > (In reply to Pavel Grunt from comment #6) > > --> This one: = Spice for Newbies: Red Hat, Inc > Can't find it here. > > --> This one: Copyright © 2009 Red Hat, Inc. + > > It was me, not a script. I was using the unicode-value: > http://asciidoctor.org/docs/asciidoc-writers-guide/#replacements but I can > replace it with a (C) > yeah, that should work, see: http://asciidoctor.org/docs/asciidoc-syntax-quick-reference/#text-replacement (In reply to Thiago Mendes from comment #8) > (In reply to Pavel Grunt from comment #4) > > Hi Thiago, > > we don't use bugzilla to review the patches, please send them to the mailing > > list ( https://www.spice-space.org/developers.html#like-to-send-a-patch ) > > > > [...] > > Pavel. I have a question about the patchs. I made 3 patchs to send by email. > One per asciidoc file but the first one still a bit big because of the image > files. Wondering if it is ok sending it this way. > It should be ok
Thanks again Pavel Just to update you: I have all the files here. I'm facing some problems with the command "git send-email" and archlinux but I'm a bit busy this week and the next few weeks to check and fix it so I'll leave it for latter. As soon as I have time I will check why I'm getting errors from Perl when I try to use the git send-email, fix it and finally send the patch I have here. Sorry about that. I hope to be able to send it soon. Cheers, Thiago
Hi Thiago, no problems. Do you have a git branch with your patches somewhere? I can take a look there. Or you can attach the updated patches here and send them to the MailingList later.
(In reply to Pavel Grunt from comment #11) > Hi Thiago, > > no problems. Do you have a git branch with your patches somewhere? I can > take a look there. Or you can attach the updated patches here and send them > to the MailingList later. I have it in my linux only. I'll attach the files here. Sorry about that. Gonna work on fix git send-email as soon as possible so I can work on trying to fix some issue here and send the patch in the right way!! Thanks again Pavel!
Created attachment 132639 [details] [review] Converting Spice_for_newbies This files contains a few image files too.
Created attachment 132640 [details] [review] Converting Spice_protocol
Created attachment 132641 [details] [review] C
(In reply to Thiago Mendes from comment #15) > Created attachment 132641 [details] [review] [review] > C Converting Vd_interfaces (patch)
-- GitLab Migration Automatic Message -- This bug has been migrated to freedesktop.org's GitLab instance and has been closed from further activity. You can subscribe and participate further through the new bug through this link to our GitLab instance: https://gitlab.freedesktop.org/spice/spice-server/issues/10.
Use of freedesktop.org services, including Bugzilla, is subject to our Code of Conduct. How we collect and use information is described in our Privacy Policy.