Skip to content

Commit

Permalink
Some clean up. Fix some dead links, and trying to clean up some style…
Browse files Browse the repository at this point in the history
… choices.
  • Loading branch information
somiaj committed Apr 2, 2024
1 parent 0083a01 commit defb7b5
Show file tree
Hide file tree
Showing 6 changed files with 29 additions and 25 deletions.
4 changes: 2 additions & 2 deletions Wiki/Config/Commands/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand All @@ -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.

Expand Down
9 changes: 4 additions & 5 deletions Wiki/Config/Functions/ComplexFunctions/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down
8 changes: 4 additions & 4 deletions Wiki/Config/Functions/FunctionSynchronisation/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
19 changes: 10 additions & 9 deletions Wiki/Config/Functions/FunctionTips/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down
8 changes: 4 additions & 4 deletions Wiki/Config/Functions/StartFunction/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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'
Expand Down Expand Up @@ -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.

Expand Down
6 changes: 5 additions & 1 deletion Wiki/Config/Functions/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
<a href="/Wiki/Config/Functions/StartFunction">StartFunction</a>.

---
<h1>FVWM Functions</h1>
<h1>Fvwm Functions</h1>

<p>Functions can be used to achieve lots of different tasks. The
basic syntax for a function is:</p>
Expand All @@ -34,6 +34,10 @@ <h1>FVWM Functions</h1>
<p>The following are a list of pages about Functions.</p>

{% 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" %}

0 comments on commit defb7b5

Please sign in to comment.