ALR How to help out

From CockosWiki

This is a guide for editing and helping out with the Action List Reference (ALR).

Please follow the bellow instructions:

Do not change any of the current links

The current links in the ALR are connected with Reaper in an automatic way. So don't change them, or things will get messed up.

Document actions that are not yet documented

Similar actions should be described together on an existing page or a new page (How to make a new page). Click on the red links in the ALR, and make redirects (See: How to make redirects) to your page/section with the description.

Formatting conventions

These are conventions you should use when editing the wiki with information about a particular action or set of actions.

• If it's an action that's one-off, that's not belonging to any particular group or anything (for example, Track: Set... actions actions are in a group because they all have the same name in the beginning, but action Misc: Pass through key to main window is a one-off), make a single page just for that action

• In case of a naming pattern on a larger number of actions (or if you notice a similarity in what those actions do, for example Edit: Select/Unselect... actions), make one page which will describe them all as a batch.

• Here's a formatting example of a group of actions with a similar name pattern:

=="Adjust" family of actions==
'''Section:''' Main <br>

Actions of this group adjust track control and track send parameters by using assignable MIDI CC numbers.
MIDI learning via Actions list in Reaper 3 is explained [[How to use MIDI Learn | here.]]


===Adjust last touched FX parameter (Cmd ID 973)===
This action sets the value of the last automatable plugin parameter you have moved or clicked on with the
mouse.
 
===Adjust solo in front dim (Cmd ID 987)===

Sets the value of solo in front dim in dB, either using MIDI CCs or the mousewheel.
Solo in front dim value can also be set up in '''Properties -> Audio -> Solo in front dimming: [  ] dB'''


...



 
[[Action_List_Reference | << Back to Action list reference]]

Use second heading level for action group title by using == Wiki tag. Always name it "<name pattern>" family of actions"!
Put section(s) to which the action belongs in the row right after title. Bold the "Section(s):" part.
< Empty line >
Description of this group of actions, why they are grouped, etc.

< TWO empty lines! >

Use third heading level for action title by using === Wiki tag. Add Cmd ID in parentheses as well!
< If an action of this group is present in one section but not the other, list the sections again. >
< If all actions are belonging to same sections, don't list the sections and just put the action
description here. >


< Continue the list in the same manner. Remember, always put TWO empty lines
between the last line of action description and new action title! >


< Last line of last action description >
< FOUR empty lines!!! >



< This link bringing you back to Action list reference >

If anything isn't clear, just click on "Edit" at the top and see how already existing action description pages were made. Do the exactly same thing as you see in the edit page. If you make a mistake, someone is bound to notice it, and will correct it for you, so no worries.

Crosslinking

Please help crosslinking here on the wiki. Link to pages with further explanation or another approach to the subject.

Add new actions to the list

You MUST follow Jeffos' suggestions on naming the links, because this is IMPORTANT for connecting this list with Reaper, if your DAW is connected online. This means that, if you provide correct link structure, pressing Online help button in Reaper will lead directly to the page with the description of the action! Link has to be formatted like this:

[[ALR_<section>_<ID>|<full action name>]]

• <section> can be (CASE SENSITIVE!):
  • MainSection
  • MediaExplorer
  • MIDIEditor
  • MIDIEvtList
  • MIDIInline
• <ID> can be (CASE SENSITIVE!) either:
  • Command ID (Cmd ID) of the action you want to link to (be EXTREMELY careful when inputting this, double-check if it's the correct number!) or
  • Custom ID of the extension action you want to link to.
• <full action name> should be rather self-explanatory.
• Help merging and structuring descriptions.
• Help cross-referencing (pages, actions and action access).
• Check if action names have been changed (It should be exactly what is written in the action-dialog). If they have been changed, just edit the part of the link that's marked <full action name> above.
• Mark action descriptions with its accurate name and Command ID (or Custom ID for extensions)

Other

Structuring content

Please help structuring the content here on the wiki so it's easy to find for unexperienced users. Action descriptions should in most cases be accessible from at least two paths:

• Action list reference: The action-description should be linked to the above list
• The ordinary path like: REAPER Documentation > Menus > Edit_Menu_Bar

Merging content

Merging is done by cutting the selected section on one page and pasting it on the other. If that leaves the first page blank, it should be set as a redirect to the second page (See: Redirect). It's sometimes it's necessary to change the heading level for the merged parts (See: Section headings).