From defb7b5ee564c4a86fb082dbbdaf4ee7cc01ce1e Mon Sep 17 00:00:00 2001 From: Jaimos Skriletz Date: Mon, 1 Apr 2024 22:21:53 -0600 Subject: [PATCH] Some clean up. Fix some dead links, and trying to clean up some style choices. --- Wiki/Config/Commands/index.md | 4 ++-- .../Functions/ComplexFunctions/index.md | 9 ++++----- .../FunctionSynchronisation/index.md | 8 ++++---- Wiki/Config/Functions/FunctionTips/index.md | 19 ++++++++++--------- Wiki/Config/Functions/StartFunction/index.md | 8 ++++---- Wiki/Config/Functions/index.html | 6 +++++- 6 files changed, 29 insertions(+), 25 deletions(-) diff --git a/Wiki/Config/Commands/index.md b/Wiki/Config/Commands/index.md index 190bc603..84a2e4e3 100644 --- a/Wiki/Config/Commands/index.md +++ b/Wiki/Config/Commands/index.md @@ -49,7 +49,7 @@ can do: create window [Decor]({{ "/Config/Decor" | prepend: site.wikiurl }}), set window [Styles]({{ "/Config/Style" | prepend: site.wikiurl }}), create [Menus]({{ "/Config/Menus" | prepend: site.wikiurl }}), - create [Colorsets]({{ "/Config/Colorsets" | prepend: site.wikirul }}), + create [Colorsets]({{ "/Config/Colorsets" | prepend: site.wikiurl }}), and configure all aspects of Fvwm. + **Actions:** move and/or resize windows, change virtual pages and desktops, @@ -74,7 +74,7 @@ into a single command. `fvwm-menu-desktop` which creates menus from an XDG deskop menu. + A combination of both functions and scripts can be used, for example - [ThumbnailsAsIcons]({{ "/Tips/ThumbnailsAsIcons" | prepend: site.wikurl }}) + [ThumbnailsAsIcons]({{ "/Tips/ThumbnailsAsIcons" | prepend: site.wikiurl }}) is a function that runs an external script using imagemagick to create an icon from a screenshot of a window. diff --git a/Wiki/Config/Functions/ComplexFunctions/index.md b/Wiki/Config/Functions/ComplexFunctions/index.md index d8410e41..75825ea0 100644 --- a/Wiki/Config/Functions/ComplexFunctions/index.md +++ b/Wiki/Config/Functions/ComplexFunctions/index.md @@ -5,13 +5,12 @@ type: function weight: 1000 description: | This page gives the basics about complex functions. - --- +# ComplexFunctions + * TOC {:toc} -# ComplexFunction - ## Introduction A Complex Function in FVWM is nothing more than a series of commands @@ -219,8 +218,8 @@ AddToFunc FuncSomeFunction You might expect these commands to run one after the other. They do, although there are times when that might not always be the case. FVWM -performs no [/Config/FunctionSynchronisation]( -{{ "/Config/FunctionSynchronisation" | prepend: site.wikiurl }}) +performs no [FunctionSynchronisation]( +{{ "/Config/Functions/FunctionSynchronisation" | prepend: site.wikiurl }}) as to the ordering of the commands -- or rather it makes no guarantees. If a strict set of synchronised commands is needed, it is recommended to use PipeRead -- since FVWM will wait for the PipeRead to return before diff --git a/Wiki/Config/Functions/FunctionSynchronisation/index.md b/Wiki/Config/Functions/FunctionSynchronisation/index.md index 2a45a19d..458df5f6 100644 --- a/Wiki/Config/Functions/FunctionSynchronisation/index.md +++ b/Wiki/Config/Functions/FunctionSynchronisation/index.md @@ -6,19 +6,19 @@ weight: 800 description: | This page describes how to ensure functions finish a command before running the next. - --- +# Function Synchronisation + * TOC {:toc} -# Function Synchronisation - ## Introduction + In the #fvwm IrcChannel I (ThomasAdam) quite often see people asking questions along the lines of "Why are my commands in FuncSomeFunc not loading in the order I list them." The answer to this is relatively straight-forward once one understands what's happening within a -[/Config/ComplexFunctions]({{ "/Config/ComplexFunctions" | prepend: site.wikiurl}}). +[ComplexFunctions]({{ "/Config/Functions/ComplexFunctions" | prepend: site.wikiurl}}). ## Walkthrough Example diff --git a/Wiki/Config/Functions/FunctionTips/index.md b/Wiki/Config/Functions/FunctionTips/index.md index 98572c29..ac45734b 100644 --- a/Wiki/Config/Functions/FunctionTips/index.md +++ b/Wiki/Config/Functions/FunctionTips/index.md @@ -7,19 +7,19 @@ description: | Functions are usually run in the context of the window in which they were run, but not always. Here are some pointers for ensuring commands are run in the correct context. - --- +# Function tips + * TOC {:toc} -# Function tips - ## Introduction -Writing [/Config/ComplexFunctions]({{ "/Config/ComplexFunctions" | prepend: site.wikiurl }}) -is not always that easy. Indeed, one of the biggest problems tends to be the sequencing -of events -- and knowing when it is appropriate to specify any conditional -commands. +Writing [ComplexFunctions]( +{{ "/Config/Functions/ComplexFunctions" | prepend: site.wikiurl }}) +is not always that easy. Indeed, one of the biggest problems tends to be +the sequencing of events -- and knowing when it is appropriate to specify +any conditional commands. It has become more and more apparent to me (ThomasAdam) that people are writing functions to do some very clever things, without really thinking @@ -70,12 +70,13 @@ Welcome to the use of conditional commands. ## Current, ThisWindow, etc. -[/Config/FunctionContext]({{ "/Config/FunctionContext" | prepend: site.wikiurl }}) +[FunctionContext]( +{{ "/Config/Functions/FunctionContext" | prepend: site.wikiurl }}) is everything when it comes to operating on windows. Indeed, ensuring a functions runs within a window context is tricker than many think. In continuing with our example though, we'll soon see that we need be specific. What do we do when need to specify a specific window to be moved, and to ignore all others? -This is where the [/Config/Conditionals]({{ "/Config/Conditionals" | prepend: site.wikiurl }}) +This is where the [Conditionals]({{ "/Config/Conditionals" | prepend: site.wikiurl }}) command ThisWindow comes in useful. ThisWindow is a command more or less guaranteed to place a window within a diff --git a/Wiki/Config/Functions/StartFunction/index.md b/Wiki/Config/Functions/StartFunction/index.md index 8f7d5e39..ec262a9f 100644 --- a/Wiki/Config/Functions/StartFunction/index.md +++ b/Wiki/Config/Functions/StartFunction/index.md @@ -12,7 +12,7 @@ description: | # StartFunction The StartFunction is the function FVWM will run after it has completed -reading [/Config/Fvwm2rc]({{ "/Config/Fvwm2rc" | prepend: site.wikiurl }}). +reading [Fvwm2rc]({{ "/Config/Fvwm2rc" | prepend: site.wikiurl }}). In this function you can preform you basic 'StartUp' actions after FVWM is fully configured. Note that in FVWM 2.4.x this was split up into three functions, 'StartFunction', 'InitFunction' @@ -47,10 +47,10 @@ or being restarted, modules are loaded. Modules must be loaded each time Fvwm restarts because they loose their communication pipe when Fvwm shuts down and restarts. -Due to [/Config/FunctionSynchronisation]( -{{ "/Config/FunctionSynchronisation" |prepend: site.wikiurl }}) +Due to [FunctionSynchronisation]( +{{ "/Config/Functions/FunctionSynchronisation" | prepend: site.wikiurl }}) applications you launch from StartFunction may -not finish loading in the same order. [/Tips/FvwmStartup]( +not finish loading in the same order. [FvwmStartup Tips]( {{ "/Tips/FvwmStartup" | prepend: site.wikiurl }}) gives a more detailed look at this. diff --git a/Wiki/Config/Functions/index.html b/Wiki/Config/Functions/index.html index 748a165e..cf65b982 100644 --- a/Wiki/Config/Functions/index.html +++ b/Wiki/Config/Functions/index.html @@ -14,7 +14,7 @@ StartFunction. --- -

FVWM Functions

+

Fvwm Functions

Functions can be used to achieve lots of different tasks. The basic syntax for a function is:

@@ -34,6 +34,10 @@

FVWM Functions

The following are a list of pages about Functions.

{% assign pages = site.pages | where:"type","function" | sort:"weight" %} +{% capture fvwmtxt %} {% for mypage in pages reversed %} {% include wiki_index_item.html mypage=mypage %} {% endfor %} +{% endcapture %} +{% include fvwmwindow.html id="function-pages" +title="Fvwm Functions" content=fvwmtxt color="green" %}