Feeds

Jonathan Dowland: Code formatting in documents

Planet Debian - Sat, 2024-10-12 16:43

I've been exploring typesetting and formatting code within text documents such as papers, or my thesis. Up until now, I've been using the listings package without thinking much about it. By default, some sample Haskell code processed by listings looks like this (click any of the images to see larger, non-blurry versions):

It's formatted with a monospaced font, with some keywords highlighted, but not syntactic symbols.

There are several other options for typesetting and formatting code in LaTeX documents. For Haskell in particular, there is the preprocessor lhs2tex, The default output of which looks like this:

A proportional font, but it's taken pains to preserve vertical alignment, which is syntactically significant for Haskell. It looks a little cluttered to me, and I'm not a fan of nearly everything being italic. Again, symbols aren't differentiated, but it has substituted them for more typographically pleasing alternatives: -> has become →, and \ is now λ.

Another option is perhaps the newest, the LaTeX package minted, which leverages the Python Pygments program. Here's the same code again. It defaults to monospace (the choice of font seems a lot clearer to me than the default for listings), no symbolic substitution, and liberal use of colour:

An informal survey of the samples so far showed that the minted output was the most popular.

All of these packages can be configured to varying degrees. Here are some examples of what I've achieved with a bit of tweaking

listings adjusted with colour and some symbols substituted (but sadly not the two together)

lhs2tex adjusted to be less italic, sans-serif and use some colour

All of this has got me wondering whether there are straightforward empirical answers to some of these questions of style.

Firstly, I'm pretty convinced that symbolic substitution is valuable. When writing Haskell, we write ->, \, /= etc. not because it's most legible, but because it's most practical to type those symbols on the most widely available keyboards and popular keyboard layouts.1 Of the three options listed here, symbolic substitution is possible with listings and lhs2tex, but I haven't figured out if minted can do it (which is really the question: can pygments do it?)

I'm unsure about proportional versus monospaced fonts. We typically use monospaced fonts for editing computer code, but that's at least partly for historical reasons. Vertical alignment is often very important in source code, and it can be easily achieved with monospaced text; it's also sometimes important to have individual characters (., etc.) not be de-emphasised by being smaller than any other character.

lhs2tex, at least, addresses vertical alignment whilst using proportional fonts. I guess the importance of identifying individual significant characters is just as true in a code sample within a larger document as it is within plain source code.

From a (brief) scan of research on this topic, it seems that proportional fonts result in marginally quicker reading times for regular prose. It's not clear whether those results carry over into reading computer code in particular, and the margin is slim in any case. The drawbacks of monospaced text mostly apply when the volume of text is large, which is not the case for the short code snippets I am working with.

I still have a few open questions:

  • Is colour useful for formatting code in a PDF document?
    • does this open up a can of accessibility worms?
  • What should be emphasised (or de-emphasised)
  • Why is the minted output most popular: Could the choice of font be key? Aspects of the font other than proportionality (serifs? Size of serifs? etc)
  1. The Haskell package Data.List.Unicode lets the programmer use a range of unicode symbols in place of ASCII approximations, such as ∈ instead of elem, ≠ instead of /=. Sadly, it's not possible to replace the denotation for an anonymous function, \, with λ this way.
Categories: FLOSS Project Planets

KDE Android News (October 2024)

Planet KDE - Sat, 2024-10-12 04:00

Here’s an overview of recent work around Android platform support for KDE Frameworks and KDE applications, most of which is a direct result of discussions and work at Akademy and the Matrix conference.

Notification permission fixes

Porting Itinerary and NeoChat to use the KNotification permission API identified two issues around permission checks and callbacks on permission changes that resulted in the application seeing the wrong permission state. That’s fixed now.

Retirement of the Qt 5 CI

With the 24.08 KDE Gear release all our Android apps are based on Qt 6, including their stable release branches. We have therefore started with retiring the Android Qt 5 CI/CD infrastructure, which should save us both maintenance and computing resources.

