Changed submitted file format to DocBook #105
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This is the proposed update to the LDP rp_filter documentation with the jpeg and source of the graphic embedded in the document
Converted OpenOffice format to DocBook. Hopefully that's what you want, if not let me know what i need to do.
|
Hi, attaching graphics is described here I think: https://tldp.org/LDP/LDP-Author-Guide/html/inserting-pictures.htm Please have a look into similar howtos which are attaching graphics as examples to be sure how does it work. |
Alternate format as requested by the documentation.
Fixed deficiencies.
|
The URL below went to the main site, the reason is a missing, trailing "l". I found the actual URL: https://tldp.org/LDP/LDP-Author-Guide/html/inserting-pictures.html Based on that, I uploaded the picture in eps format as well. I'm not sure if I'm supposed to edit the XML to refer to it (when i pulled up my local copy of the XML the image didn't render). If i need to then let me know, thanks for your help.
…-----Original Message-----
From: ᎠᎡ. Ѕϵrgϵ Ѵictor ***@***.***>
To: tLDP/LDP ***@***.***>
Cc: Leroy Tennison ***@***.***>; Author ***@***.***>
Sent: Mon, Aug 8, 2022 10:46 am
Subject: Re: [tLDP/LDP] Changed submitted file format to DocBook (PR #105)
Hi, attaching graphics is described here I think:https://tldp.org/LDP/LDP-Author-Guide/html/inserting-pictures.htmPlease have a look into similar howtos which are attaching graphics as examples to be sure how does it work.—
Reply to this email directly, view it on GitHub, or unsubscribe.
You are receiving this because you authored the thread.Message ID: ***@***.***>
|
|
You definitely need to edit xml file as without it your graphics is not referenced - this is why I suggested to have a look into other documents as examples. EPS is not required, JPG or PNG is completely enough. |
Modified to use TLDP method of including a picture
|
I have used the the "Inserting Pictures" URL to modify the document to refer to the picture and uploaded the change. My only concern is the path to the file, I simply referred to the file name so, if GitHub doesn't assume current working directory, the jpg won't be found and I'll need help to modify the path to get it correct.
…-----Original Message-----
From: ᎠᎡ. Ѕϵrgϵ Ѵictor ***@***.***>
To: tLDP/LDP ***@***.***>
Cc: Leroy Tennison ***@***.***>; Author ***@***.***>
Sent: Mon, Aug 8, 2022 7:50 pm
Subject: Re: [tLDP/LDP] Changed submitted file format to DocBook (PR #105)
You definitely need to edit xml file as without it your graphics is not referenced - this is why I suggested to have a look into other documents as examples. EPS is not required, JPG or PNG is completely enough.—
Reply to this email directly, view it on GitHub, or unsubscribe.
You are receiving this because you authored the thread.Message ID: ***@***.***>
|
|
Hi, you correctly noticed that situation is not correct. You need to edit the source file in its very location, modifying it's content. At the moment you just added a new file to our repository, which has no reference at all. Try to think it out, if any problems, just comment here. |
|
I discovered the "Copy path" option and edited the file in place using what I copied, and submitted a pull request which said it automatically merged the change. Hopefully that's what was needed.
…-----Original Message-----
From: ᎠᎡ. Ѕϵrgϵ Ѵictor ***@***.***>
To: tLDP/LDP ***@***.***>
Cc: Leroy Tennison ***@***.***>; Author ***@***.***>
Sent: Tue, Aug 9, 2022 1:59 pm
Subject: Re: [tLDP/LDP] Changed submitted file format to DocBook (PR #105)
Hi, you correctly noticed that situation is not correct. You need to edit the source file in its very location, modifying it's content. At the moment you just added a new file to our repository, which has no reference at all. Try to think it out, if any problems, just comment here.—
Reply to this email directly, view it on GitHub, or unsubscribe.
You are receiving this because you authored the thread.Message ID: ***@***.***>
|
|
Hi, is this the Howto which are you updating? https://github.com/tLDP/LDP/blob/master/LDP/howto/docbook/Adv-Routing-HOWTO.sgml |
|
No, this is intended to replace https://tldp.org/HOWTO/Adv-Routing-HOWTO/lartc.kernel.rpf.html.
…-----Original Message-----
From: ᎠᎡ. Ѕϵrgϵ Ѵictor ***@***.***>
To: tLDP/LDP ***@***.***>
Cc: Leroy Tennison ***@***.***>; Author ***@***.***>
Sent: Wed, Aug 10, 2022 6:53 am
Subject: Re: [tLDP/LDP] Changed submitted file format to DocBook (PR #105)
Hi, is this the Howto which are you updating?https://github.com/tLDP/LDP/blob/master/LDP/howto/docbook/Adv-Routing-HOWTO.sgml—
Reply to this email directly, view it on GitHub, or unsubscribe.
You are receiving this because you authored the thread.Message ID: ***@***.***>
|
|
OK, so instead of creating a new file, you need to modify existing one you just pointed on :) And please put the assisting graphics in the same subdirectory. |
|
OK. I was intending to totally replace what was there with what i submitted. If i need to, I don't know how to edit what is there (this is my first submission and the learning curve is somewhat steep). Could you send me a URL with instructions or explain what to do? Thanks.
…-----Original Message-----
From: ᎠᎡ. Ѕϵrgϵ Ѵictor ***@***.***>
To: tLDP/LDP ***@***.***>
Cc: Leroy Tennison ***@***.***>; Author ***@***.***>
Sent: Wed, Aug 10, 2022 10:01 pm
Subject: Re: [tLDP/LDP] Changed submitted file format to DocBook (PR #105)
OK, so instead of creating a new file, you need to modify existing one you just pointed on :) And please put the assisting graphics in the same subdirectory.—
Reply to this email directly, view it on GitHub, or unsubscribe.
You are receiving this because you authored the thread.Message ID: ***@***.***>
|
|
Sure, I can understand, this is why I'm guiding you to reach the goal :-) You can edit file using a web browser, or using a "git" command on your PC. Editing on the web is simple if you need to just edit one file: https://docs.github.com/en/repositories/working-with-files/managing-files/editing-files |
|
If you use a git command on your PC, workflow is described here: |
This is a proposed replacement for https://tldp.org/HOWTO/Adv-Routing-HOWTO/lartc.kernel.rpf.html.
Update Adv-Routing-HOWTO.sgml
|
We are getting closer, but you can't add these tags far inside the document: |
Removed problem tag
Update Adv-Routing-HOWTO.sgml
|
Fixed (I think). Deleted that line.
…-----Original Message-----
From: ᎠᎡ. Ѕϵrgϵ Ѵictor ***@***.***>
To: tLDP/LDP ***@***.***>
Cc: Leroy Tennison ***@***.***>; Author ***@***.***>
Sent: Fri, Aug 12, 2022 7:44 pm
Subject: Re: [tLDP/LDP] Changed submitted file format to DocBook (PR #105)
We are getting closer, but you can't add these tags far inside the document:<?xml version="1.0" encoding="UTF-8"?>
—
Reply to this email directly, view it on GitHub, or unsubscribe.
You are receiving this because you authored the thread.Message ID: ***@***.***>
|
|
Not really, I included example only of unwanted syntax, there is more, eg. Please check syntax of the whole file with a proper lint tool, for example: https://github.com/davidmalcolm/docbook-lint or any other tool you find suitable for you. |
|
Trying to use docbook-lint, I downloaded the files into a directory and created docbook-lint by copying/pasting contents from github into a file making it executable. Unfortunately I don't know enough about python to use it. When i executed the sxcript I created, I got an error about not finding docbooklink.linter. I have phyton2 (points to python 2.7) and python3 (points to python3.8) on my system. I changed "/usr/bin/env python" to "/usr/bin/env python2" when the script didn't run initially. Do i need python2 or python3? What else do I need to know? Thanks for your help.
…-----Original Message-----
From: ᎠᎡ. Ѕϵrgϵ Ѵictor ***@***.***>
To: tLDP/LDP ***@***.***>
Cc: Leroy Tennison ***@***.***>; Author ***@***.***>
Sent: Sat, Aug 13, 2022 12:06 am
Subject: Re: [tLDP/LDP] Changed submitted file format to DocBook (PR #105)
Not really, I included example only of unwanted syntax, there is more, eg.<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
<article lang="">
Please check syntax of the whole file with a proper lint tool, for example:https://github.com/davidmalcolm/docbook-lintor any other tool you find suitable for you.—
Reply to this email directly, view it on GitHub, or unsubscribe.
You are receiving this because you authored the thread.Message ID: ***@***.***>
|
|
Well, I have since discovered that the OpenOffice translation of my document to DocBook was woefully inadequate. Do you know of a good front end to Docbook?
…-----Original Message-----
From: ᎠᎡ. Ѕϵrgϵ Ѵictor ***@***.***>
To: tLDP/LDP ***@***.***>
Cc: Leroy Tennison ***@***.***>; Author ***@***.***>
Sent: Sat, Aug 13, 2022 12:06 am
Subject: Re: [tLDP/LDP] Changed submitted file format to DocBook (PR #105)
Not really, I included example only of unwanted syntax, there is more, eg.<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
<article lang="">
Please check syntax of the whole file with a proper lint tool, for example:https://github.com/davidmalcolm/docbook-lintor any other tool you find suitable for you.—
Reply to this email directly, view it on GitHub, or unsubscribe.
You are receiving this because you authored the thread.Message ID: ***@***.***>
|
|
Hi, sorry for delays with reply about lint - I'm struggling with my work tasks and I need some time to give you valuable answers. Give me some more time please. About the editor: I would recommend to write this question to discuss@en.tldp.org list - there are smarter guys sitting there than me. |
|
No problem - I understand. Thanks for the help, I appreciate it.
…-----Original Message-----
From: ᎠᎡ. Ѕϵrgϵ Ѵictor ***@***.***>
To: tLDP/LDP ***@***.***>
Cc: Leroy Tennison ***@***.***>; Author ***@***.***>
Sent: Mon, Aug 15, 2022 8:47 pm
Subject: Re: [tLDP/LDP] Changed submitted file format to DocBook (PR #105)
Hi, sorry for delays with reply - I'm struggling with my work tasks and I need some time to give you valuable answers. Give me some more time please.—
Reply to this email directly, view it on GitHub, or unsubscribe.
You are receiving this because you authored the thread.Message ID: ***@***.***>
|
|
I've just found this friendly guide in my links: https://opensource.com/article/17/9/docbook And it points to the linter you should have ready available in your Linux, |
|
This was most helpful, particularly the reference to pandoc. However, pandoc didn't translate a tag I was trying to use (<application>). Reading the man page caused me to realize that the output might be incomplete which leads to a few questions:
Is there a way (or tool) to view the translation of docbook to Linux Documentation Project output?Is there a list of docbook tags/attributes that the Linux Documentation Project supports?
I've done a fair amount of writing in "basic html" (no stylesheets, just tags) so I'm not adverse to using docbook but, before i invest time/effort in that, I'd like to know what i can count on and what to ignore. Thanks for your help.
-----Original Message-----
From: ᎠᎡ. Ѕϵrgϵ Ѵictor ***@***.***>
To: tLDP/LDP ***@***.***>
Cc: Leroy Tennison ***@***.***>; Author ***@***.***>
Sent: Mon, Aug 15, 2022 10:36 pm
Subject: Re: [tLDP/LDP] Changed submitted file format to DocBook (PR #105)
I've just found this friendly guide in my links:https://opensource.com/article/17/9/docbookAnd it points to the linter you should have ready available in your Linux, xmllint, in my ubuntu it is in package: libxml2-utils—
Reply to this email directly, view it on GitHub, or unsubscribe.
You are receiving this because you authored the thread.Message ID: ***@***.***>
|
|
I would recommend you to briefly browse the nearby howtos and check how they are written - you can compare the results with the sources and learn by example. Unfortunately we had a general power failure in the serverhouse and admins still did not recover our machines - so the website is currently offline, but I am sure you can find copies of our documents somewhere meanwhile. On Monday we are 100% back online. Sorry :) |
|
Related to changes of |
|
I did the edit using a web browser, hopefully i did it correctly.
…-----Original Message-----
From: ᎠᎡ. Ѕϵrgϵ Ѵictor ***@***.***>
To: tLDP/LDP ***@***.***>
Cc: Leroy Tennison ***@***.***>; Author ***@***.***>
Sent: Thu, Aug 11, 2022 7:35 pm
Subject: Re: [tLDP/LDP] Changed submitted file format to DocBook (PR #105)
Sure, I can understand, this is why I'm guiding you to reach the goal :-)You can edit file using a web browser, or using a "git" command on your PC.Editing on the web is simple if you need to just edit one file:https://docs.github.com/en/repositories/working-with-files/managing-files/editing-files—
Reply to this email directly, view it on GitHub, or unsubscribe.
You are receiving this because you authored the thread.Message ID: ***@***.***>
|
No, you have to run the SGML through a validitator first and usually SGML is generated from e.g. LyX or other editors, which can export SGML. Direct editing of SGML is dangerous. |
|
I've been away from this and finally got back to it. I abandoned the DocBook generated by OpenOffice (which was badly broken) and tried both AbiWord and XMLmind. AbiWord did much better but I ended up using it to save the article as a DOCX and importing it into XMLmind. I uploaded the output from XMLmind after a few modifications, how does it look?
…-----Original Message-----
From: ᎠᎡ. Ѕϵrgϵ Ѵictor ***@***.***>
To: tLDP/LDP ***@***.***>
Cc: Leroy Tennison ***@***.***>; Author ***@***.***>
Sent: Sat, Aug 20, 2022 7:34 am
Subject: Re: [tLDP/LDP] Changed submitted file format to DocBook (PR #105)
I would recommend you to briefly browse the nearby howtos and check how they are written - you can compare the results with the sources and learn by example.Unfortunately we had a general power failure in the serverhouse and admins still did not recover our machines - so the website is currently offline, but I am sure you can find copies of our documents somewhere meanwhile. On Monday we are 100% back online. Sorry :)—
Reply to this email directly, view it on GitHub, or unsubscribe.
You are receiving this because you authored the thread.Message ID: ***@***.***>
|
|
pulled your master from -> You've implanted a complete SGML doc into an existing SGML incl. header...this is not passing the validator. Please adjust your PR that it is passing the validator. |
Removed the xml, DOCTYPE and article references.
|
I have made the changes and hope they are what is needed. If there are still issues I may need some help in understanding what to do, my knowledge of docbook is minimal.
…-----Original Message-----
From: Peter Bieringer ***@***.***>
To: tLDP/LDP ***@***.***>
Cc: Leroy Tennison ***@***.***>; Author ***@***.***>
Sent: Sat, Oct 15, 2022 3:41 pm
Subject: Re: [tLDP/LDP] Changed submitted file format to DocBook (PR #105)
pulled your master from https://raw.githubusercontent.com/LTennis/LTennis-LDP/master/LDP/howto/docbook/Adv-Routing-HOWTO.sgml and ran validator:LC_ALL=C openjade Adv-Routing-HOWTO.sgml
openjade:Adv-Routing-HOWTO.sgml:5103:2:E: "DOCTYPE" declaration not allowed in instance
openjade:Adv-Routing-HOWTO.sgml:5105:16:E: document type does not allow element "ARTICLE" here
...
-> You've implanted a complete SGML doc into an existing SGML incl. header...this is not passing the validator.Please adjust your PR that it is passing the validator.—
Reply to this email directly, view it on GitHub, or unsubscribe.
You are receiving this because you authored the thread.Message ID: ***@***.***>
|
pbiering
added a commit
to pbiering/LDP
that referenced
this pull request
Oct 18, 2022
pbiering
added a commit
to pbiering/LDP
that referenced
this pull request
Oct 18, 2022
pbiering
added a commit
to pbiering/LDP
that referenced
this pull request
Oct 18, 2022
|
unfortunatly it's not working in this way, had to create a new PR with adjusted sgml (replacing unsupported chars like opening-", closing-", long-dash, Unicode c2a0) also relocated to a new subdirectory to align storage path of pictures with other SGML docs: Please submit next time only changes direct to SGML, thank you! |
|
Thanks for helping with this, I'm sorry it is creating all this trouble for you. I'm assuming that "opening-" refers to text such as "-a" and "closing-" refers to individual dashes, I can't find anything else in the text. I also haven't been able to locate an instance of Unicode c2a0. I had no idea it would create such problems. Can you point me to something showing what is and isn't allowed in TLDP's Docbook implementation? Since i knew nothing about Docbook before submitting this change (and still know very little) would it be better if I submitted in another format such as PDF?
…-----Original Message-----
From: Peter Bieringer ***@***.***>
To: tLDP/LDP ***@***.***>
Cc: Leroy Tennison ***@***.***>; Author ***@***.***>
Sent: Tue, Oct 18, 2022 1:24 am
Subject: Re: [tLDP/LDP] Changed submitted file format to DocBook (PR #105)
unfortunatly it's not working in this way, had to create a new PR with adjusted sgml (replacing unsupported chars like opening-", closing-", long-dash, Unicode c2a0) also relocated to a new subdirectory to align storage path of pictures with other SGML docs:#106Please submit next time only changes direct to SGML, thank you!—
Reply to this email directly, view it on GitHub, or unsubscribe.
You are receiving this because you authored the thread.Message ID: ***@***.***>
|
|
Based on your original https://raw.githubusercontent.com/LTennis/LTennis-LDP/master/LDP/howto/docbook/Adv-Routing-HOWTO.sgml following problematic chars found: also it didn't like Can't replay the unicode PDF submission is not a good idea, because SGML is used to create various formats like TXT, single page HTML, multipage HTML and tLDP-styled PDF. Here is a list of SGML editors: https://www.ibiblio.org/gferg/ldp/sgml_edit.html But for further extensions is probably simpler, editing the SGML directly e.g in You can verify (after installing locally |
|
OK, I was under the impression that using xmllint to check the xml i was proposing was adequate, I guess that's not true. I installed openjade and tried running it locally but apparently I'm missing a dsl file. At this point my question is "Where do i go from here?" You mentioned that you had to create a new PR, I don't know how to even look at it (or if i even need to).
…-----Original Message-----
From: Peter Bieringer ***@***.***>
To: tLDP/LDP ***@***.***>
Cc: Leroy Tennison ***@***.***>; Author ***@***.***>
Sent: Wed, Oct 19, 2022 11:29 pm
Subject: Re: [tLDP/LDP] Changed submitted file format to DocBook (PR #105)
Based on your original https://raw.githubusercontent.com/LTennis/LTennis-LDP/master/LDP/howto/docbook/Adv-Routing-HOWTO.sgml following problematic chars found:# individual dash "opening":
openjade:Adv-Routing-HOWTO.sgml:5198:238:E: non SGML character number 128
openjade:Adv-Routing-HOWTO.sgml:5198:239:E: non SGML character number 156
# individual dash "closing":
openjade:Adv-Routing-HOWTO.sgml:5198:270:E: non SGML character number 157
# long dash:
openjade:Adv-Routing-HOWTO.sgml:5233:209:E: non SGML character number 147
also it didn't like <para/> and <listitem/> (simply removed) and the <graphic ...></graphic> statement (whole section replaced by <mediaobject>...</mediaobject>Can't replay the unicode c2a0 issue, potentially caused by local tests.PDF submission is not a good idea, because SGML is used to create various formats like TXT, single page HTML, multipage HTML and tLDP-styled PDF.Here is a list of SGML editors: https://www.ibiblio.org/gferg/ldp/sgml_edit.htmlBut for further extensions is probably simpler, editing the SGML directly e.g in vim which supports syntax highlighting.You can verify (after installing locally openjade) the SGML all the time by creating a single-page HTML:openjade -t sgml -i html -V nochunks -d "<path/to>/LDP/LDP/builder/dsssl/ldp.dsl#html" Adv-Routing-HOWTO.sgml >Adv-Routing-HOWTO.html
—
Reply to this email directly, view it on GitHub, or unsubscribe.
You are receiving this because you authored the thread.Message ID: ***@***.***>
|
|
@LTennis : the "dsl" file is located here: https://github.com/tLDP/LDP/tree/master/LDP/builder/dsssl |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Do you need/want the jpeg?