Contributing to the Financial Modelling Wiki

From Financial Modelling Wiki
Revision as of 00:14, 3 January 2022 by Levi (talk | contribs)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

Why contribute

Contribute to share information that is useful for people that work with or use financial models. Do not contribute to promote something - though you can contribute in your own name or the name of a business that you represent, and you can mention that in your user page.

How to contribute

In general

The specifics of contributing to this wiki are mostly like contributing to Wikipedia. This page outlines how to perform some common actions.

Creating an account, logging in and logging out

You do not need to create an account to contribute to this wiki, but you are welcome to.

To perform these actions, click either "Create account", "Log in" or "Log out" as appropriate (each of these is near the top right) and follow the prompts.

Editing an existing page

Open the page in your browser, then click either "Edit" or "Edit source" (each of these are near the top right).

  • Edit opens a visual editor. Most people will find this simplest for editing text (including headings, bold / italic / code blocks etc, lists and tables. You cannot embed or change images, GIFs, videos or spreasheets this way.
  • Edit source opens a source editor. The markup language is called wikitext. It is similar to HTML. People who are familiar with using any markup language or code will probably find it simple to edit the source, and copy/adapt new elements from other pages. You can embed and changes images, GIFs, videos and spreadsheets this way - refer to the section below on specifics for the Financial Modelling Wiki.

Creating a new page

Enter the title into the search box (near the top right corner), click the red link that appears, and follow the prompts.

Specifics for the Financial Modelling Wiki

This wiki is unusual in the need to embed spreadsheets. We were unaware of a suitable native solution and have implemented a custom approach, and that same approach is used for embedding videos, pictures and GIFs. Videos are explained first because they are simplest.

Embedding spreadsheets

  1. File type Save the spreadsheet as an Excel .XLSX workbook. The XLSX requirement is a security measure - no macros, please (although it is fine to include code within wiki pages).
  2. Upload the workbook to a publicly viewable location of a cloud service on an account that we trust.
    • Tweet us if you are not already aware of anyone you know that has a trusted account.
  3. Find the regular HTML <iframe> embed code for the workbook.
    • If the trusted account is a OneDrive - Personal account, this page describes a way of finding the regular HTML <iframe> embed code.
    • Test whether the regular HTML <iframe> embed code works. One way to do this is to create an HTML file (which can be done in most simple text editors, like Windows Notepad) and opening in your browser. Test whether the workbook is publicly available by opening in an InPrivate/Incognito window.
  4. Convert the regular HTML <iframe> embed code to the wikitext markup that this wiki uses.
    • You should specify the following attributes:
      • key is the identifier for the account that is trusted by this wiki. Note that the key evaluates to the start of the URL - in the first example below the key KEYOFTRUSTEDACCOUNTevaluates to The mapping from keys to starts of URLs is specified in an admin area of this wiki when we set up trusted accounts.
      • path is the remainder of the path to the workbook.
      • width is the width (in pixels) of the embedded workbook as it will be displayed in this wiki. We prefer for this to be 1000 or less so that the embedded workbook renders reasonably on low-resolution monitors.
      • height is the height (in pixels).
    • In the following examples, the bold parts get copied across from the regular HTML <iframe> embed code to the wikitext markup, the italics parts are lost, and the rest is supporting.
      • OneDrive - Personal
        • Regular HTML <iframe> embed code:
          <iframe width="1000" height="187" frameborder="0" scrolling="no" src="
        • Wikitext markup that this wiki uses:
          <div style="text-align: center;"><iframe key="KEYOFTRUSTEDACCOUNT" path="FILEIDENTIFIER&authkey=%21ACCESSKEY&em=2&AllowTyping=True&ActiveCell='SHEETOFACTIVECELL'!ACTIVECELL&
          Item=DEFINEDNAMEOFAREATOSHOW&wdHideGridlines=True&wdDownloadButton=True&wdInConfigurator=True" width="1000" height="187"></iframe></div>
  5. Apply the wikitext markup to the relevant page of this wiki. Use edit source for this.

Embedding videos

Embedding videos is simpler than embedding spreadsheets.

  1. Upload the video to YouTube. We can enable other video sharing platforms if requirements arise - tweet us if you have a need.
  2. Ensure that the video settings allow embedding on other websites. The standard default is is for embedding to be allowed, so if you are not sure then move on and just keep it in mind in case you have trouble later. If you need to change the setting then search how to do so at the time - the YouTube user interface changes over time and differs between devices/apps etc.
  3. Find the unique part of the URL for your video. For example, if the address bar of the video shows, then the unique part of the URL is qqU2xllewk4. You can usually find a clean version of the URL by clicking "share".
  4. Determine the wikitext markup to embed the video in this wiki.
    • It goes like this:
      <div style="text-align: center;"><iframe key="YouTube" path="UNIQUEPARTOFTHEURLFORYOURVIDEO" width="960" height="540"></iframe></div>
    • Continuing the example, if the unique part of the URL for your video is qqU2xllewk4, then the wikitext markup is:
      <div style="text-align: center;"><iframe key="YouTube" path="qqU2xllewk4" width="960" height="540"></iframe></div>
  5. Apply the wikitext markup to the relevant page of this wiki. Use edit source for this.

Embedding pictures and GIFs

We expect that pictures and GIFs can be embedded in basically the same way as spreadsheets, but we have not yet had a need to test it. Tweet us if you have a need and trying to adapt the steps for spreadsheets does not work for you.