As Qt 5 is meanwhile lagging behind several Android SDK versions it’s no longer a viable platform for producing APKs that work on up-to-date devices anymore anyway.

Android CI has meanwhile been removed from the KDE Frameworks 5 maintenance branches as well as from a few other libraries that still used it. The removal of Gitlab CI templates, Craft caches and container images will follow.

In particular this means the invent-registry.kde.org/sysadmin/ci-images/android-qt515 container image is deprecated and will be removed eventually. Please get in touch if you are still using this externally. Poppler’s CI was such a case for example.

QML file installation

The QML module macros in ECM used to install QML files to disk, besides bundling those via the Qt resource system as well. While that is still needed on most platforms due to some specific code in Kirigami, it’s unnecessary on Android where we rely solely on the bundled data.

This resulted in unnecessary content in the APKs, which has been fixed and makes all our APKs a bit smaller now.

Translation lookup order

The probably most visible change is a fix for a long standing bug in KI18n’s multi-language fallback lookup order, which would result in applications showing a wild mix of languages under certain conditions.

This happened when the primary device language was set to English but the country to anything but the US or the UK and one or more secondary languages were also selected. While not strictly limited to Android, there’s two factors that made it particularly prone to happen there:

  • Newer Android versions allow language and country to be set fully independently, while on many other systems only certain predefined combinations are available.
  • The language setting doesn’t just impact application translations but also text input, so many more users have multiple languages configured.

KI18n first looks for a translation for the specific language/country pair and then just the language, before falling back to the next configured language/country pair. If no translation is found it’ll eventually use the English/US source text.

Conceptually this is not wrong, but the implementation missed the fact that there is no “country-less” English translation but only the English/US source text. A configuration of English/Canada and French/Canada therefore previously resulted in a French translation rather than an English one, as it does now.

This has been backported and should be available in all our APKs with 24.08.2 latest.

Runtime language change

Thanks to input from Fabian during Akademy there’s also significant progress on having applications react to system language changes at runtime.

This basically consists of three parts:

  • Propagate the native Android system configuration change to Qt, done in Qt CR 596175.
  • Reset cached values inside KI18n on system language changes, done in KI18n MR 124.
  • Trigger QML binding re-evaluation for i18n() calls on language changes, implemented in KI18n MR 127.

With those three changes applied and a few lines adjusted in the application code to make use of this large parts of the UI already follow system language changes automatically.

It’s far not perfect yet, as there’s more things that need to update in this case than just translated strings. Date/time formatting for example, as discussed in QTBUG-129727. But overall this is already much better than what I had expected and assumed to be feasible with realistic effort.

Dark mode support

As reported previously we have working support for dark mode since 24.08.1, thanks to Julius’ work on icon recoloring.

So far this required minimal changes to applications to enable it though. That has also been fixed, dark mode support is now automatically enabled for all applications using the Breeze style.

Outlook

There’s still more to do regarding Android platform integration. I’d say the two probably most pressing issues are the following:

  • On some devices the font size is unusably small, caused by the display scale factor being wrong. Based on some investigation during Akademy the current working theory is that this is a race condition in Qt’s code reading that information. I have no device/setup that reproduces this problem unfortunately.
  • Selecting files in the platform file dialog that are located on a cloud storage such as Nextcloud silently fails. That is, to the application selecting such a file looks as if the user had canceled the dialog. Here we know exactly why this happens (it’s explicit code in Qt doing this, for valid reasons), the challenge is rather to find a proper solution.

If you are interested in Android integration for KDE applications, feel free to join us in the #kde-android Matrix channel!

Categories: FLOSS Project Planets

Peoples Blog: Create a custom Drupal Service and Use as a Helper

Planet Drupal - Sat, 2024-10-12 03:14
Creating a custom Drupal service allows you to encapsulate functionality and access it wherever needed, promoting modularity and reusability within your codebase as a Helper. In this article we are sharing an example of how to create a custom Drupal service and use it as a helper. Step 1: Define the Service Create a new custom module or use an existing one. Define your service in the module&rsq
Categories: FLOSS Project Planets

