Contributing to the Financial Modelling Wiki: Difference between revisions

From Financial Modelling Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 35: Line 35:
# Convert the regular HTML <iframe> embed code to the wikitext markup that this wiki uses.
# Convert the regular HTML <iframe> embed code to the wikitext markup that this wiki uses.
#* You should specify the following attributes:
#* You should specify the following attributes:
#** <strong>key</strong> 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 "KEYOFTRUSTEDACCOUNT" evaluates to "<nowiki>https://onedrive.live.com</nowiki>/embed?resid=ACCOUNTIDENTIFIER". The mapping from keys to starts of URLs is specified in an admin area of this wiki when we set up trusted accounts.
#** <strong>key</strong> 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 <code>KEYOFTRUSTEDACCOUNT</code>evaluates to <code><nowiki>https://onedrive.live.com</nowiki>/embed?resid=ACCOUNTIDENTIFIER</code>. The mapping from keys to starts of URLs is specified in an admin area of this wiki when we set up trusted accounts.
#** <strong>path</strong> is the remainder of the path to the workbook.
#** <strong>path</strong> is the remainder of the path to the workbook.
#** <strong>width</strong> 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.
#** <strong>width</strong> 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.
Line 42: Line 42:
#** OneDrive - Personal
#** OneDrive - Personal
#*** Regular HTML &lt;iframe> embed code:
#*** Regular HTML &lt;iframe> embed code:
#***: &lt;iframe '''width="1000" height="187"''' ''frameborder="0" scrolling="no"'' src="'''<nowiki>https://onedrive.live.com</nowiki>/embed?resid=ACCOUNTIDENTIFIER%21FILEIDENTIFIER&authkey=%21ACCESSKEY&em=2&AllowTyping=True&'''
#***: <code>&lt;iframe '''width="1000" height="187"''' ''frameborder="0" scrolling="no"'' src="'''<nowiki>https://onedrive.live.com</nowiki>/embed?resid=ACCOUNTIDENTIFIER%21FILEIDENTIFIER&authkey=%21ACCESSKEY&em=2&AllowTyping=True&'''</code>
#***:'''ActiveCell=<nowiki>'SHEETOFACTIVECELL'</nowiki>!ACTIVECELL&Item=DEFINEDNAMEOFAREATOSHOW&wdHideGridlines=True&'''
#***:'''<code>ActiveCell=<nowiki>'SHEETOFACTIVECELL'</nowiki>!ACTIVECELL&Item=DEFINEDNAMEOFAREATOSHOW&wdHideGridlines=True&</code>'''
#***:'''wdDownloadButton=True&wdInConfigurator=True'''">&lt;/iframe>
#***:<code>'''wdDownloadButton=True&wdInConfigurator=True'''">&lt;/iframe></code>
#*** Wikitext markup that this wiki uses:
#*** Wikitext markup that this wiki uses:
#***: &lt;div style="text-align: center;">&lt;iframe key="'''KEYOFTRUSTEDACCOUNT'''" path="'''FILEIDENTIFIER&authkey=%21ACCESSKEY&em=2&AllowTyping=True&ActiveCell=<nowiki>'SHEETOFACTIVECELL'</nowiki>!ACTIVECELL&'''
#***: <code>&lt;div style="text-align: center;">&lt;iframe key="'''KEYOFTRUSTEDACCOUNT'''" path="'''FILEIDENTIFIER&authkey=%21ACCESSKEY&em=2&AllowTyping=True&ActiveCell=<nowiki>'SHEETOFACTIVECELL'</nowiki>!ACTIVECELL&'''</code>
#***:'''Item=DEFINEDNAMEOFAREATOSHOW&wdHideGridlines=True&wdDownloadButton=True&wdInConfigurator=True'''" '''width="1000" height="187"'''>&lt;/iframe>&lt;/div>
#***:<code>'''Item=DEFINEDNAMEOFAREATOSHOW&wdHideGridlines=True&wdDownloadButton=True&wdInConfigurator=True'''" '''width="1000" height="187"'''>&lt;/iframe>&lt;/div></code>


[To be continued - preferably also show pictures/GIFs/videos/spreadsheets, but at least show videos. Maybe put videos before spreadsheets because they are simpler and demonstrate most of the workflow]
[To be continued - preferably also show pictures/GIFs/videos/spreadsheets, but at least show videos. Maybe put videos before spreadsheets because they are simpler and demonstrate most of the workflow]

Revision as of 02:10, 27 December 2021

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 sources 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

Embedding spreadsheets

This wiki is unusual in the need to embed spreadsheets. We were unaware of a suitable native solution and have implemented a custom approach.

  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 https://onedrive.live.com/embed?resid=ACCOUNTIDENTIFIER. 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="https://onedrive.live.com/embed?resid=ACCOUNTIDENTIFIER%21FILEIDENTIFIER&authkey=%21ACCESSKEY&em=2&AllowTyping=True&
          ActiveCell='SHEETOFACTIVECELL'!ACTIVECELL&Item=DEFINEDNAMEOFAREATOSHOW&wdHideGridlines=True&
          wdDownloadButton=True&wdInConfigurator=True"></iframe>
        • 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>

[To be continued - preferably also show pictures/GIFs/videos/spreadsheets, but at least show videos. Maybe put videos before spreadsheets because they are simpler and demonstrate most of the workflow]