Version-adaptive_documentation

2022-12-20 Thread Barry Duggan
I
 have created a plan to make certain pages of our Wiki be adaptive to 
the user's GNU Radio version (or desired version) so that sections which
 don't apply would be hidden. This makes cleaner page presentations and 
reduces the clutter of unrelated information. 



The method is documented in 
https://wiki.gnuradio.org/index.php?title=Version-adaptive_documentation. So 
far, https://wiki.gnuradio.org/index.php?title=Message_Debug and 
https://wiki.gnuradio.org/index.php?title=Packet_Communications_Test_Page have 
been marked up.



I would appreciate all comments and suggestions for improvement.



---

Barry Duggan KV4FV

Python Log Level GR 3.10

2022-12-20 Thread Merlo, Jason
I’ve been having trouble migrating my OOT module to GR 3.10 (currently testing 
with 3.10.5) due to the Python block logging levels not working as they did 
prior to 3.10.  Currently, I have a parameter on most of my blocks to 
selectively set the log level per block instance to help filter what is 
printing, however, it doesn’t seem this works anymore.

The way I have it implemented is in the __init__ function of my blocks I run:
self.logger = gr.logger(self.alias())
self.logger.set_level(log_level)

Then elsewhere in the class issue logging statements as usual: 
self.logger.debug(f’some debug message')

In GR 3.9, this would print “some debug message” if that block’s log_level was 
set to debug. However, now in 3.10 it appears nothing is being printed to 
stdout at all, regardless of log level.

I’m aware there have been some changes in the logger in 3.10, but the OOT 
porting guide suggests the only that need to be made are with the C++ logger 
(and that the old logging API still works—for now).

Are there any changes that must be made to the Python logger too?

Thanks in advance!
Jason


signature.asc
Description: Message signed with OpenPGP


Version-adaptive_documentation

2022-12-20 Thread Barry Duggan
I have created a plan to make certain pages of our Wiki be adaptive to the 
user's GNU Radio version (or desired version) so that sections which don't 
apply would be hidden. This makes cleaner page presentations and reduces the 
clutter of unrelated information. 



The method is documented in 
https://wiki.gnuradio.org/index.php?title=Version-adaptive_documentation. So 
far, https://wiki.gnuradio.org/index.php?title=Message_Debug and 
https://wiki.gnuradio.org/index.php?title=Packet_Communications_Test_Page have 
been marked up.



I would appreciate all comments and suggestions for improvement.



---

Barry Duggan KV4FV

Re: Version-adaptive_documentation

2022-12-20 Thread Adrian Musceac
On Tuesday, 20 December 2022 16:40:46 EET Barry Duggan wrote:
> I have created a plan to make certain pages of our Wiki be adaptive to the
> user's GNU Radio version (or desired version) so that sections which don't
> apply would be hidden. This makes cleaner page presentations and reduces
> the clutter of unrelated information.
> 

This proposed change will have the following effects:

- Usability is greatly reduced if using web clients which don't support 
Javascript (yes some people still use clients like links and w3m from the 
terminal)
- On some user setups Javascript is disallowed for security reasons so content 
will no longer be accessible
- Breaks content indexing for some search engines

The general trend of making web pages heavily dependent on Javascript and thus 
unusable for some of us is frankly sad and I would not have expected to see 
this happen in a GNU project wiki.
Please don't break the documentation in this way.

Regards,
Adrian







Re: Version-adaptive_documentation

2022-12-20 Thread Marcus Müller

In that case, please accept my apologies for the harsh tone!

Best regards,
Marcus

On 20.12.22 17:58, Adrian Musceac wrote:

Hi Marcus,
  

The general trend of making web pages heavily dependent on Javascript


It's an *optional* script that can be used to select what's visible, if
scripting is available. If not available, you get a nicely structured plain
text site, as before.


Then please ignore my complaint, I thought this would make Javascript
mandatory to see the content. Since this is not the case, it is obviously my
fault for assuming that.


  and thus unusable for some of us is frankly sad


Ok, not my style to be *this* direct, but since you're actively trying to
guilt-trip Barry:

You're exposed to a website that works perfectly, contrary to your claims,
both in obsolete browsers and under disabling JavaScript. It's just
*better* with. I honestly don't think you get to lament your "loss" here.



I apologise if it came off like that. It was not my intention to guilt-trip
anyone. I am simply noticing more and more websites that don't work without
Javascript or only work with certain browsers and I thought this will be the
case too. Since I was obviously wrong I have to take your criticism as
warranted. I am sorry if I have offended you or Barry.

Regards,
Adrian





smime.p7s
Description: S/MIME Cryptographic Signature


Re: Version-adaptive_documentation

2022-12-20 Thread Adrian Musceac
On Tuesday, 20 December 2022 19:19:00 EET you wrote:
> Hi Adrian,

> Thank you for your feedback and concerns!
>
> I have tested the pages with several browsers where I have disabled
> JavaScript. 
> 
> There were no detrimental effects. The option to choose a version just
> didn't show up.
> 
> Note also that the entire content is shown. That is the default condition
> upon loading the page and is also what you get if selecting the "All"
> choice if scripts are enabled.
> 
> If you have tested a page with a client you have noted and had a problem, I
> would like to know more about it.
> 

Hi Barry,

Like Marcus pointed out, I shot the first email on just an assumption and 
without checking and understanding the changes. The pages work fine here and I 
apologise again for my confusion. Thank you for providing this documentation 
to us!

Regards,
Adrian





Re: Version-adaptive_documentation

2022-12-20 Thread Adrian Musceac
Hi Marcus,
 
> > The general trend of making web pages heavily dependent on Javascript
> 
> It's an *optional* script that can be used to select what's visible, if
> scripting is available. If not available, you get a nicely structured plain
> text site, as before.

Then please ignore my complaint, I thought this would make Javascript 
mandatory to see the content. Since this is not the case, it is obviously my 
fault for assuming that.

> >  and thus unusable for some of us is frankly sad
> 
> Ok, not my style to be *this* direct, but since you're actively trying to
> guilt-trip Barry:
> 
> You're exposed to a website that works perfectly, contrary to your claims,
> both in obsolete browsers and under disabling JavaScript. It's just
> *better* with. I honestly don't think you get to lament your "loss" here.
> 

I apologise if it came off like that. It was not my intention to guilt-trip 
anyone. I am simply noticing more and more websites that don't work without 
Javascript or only work with certain browsers and I thought this will be the 
case too. Since I was obviously wrong I have to take your criticism as 
warranted. I am sorry if I have offended you or Barry.

Regards,
Adrian






Re: Version-adaptive_documentation

2022-12-20 Thread Barry Duggan
Hi Adrian,



Thank you for your feedback and concerns!



I have tested the pages with several browsers where I have disabled JavaScript.



There were no detrimental effects. The option to choose a version just didn't 
show up.



Note also that the entire content is shown. That is the default condition upon 
loading the page and is also what you get if selecting the "All" choice if 
scripts are enabled.



If you have tested a page with a client you have noted and had a problem, I 
would like to know more about it.



---

Barry Duggan








 On Tue, 20 Dec 2022 10:13:34 -0600 Adrian Musceac  
wrote ---



On Tuesday, 20 December 2022 16:40:46 EET Barry Duggan wrote: 
> I have created a plan to make certain pages of our Wiki be adaptive to the 
> user's GNU Radio version (or desired version) so that sections which don't 
> apply would be hidden. This makes cleaner page presentations and reduces 
> the clutter of unrelated information. 
> 
 
This proposed change will have the following effects: 
 
- Usability is greatly reduced if using web clients which don't support 
Javascript (yes some people still use clients like links and w3m from the 
terminal) 
- On some user setups Javascript is disallowed for security reasons so content 
will no longer be accessible 
- Breaks content indexing for some search engines 
 
The general trend of making web pages heavily dependent on Javascript and thus 
unusable for some of us is frankly sad and I would not have expected to see 
this happen in a GNU project wiki. 
Please don't break the documentation in this way. 
 
Regards, 
Adrian

Re: Version-adaptive_documentation

2022-12-20 Thread Marcus Müller

Hi Adrian, Hi Barry,

On 20.12.22 17:13, Adrian Musceac wrote:

On Tuesday, 20 December 2022 16:40:46 EET Barry Duggan wrote:

I have created a plan to make certain pages of our Wiki be adaptive to the
user's GNU Radio version (or desired version) so that sections which don't
apply would be hidden. This makes cleaner page presentations and reduces
the clutter of unrelated information.



This proposed change will have the following effects:

- Usability is greatly reduced if using web clients which don't support
Javascript (yes some people still use clients like links and w3m from the
terminal)


Not doing this greatly reduces usability for that vast majority of people that don't use a 
console browser to browse documentation for a GUI tool. I'll claim this tradeoff isn't 
that hard to justify.


Also, I just checked the Message Debug site in links. Perfectly readable. Not quite sure 
what you did to your links!



- On some user setups Javascript is disallowed for security reasons so content
will no longer be accessible


That is not true. I just tried. With JavaScript turned off, you just get everything. I've 
attached a "no Javascript" screenshot.



- Breaks content indexing for some search engines


You claim that based on what? I don't see how that is true.


The general trend of making web pages heavily dependent on Javascript


It's an *optional* script that can be used to select what's visible, if scripting is 
available. If not available, you get a nicely structured plain text site, as before.


 and thus unusable for some of us is frankly sad 


Ok, not my style to be *this* direct, but since you're actively trying to 
guilt-trip Barry:

You're exposed to a website that works perfectly, contrary to your claims, both in 
obsolete browsers and under disabling JavaScript. It's just *better* with. I honestly 
don't think you get to lament your "loss" here.



and I would not have expected to see this happen in a GNU project wiki.


Mediawiki has extensive JavaScript. Since decades.


Please don't break the documentation in this way.


I'll leave this here as an offer for reflection:
https://en.wikipedia.org/wiki/List_of_Dilbert_characters#Mordac

Best regards,
Marcus

smime.p7s
Description: S/MIME Cryptographic Signature