Peoples Blog: Imagefield Slideshow module to render Slideshow on Drupal website

Planet Drupal - Sat, 2024-10-12 03:14
If you want to show images as a slideshow on your drupal website and want to do it quickly. Here’s the module which solves your purpose. Imagefield Slideshow is the simple module which will allow images to render as a slideshow on the drupal website at the field level. This module will provide a Slideshow formatter for Image fields, so that multiple images are uploaded to that particular im
Categories: FLOSS Project Planets

Peoples Blog: Unable to install Update Manager, update.settings already exists in active configuration

Planet Drupal - Sat, 2024-10-12 03:14
Generally you see this error while you try to install the update manager module via UI or via Drush command. Not really sure how you came up with this issue. But if you are seeing this issue, you have an entry in your site's configuration saying that the update module is already installed. 1. You can simply delete this configuration with the below command $ drush cdel update.settings Which
Categories: FLOSS Project Planets

Peoples Blog: How to run PHPUnit test cases on your local machine for Drupal

Planet Drupal - Sat, 2024-10-12 03:14
Running PHPUnit tests helps ensure that your Drupal module behaves as expected and provides a reliable way to identify and fix issues during development. To run PHPUnit test cases on your local machine for Drupal, follow these steps: Install PHPUnit and its dependency: Make sure you have PHP and Composer installed on your local machine. If you don't have PHPUnit installed, you can install
Categories: FLOSS Project Planets

Peoples Blog: API Docs, Drupal contributed module for your Developer Portal

Planet Drupal - Sat, 2024-10-12 03:14
This module will provide API Docs to your Developer Portal, It is powered by Drupal content type, custom field formatters & views. Here's a step-by-step guide to help you to download, enable, configure and use the module for your developer portal. Download & Enable the Module: Visit the Drupal.org website and navigate to the API Docs module's page that you want to download, her
Categories: FLOSS Project Planets

Peoples Blog: How to improve drupal website performance

Planet Drupal - Sat, 2024-10-12 03:14
Improving the performance of a Drupal website involves optimizing various aspects of its configuration and content. There are several ways to overall complex performance related problems and improve Drupal website performance to load it quicker. Here are some tips to enhance the performance of your Drupal website: Enable Caching: Enable Drupal's built-in caching mechanisms to store pre-gen
Categories: FLOSS Project Planets

Peoples Blog: How to build the engaging digital experience via Drupal

Planet Drupal - Sat, 2024-10-12 03:14
Building an engaging digital experience using Drupal involves combining effective design, user-friendly features, and content that resonates with your audience. Here are some tips to help you create an engaging digital experience using Drupal: Define Your Target Audience: Understand your target audience and their needs, preferences, and goals. Tailor your digital experience to meet their expecta
Categories: FLOSS Project Planets

Peoples Blog: Why is Drupal the Best Choice for Non-Profit Websites?

Planet Drupal - Sat, 2024-10-12 03:14
Drupal is often considered a great choice for non-profit websites due to several key factors that align with the unique needs and goals of non-profit organizations. Here are some reasons why Drupal is a popular choice for non-profit websites: Cost-Effectiveness: Drupal is an open-source platform, which means it is free to use and distribute. This can be particularly advantageous for non-profit o
Categories: FLOSS Project Planets

Peoples Blog: Security Checklist for Drupal Application

Planet Drupal - Sat, 2024-10-12 03:14
Securing your Drupal website is crucial to protect your data, users, and overall website integrity. Here's a security checklist for a Drupal website: Keep Drupal Core and Modules Up to Date: Regularly update Drupal core and contributed modules to ensure you have the latest security patches. Enable update notifications to stay informed about available updates. Use Strong and Unique Passwords:
Categories: FLOSS Project Planets

Peoples Blog: Why is Drupal Chosen by Large Organizations?

