From d13a4f0f94c414684b0688bbd53cdcbb0bcb89d8 Mon Sep 17 00:00:00 2001 From: Wade Mealing Date: Sun, 8 Sep 2024 19:44:54 +1000 Subject: [PATCH] Remove custom css that org-mode inserts. --- custom-software-errors.html | 288 ++++++--------------------------- custom-software-errors.org | 3 +- index.html | 308 ++++++++---------------------------- setupfile.org | 1 + 4 files changed, 116 insertions(+), 484 deletions(-) diff --git a/custom-software-errors.html b/custom-software-errors.html index 0972636..8b226fa 100644 --- a/custom-software-errors.html +++ b/custom-software-errors.html @@ -3,195 +3,11 @@ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> - + Higher quality errors for custom software. - @@ -204,9 +20,9 @@

Higher quality errors for custom software.

-
-

Summary:

-
+
+

Summary:

+

In-house business software is a very different beast; it is usually target-built to solve a very specific problem. Company bean counters encourage buying off-the-shelf software when it is @@ -227,9 +43,9 @@

Summary:

-
-

Introduction

-
+
+

Introduction

+

Effective resolution of errors plays a pivotal role in shaping the user experience within software applications. The content of the messages, along with information, should not only @@ -245,9 +61,9 @@

Introduction

-
-

The basics.

-
+
+

The basics.

+

Rather than re-iterate what has already been said, Google has a very good course, in the technical writing category, which focuses on writing better error messages. It also contains excellent advice for programmers @@ -280,9 +96,9 @@

The basics.

-
-

Improved example.

-
+
+

Improved example.

+

So, let's provide a before and after. This particular example was chosen as a bland and boring example so we wouldn't focus on the error itself. @@ -293,12 +109,12 @@

Improved example.

-
-

Before:

-
-
+

+
Before:

+

+
 |--------------------------------------------------------------|
-| ⚠️ Error:                                                    |
+| ⚠️ Error:                                                     |
 |                                                              |
 | Loan applications can not continue without approval.         |
 |                                                              |
@@ -313,10 +129,10 @@ 
Before:

 

 

 
-

-
After:

-

-
+

+
After:

+

+
 +------------------------------------------------------------------------+
 | ⚠️ Error #90210C                                                        |
 |                                                                        |
@@ -466,9 +282,9 @@ 
After:

 

 

 
-

-
Introducing change

-

+

+
Introducing change

+

 

 Rolling changes like this into an existing code base will likely be complicated; one possible
 solution is incremental improvements.
@@ -481,9 +297,9 @@ 
Introducing change

 

 

 
-

-
Incremental Improvements

-

+

+
Incremental Improvements

+

 

 Incremental improvement of error messages involves advancing beyond basic error handling.  Not
 all error conditions will benefit from the additional information. However, if there is an "error
@@ -493,9 +309,9 @@ 
Incremental Improvements

 

 

 
-

-
Error Categories.

-

+

+
Error Categories.

+

 

 Introducing a common "error category" simplifies the initial rollout of the new error fields. By
 grouping related issues, error categories provide a simplified reference point, facilitating
@@ -510,9 +326,9 @@ 
Error Categories.

 

 

 
-

-
Unique Error Identifier

-

+

+
Unique Error Identifier

+

 

 By assigning distinct identifiers to each error condition, developers establish
 a standardized method for identifying, tracking, and managing errors throughout the
@@ -536,9 +352,9 @@ 
Unique Error Identifier

 

 

 
-

-
Online References (hyperlinks)

-

+

+
Online References (hyperlinks)

+

 

 This is more than just linking to a wiki page; error pages could link to specific URI's of company
 resources such as Slack, shared drives, or source repositories.  If your userbase is sufficiently
@@ -547,9 +363,9 @@ 
Online References (hyperlinks)

 

 

 
-

-
Extending this idea.

-

+

+
Extending this idea.

+

 

 I consider these 4 basics to be the first generation of improvements. You will find new
 and useful improvements; do not be afraid to use them.
@@ -561,9 +377,9 @@ 
Extending this idea.

 

 

 
-

-
Generating documentation from error conditions for support staff.

-

+

+
Generating documentation from error conditions for support staff.

+

 

 Software should generate a list of error codes and their reasons for any of the support
 staff who may be dealing with the area of code.
@@ -579,9 +395,9 @@ 
Generating documentation from error conditions for support s
 

 

 
-

-
Error analysis.

-

+

+
Error analysis.

+

 

 Analysis of the error messages
 

@@ -596,9 +412,9 @@ 
Error analysis.

 

 

 
-

