Suggestion regarding the documentation
- RGH
- Offline
- Junior Member
- 
				  
		Less
		More
		
			
	
		- Posts: 35
- Thank you received: 13
			
	
						24 Mar 2022 15:00				#238230
		by RGH
	
	
		
			
	
			
			 		
													
	
				Replied by RGH on topic Suggestion regarding the documentation			
			
				I said I wouldn't post here anymore but here I am again.
Sorry if the initial post wasn't specific enough. The initial echo wasn't asking for details so I assumed the it was clear what I was referring to.
I also didn't check if the html docs also used those funny characters or if it was only the pdfs, so I assumed they did.
The pdf's have some advantages: Full text search maybe is arguably the most important one, e.g. when researching a topic. The ability to add own notes on text passages and highlighting stuff right in the document is nice to have too.
Also it's what's right there on the real machine in the shop that might not be connected to the internet.
Thanks for the suggestions regarding using the html docs/source/github, but I'm really not looking for help for me personally.
It was just an idea for a seemingly simple improvement...
Thanks for looking into it anyway!
					Sorry if the initial post wasn't specific enough. The initial echo wasn't asking for details so I assumed the it was clear what I was referring to.
I also didn't check if the html docs also used those funny characters or if it was only the pdfs, so I assumed they did.
The pdf's have some advantages: Full text search maybe is arguably the most important one, e.g. when researching a topic. The ability to add own notes on text passages and highlighting stuff right in the document is nice to have too.
Also it's what's right there on the real machine in the shop that might not be connected to the internet.
Thanks for the suggestions regarding using the html docs/source/github, but I'm really not looking for help for me personally.
It was just an idea for a seemingly simple improvement...
Thanks for looking into it anyway!
Please Log in or Create an account to join the conversation.
- andypugh
- 
				  
- Offline
- Moderator
- 
				  
		Less
		More
		
			
	
		- Posts: 19677
- Thank you received: 4553
			
	
						24 Mar 2022 22:24				#238287
		by andypugh
	
	
		
			
				
We have tried to fix it, but the fixes seem to make it worse.
github.com/LinuxCNC/linuxcnc/commit/4a89...8e98ea56a7417c9c88ad
 			
					
	
	
			 		
													
	
				Replied by andypugh on topic Suggestion regarding the documentation			
			Actually, I am forced to admit that you are right on the dashes. It's a complete pain but it's often the web browsers that do it. They publish a minus in the source as an en-dash on the page.Hours to decipher my hints? I described the issue right in the first post - dashes and single quotes.
We have tried to fix it, but the fixes seem to make it worse.
github.com/LinuxCNC/linuxcnc/commit/4a89...8e98ea56a7417c9c88ad
		The following user(s) said Thank You: snowgoer540 	
			Please Log in or Create an account to join the conversation.
- RGH
- Offline
- Junior Member
- 
				  
		Less
		More
		
			
	
		- Posts: 35
- Thank you received: 13
			
	
						26 Mar 2022 13:21				#238397
		by RGH
	
	
		
			
	
	
			 		
													
	
				Replied by RGH on topic Suggestion regarding the documentation			
			
				Don't want to stir the pot by opening another thread on docs but it seems worth mentioning:
I just noticed that linuxcnc_documentation.pdf and the online html version seem to be out of sync.
At least the whole section on QtVcp (linuxcnc.org/docs/stable/html/gui/qtvcp.html) seems to be missing in the pdf.
Currently I often switch between 'traditional book reading' the pdfs on an ebook reader when not sitting in front of the pc and htmls when actively doing stuff. So if I stumble upon other missing stuff I can let you know...
					I just noticed that linuxcnc_documentation.pdf and the online html version seem to be out of sync.
At least the whole section on QtVcp (linuxcnc.org/docs/stable/html/gui/qtvcp.html) seems to be missing in the pdf.
Currently I often switch between 'traditional book reading' the pdfs on an ebook reader when not sitting in front of the pc and htmls when actively doing stuff. So if I stumble upon other missing stuff I can let you know...
		The following user(s) said Thank You: snowgoer540 	
			Please Log in or Create an account to join the conversation.
- robertspark
- Offline
- Platinum Member
- 
				  
		Less
		More
		
			
	
		- Posts: 915
- Thank you received: 216
			
	
						26 Mar 2022 14:08				#238400
		by robertspark
	
	
		
			
	
			
			 		
													
	
				Replied by robertspark on topic Suggestion regarding the documentation			
			
				having just started to look at the pdfs (online) instead of the html docs on line, they do look different or have older content in them			
					Please Log in or Create an account to join the conversation.
- andypugh
- 
				  
- Offline
- Moderator
- 
				  
		Less
		More
		
			
	
		- Posts: 19677
- Thank you received: 4553
			
	
						29 Mar 2022 20:54				#238653
		by andypugh
	
	
		
			
	
			
			 		
													
	
				Replied by andypugh on topic Suggestion regarding the documentation			
			
				Not directly related, but there is a huge re-organisation of the docs underway to make translation into different languages easier. At the end of that all the docs should be automatically synching to the english version (though it would be nice to find a way that corrections / additions submitted in any language could be merged in)			
					Please Log in or Create an account to join the conversation.
- BigJohnT
- 
				  
- Offline
- Administrator
- 
				  
		Less
		More
		
			
	
		- Posts: 3990
- Thank you received: 994
			
	
						29 Mar 2022 22:22				#238669
		by BigJohnT
	
	
		
			
	
			
			 		
													
	
				Replied by BigJohnT on topic Suggestion regarding the documentation			
			
				There are two places in the docs to include a chapter, perhaps the QtVcp author forgot to put it in the Submakefile.
JT
					JT
Please Log in or Create an account to join the conversation.
- mcer
- Offline
- New Member
- 
				  
		Less
		More
		
			
	
		- Posts: 1
- Thank you received: 0
			
	
						20 Apr 2022 00:47				#240712
		by mcer
	
	
		
			
	
			
			 		
													
	
				Replied by mcer on topic Suggestion regarding the documentation			
			
				I don't know what's being used now but has switching to something like readthedocs.io been considered? It has some features to handle localization. I'm sure it'd be no small undertaking to change.			
					Please Log in or Create an account to join the conversation.
		Moderators: HansU	
		Time to create page: 0.149 seconds	
