Git Product home page Git Product logo

symbollist-maintain-excel's Introduction

Symbollist-maintain-Excel

An Excel based solution for maintaining units, symbols and equations for a LaTeX document.

Download .zip file containing all files: http://bit.ly/ExcelSymbolMaintain11

Working example on OverLeaf.com: http://bit.ly/OverleafExampleSymbollist

Introduction

Thesis documents often contain a lot of mathematical equations. Therefore, in most cases, a symbol list is added to the document and underneath equations, parameter definitions are added. This projects contains a LaTeX solution for creating a symbol list using the glossaries package, together with the glossaries-extra package. Next to this, code is provided for showing parameter definitions under a first declaration of the equation in the document.

The goal of this project is defining symbol definitions and units only once and create symbol list and parameter definitions automatically based on this. To help with this, an Excel file (SymbolSheetSecure.xlsx) is created.

enter image description here

Bugs or suggestions?
Please reach out to me at johanf85git[at]outlook.com

Instructions

  • Download the project and take notice on how the .tex files are built up. For a working example, you can also look at: https://www.overleaf.com/read/svtcgxdkqsxr
  • Open the symboldefinitions.xlsm file
    Example data is included
  • Define units that are used on the Units tab, see the siunitx package manual for syntax
    under '\DeclareSIUnit' add your unitname including '\'
    under 'definition' add the content of your unit
  • Add the symbols to use in your document to the 'Symbols' tab
    Under Symbol: add the symbol (this for your own reference)
    fill the other yellow cells in the row. I started the definition commandname with a D, this is not mandatory. Same for the E of Equation parameter. Do make sure to add a '\' before the commandname.
  • Copy the macros to your LaTeX document preamble. See the "To copy to preamble" tab.
  • Add your equations under the 'Equations' tab
    Make sure you wrap every symbol code in extra parenthesis, eg eg {\rho_\ell}. This is necessary for Excel to recognize the symbols properly for generating the right parameter definitions. This does add extra parenthisis, however there is no other option if you want to use Excel for generating the parameter definitions.
  • Double check the the output in your LaTeX document for possible mistakes

Change order of parameter definitions
Currently parameter definitions are generated based on the order on the 'Symbols' tab in Excel. You can order the symbols within Excel with Excel's sort function to alphabetical (based on the latin name, the B column).

Compile the glossaries:
There are several ways to compile the glossaries. Execute a perl script is one of them. (perl has to be installed)
Run the following command in the folder where your tex file with glossaries is saved:
perl <path to makeglossaries> <main file>

Eg, on a mac, running texlive 2017, the command is:
perl /usr/local/texlive/2017/texmf-dist/scripts/glossaries/makeglossaries main
run this in the directory were your main.tex file is saved

Changing the Excel file
The Excel tabs are secured, so no unwanted changes can be done by accident. The input cells are available for editing. To make other changes to the Excel, first unsecure the tabs.

To do list for git project:

  • Excel copies content of code with too many spaces and with quotesigns, try to find a solution
  • Change tex code to put the Symbols list in alphabetical order in Latin/Greek combined

symbollist-maintain-excel's People

Contributors

johanf85 avatar

Stargazers

 avatar

Forkers

svena098072

symbollist-maintain-excel's Issues

Delete an equation without modifying the excel sheet too much

Thank you for starting such an amazing project for the latex community. I like your project very much, so I would like to give some feedback in order to better this project.

I found it's really difficult to delete an equation. After I delete the equation in the latex file, I not only need to find that equation in the excel sheet, but find the variables only used in that particular equation. I really wish there is a simpler way to do this. Perhaps let the glossary page print out the symbols used in the latex file without us deleting the symbols in the excel sheet.

Thank you again for creating this project.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.