-
Conclusion

-

+

+
Conclusion

+

 

 The suggestions presented in this document serve as fundamental examples of extending common error
 conditions to enhance the user experience and streamline error management. However, it's essential for
@@ -614,9 +430,9 @@ 
Conclusion

 

 

 
-

-
Resources:

-

+

+
Resources:

+

 

 https://www.smashingmagazine.com/2022/08/error-messages-ux-design/
 https://www.linkedin.com/pulse/how-write-good-error-messages-saadia-minhas
diff --git a/custom-software-errors.org b/custom-software-errors.org
index 30368de..a476525 100755
--- a/custom-software-errors.org
+++ b/custom-software-errors.org
@@ -1,4 +1,3 @@
-
 #+TITLE: Higher quality errors for custom software.
 
 #+OPTIONS: ^:nil num:nil toc:nil date:nil author:nil html-postamble:nil
@@ -63,7 +62,7 @@ Kept in ascii art to remove distractions and debate on how poor my CSS theming s
 
 #+BEGIN_EXAMPLE
 |--------------------------------------------------------------|
-| ⚠️ Error:                                                    |
+| ⚠️ Error:                                                     |
 |                                                              |
 | Loan applications can not continue without approval.         |
 |                                                              |
diff --git a/index.html b/index.html
index b32620a..df3d806 100644
--- a/index.html
+++ b/index.html
@@ -3,195 +3,11 @@
 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
 
 
-
+
 
 
 For when I'm gone.
 
-
 
 
 
@@ -206,9 +22,9 @@
 
For when I'm gone.

 
 
-

-
The best error messages ive ever seen

-

+

+
The best error messages ive ever seen

+

 

 Writing clear and effective error messages is a crucial skill for any programmer, no matter what the language.  Well-crafted error messages will
 improve the usability of software by guiding users to understand and resolve issues quickly. A good error message not only informs the user about
@@ -219,9 +35,9 @@ 

-
Apple Mac OS Midi routing is broken.

-

+

+
Apple Mac OS Midi routing is broken.

+

 

 I have some new music making hardware, and wanted to try to get them to talk together.  Use a Mac they
 say 'everything just works',   No clearly it doesnt.  I did however find a work around.  If anyone
@@ -230,9 +46,9 @@ 

-
Minimise

-

+

+
Minimise

+

 

 In the interest of not polluting the internet with my ill-informed opinion and staying
 away from the madness that is modern culture, I've deleted a bunch of social media and
@@ -242,9 +58,9 @@ 
Minimise
 
 
-

-
Downloading the EP133 firmware from Teenage Engineering

-

+

+
Downloading the EP133 firmware from Teenage Engineering

+

 

 Teenage Engineering released the EP-133, a mid range sampler/synth, I looked into the updater
 to find out as much as I can before I buy one.  The firmware provided from teenage engineering
@@ -253,9 +69,9 @@ 
Dow
 

 

 
-

-
Atom(ic) Operations in Common Lisp [2023]

-

+

+
Atom(ic) Operations in Common Lisp [2023]

+

 

 So, the headline is a bit of a lie.  This entry talks about using clojure like "atoms" to simplify
 management of shared, synchronous, independent state.  Common lisp being the all-singing all-dancing
@@ -266,9 +82,9 @@ 

-
Setting up GitHub Actions for LFE CI/CD [2023]

-

+

+
Setting up GitHub Actions for LFE CI/CD [2023]

+

 

 I'm involved in 'competing' with spawnfest this weekend, I figured its time to setup LFE for CI/CD with GitHub Actions.
 Its a pretty simple setup that runs the test, i'll expand on this in the future to include creating containers and
@@ -277,9 +93,9 @@ 

 

 
-

-
Common Lisp and HTMX [2023]

-

+

+
Common Lisp and HTMX [2023]

+

 

 Common lisp and HTMX provide a sane platform to develop basic applications.  I outline the reasons that I have chosen them.
 This post also marks the new voice I plan to use while blogging. I no longer care to engage in debate with people without being paid.
@@ -287,9 +103,9 @@ 
C
 

 

 
-

-
Supercharge your workflow with emacs and org-babel.

-

+

+
Supercharge your workflow with emacs and org-babel.

+

 

 I do kernel flaw analysis for a living, someone asked me to do a short write up on how I use org-babel to
 do my work. I've documented it in this rant.
@@ -297,9 +113,9 @@ 
Supercharge your
 

 

 
-

-
Lisp flavored erlang (gen_server)

-

+

+
Lisp flavored erlang (gen_server)