Planet Drupal - Sat, 2024-10-12 03:14
Drupal is often chosen by large organizations for several reasons. Here are some key factors that make Drupal a popular choice: Scalability: Drupal is highly scalable, allowing organizations to handle large amounts of content, traffic, and user interactions. Its flexible architecture and robust performance capabilities enable it to accommodate the complex needs of large-scale websites and applic
Categories: FLOSS Project Planets

Peoples Blog: Drupal LMS Features for Your Education Business

Planet Drupal - Sat, 2024-10-12 03:14
If you're running an education business and considering Drupal as the platform for your Learning Management System (LMS), there are several features and capabilities you should look for to ensure a robust and effective solution. Here are some key Drupal LMS features to consider: Course Management: A Drupal LMS should provide comprehensive course management capabilities. This includes the ab
Categories: FLOSS Project Planets

Peoples Blog: Leveraging Content Grouping for Personalized Digital Experiences

Planet Drupal - Sat, 2024-10-12 03:14
Content grouping is a powerful technique that can be leveraged to create personalized digital experiences for users. By grouping content based on specific criteria, such as user preferences, demographics, or behavior, you can deliver targeted and relevant content to individual users. Here are some ways to utilize content grouping for personalized digital experiences: User Segmentation: Segment y
Categories: FLOSS Project Planets

Peoples Blog: What to know before you choose a Drupal Hosting Platform?

Planet Drupal - Sat, 2024-10-12 03:14
In this article we are gonna see a few important notes which will be helpful for people who are looking out to host their Drupal application. When selecting a hosting platform for your Drupal website, there are several key factors to consider. Here are some important things to know before making a decision: Compatibility with Drupal: Ensure that the hosting platform is compatible with Drupal&#3
Categories: FLOSS Project Planets

Peoples Blog: node_get_recent() is deprecated in Drupal 10.1.x

Planet Drupal - Sat, 2024-10-12 03:14
node_get_recent() is unused in core and is now deprecated, developers can use views or EntityQuery to get the nodes which are recently modified or added. Earlier drupal developers used to use the function node_get_recent() to get the recently changed nodes like seen in below example $latest_updated_nodes = node_get_recent(10); Now from Drupal 10.1.x onwards, developers need to use entity q
Categories: FLOSS Project Planets

Peoples Blog: Fix Colima connection refused error: failed to get Info from .lima/colima/ha.sock on Mac

Planet Drupal - Sat, 2024-10-12 03:14
This article is about fixing only a single error which you see with Colima on Mac machines. This might be a simple & specific issue, but people who are facing this issue will really feel grateful with the solution provided. While you are running Colima on your mac machines, generally you get into such issue, when you power off or shut down your mac, without stopping the colima service (and de
Categories: FLOSS Project Planets

Peoples Blog: Multisite Local environment setup with DDEV and Drupal

Planet Drupal - Sat, 2024-10-12 03:14
In this article we are going to see how we can set up a multisite environment with ddev on the local machine. Assuming people are aware of configuring the drupal multiple site from the drupal side of configurations. As we all know ddev is an open source tool for running local PHP development environments in minutes, which makes developer life easier during the local environment setup process, her
Categories: FLOSS Project Planets

Peoples Blog: Secure your Web Application's Reset Password flow

Planet Drupal - Sat, 2024-10-12 03:14
Generally any application framework provides users to have a flow to reset the passwords by default, It is more like, use clicking on the Reset Password link and redirects to a page where he will asked for email, and reset link sent to users email, so that user can reset the password on their own. This is a default or general flow that any application framework provides, but developers or archite
Categories: FLOSS Project Planets

Peoples Blog: Colima, similar tool like Docker Desktop, for Drupal Development

Planet Drupal - Sat, 2024-10-12 03:14
Colima is a project that is easy to use and fully open source, and it helps in running docker containers on Linux OS and MacOs machines. We know Docker Desktop is no more a complete open source, if you are not using it personally. So now Colima is a tool which does work similar to Docker Desktop and In this article we are going to see how it works alone or along with Docker Desktop on your Linux
Categories: FLOSS Project Planets

Pages