+

 

 I decided to collapse two of my interests, lisp and erlang.  Lisp flavored erlang isnt going to win
 any popularity contests, but it is something that I dont entirely hate  working on.  Ive written
@@ -308,9 +124,9 @@ 
Lisp flavored erlang (gen_server)

 

 

 
-

-
Choosing the wrong roads.

-

+

+
Choosing the wrong roads.

+

 

 I've spent the last week reflecting on some poor programming life choices that I've made.
 disagree with the majority, perhaps you are wrong.  I'm not stupid enough to think that i'm smarter
@@ -320,9 +136,9 @@ 
Choosing the wrong roads.

 

 

 
-

-
COBOL - Simple "Curses" like screen to get keyboard input.

-

+

+
COBOL - Simple "Curses" like screen to get keyboard input.

+

 

 On of the simple but effectively powerful things that gnuCOBOL can do is a TUI.  Its not
 fancy (when it implements UTF8 correctly, it will be fancy-af) but it gets the job
@@ -335,9 +151,9 @@ 
COBOL - Simple "Curses" like screen to get keyboard input.
 

 
-

-
Python Range function in lisp [Aug 2022]

-

+

+
Python Range function in lisp [Aug 2022]

+

 

 I have wanted a quick way to something similar to the python range function (range n y) in common lisp.
 Sometimes I just want to have some kind of immediate list creation.  See my drivel on this topic.
@@ -345,9 +161,9 @@ 
Python Range function in lisp [Aug 2022]

 

 

 
-

-
Simple WX example in erlang [July 2022]

-

+

+
Simple WX example in erlang [July 2022]

+

 

 I don't always write a gui for my apps, but when I do, I use wx because I'm not one for complaining about pixel perfect pedantry.
 

@@ -358,9 +174,9 @@ 
Simple WX example in erlang [July 2022]

 

 

 
-

-
MIRAI analysis - evasion - deleting the executing code [Nov 2020]

-

+
 
-

-
MIRAI analysis - watchdog access in rust [Nov 2020]

-

+
 
-

-
Userspace eBPF [Sep 2 2020]

-

+

+
Userspace eBPF [Sep 2 2020]

+

 

 A few distros have users allowed to insert eBPF programs.  This is disabled in
 some distributions.  I've documented my findings after talking to different
@@ -390,9 +206,9 @@ 
Userspace eBPF [Sep 2 2020]

 

 

 
-

-
Anatomy of kernel module signing  [Aug 20 2020]

-

+

+
Anatomy of kernel module signing  [Aug 20 2020]

+

 

 I decided to take a look at the Linux kernel modules signing process.  It seems
 that the recent drovorub malware has some interesting misinformation regarding 
@@ -401,9 +217,9 @@ 
Anatomy of kernel module signing  [Aug 20 2020]

 

 

 
-

-
Encrypting a disk to only boot in a specific system. [Aug 9 2020]

-

+

+
Encrypting a disk to only boot in a specific system. [Aug 9 2020]

+

 

 Recent research papers related to flaws in thunderbolt and secureboot have
 piqued my interest in learning more about what can be done to prevent a system
@@ -413,9 +229,9 @@ 
Encrypting a disk to only boot in a specific system. [Aug 9
 

 

 
-

-
Toshiba Toughpad FZ-G1-3 [Jul 25 2020]

-

+

+
Toshiba Toughpad FZ-G1-3 [Jul 25 2020]

+

 

 I have recently purchased one of these machines in an auction, and I am -very-
 impressed with its build quality.   While this one is not its current purchase
@@ -427,9 +243,9 @@ 
Toshiba Toughpad FZ-G1-3 [Jul 25 2020]

 
 
 
-

-
Kernel SecuriTea

-

+

+
Kernel SecuriTea

+

 

 I work on a small youtube channel where I talk about kernel security issues
 that interest me.  I work on quite a lot of these in my work so i'm limited to
@@ -439,7 +255,7 @@ 
Kernel SecuriTea

 

 

 

-
Created: 2024-09-08 Sun 19:36

+
Created: 2024-09-08 Sun 19:43

 

 
 
diff --git a/setupfile.org b/setupfile.org
index 0e8970a..b5dbaf5 100644
--- a/setupfile.org
+++ b/setupfile.org
@@ -2,6 +2,7 @@
 #+OPTIONS: toc:nil
 #+OPTIONS: date:nil
 #+OPTIONS: author:nil date:nil
+#+OPTIONS: html-style:nil
 
 #+HTML_HEAD: 
 #+HTML_HEAD: