Giter Club home page Giter Club logo

voltaire's Introduction

Voltaire

Voltaire is a web-based indexing tool for GIAC certification examinations. Creating an index with Voltaire is a three phase process involving: documentation/note-taking, sorting & normalization, and word processing. This readme is meant to guide a user through this process. Alternatively, a YouTube walkthrough is avaliable at the link below.

Application URL: https://voltaire.publickey.io

Video: https://youtu.be/bHpkTArlXWc

Provided by @0sm0s1z

alt tag

Indexing Methodology

Create a spreadsheet using the online indexing tool or using a document processor that can export to CSV format.

alt tag

Take notes from the course material. When I feel comfortable with the material I often annotate the location of certain information by filling in a title/page/book and providing a "." under description. This saves me study time while still allowing me to look up specifics related to a topic that I may have missed.

When you click the export button in the upper righthand corner, Voltaire creates an HTML file with the formated content of your index. Press CTRL + A to select all content. Copy and paste the information into a word processor.

Format the document according to your preferences, here are some of mine:

  • I set the document to use two columns
  • I double-sided print and therefore must have an even number of pages for each letter group in order to bind the index properly
  • I adjust formating of the letter headers to fit my preferences ie (Aa, Bb, Cc) -> I typically use the Microsoft Word preformated "Title" option.
  • I like to create a coversheet with the date, and course information

Print the document and take it to OfficeMax/Depot for binding.

alt tag

I typically use a clear front and black backing; however, having a clear cover on each side can be handy if you bind a quick reference to the back of the index ie SANS packet header cheatsheet (what I used on my GSE index) ???

Get Certs

Profit $$$

Common Issues

What follows are troubleshooting proceedures for some of the common issues experienced while using Voltaire.

CSV Import Difficulties

Problem: When attempting to import a CSV the import dialog does not go away and when refreshing the page none of my data is present.

Solution: The CSV import feature, is a bit finicky. Your CSV will need to be formatted just right. In Excel it lets you put commas into your spreadsheet, but CSV uses them as delimiters you most likly have those (or some other odd characters) breaking your CSV. The easiest way to troubleshoot is to import sections (first 20 lines, then first 40, etc) of it until you find out what character is breaking it. Then find and replace that. Rinse and repeat. In the future I'll probably add a feature to let you know that your CSV formatting is off with troubleshooting instructions.

Exporting Problems

Problem: When attempting to export the index it does not properly alphabetize my index.

Solution: There is currently a bug in Voltaire that requires you have at least one result in your index for every letter. (Note, index titles must begin with a capitalized letter). Create references for each with a blank description and your issue should resolve.

voltaire's People

Contributors

0sm0s1z avatar naivros avatar sec460-lab avatar swbloom avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

voltaire's Issues

Lower Case Titles Not Observed

There is a bug in Voltaire where titles starting in lowercase letters are interpreted differently than uppercase characters. This issue has to do with the differing hex codes.

A fix is incoming; however, for now it is recommended that you capitalize the first letter of words in the "Title" column.

ALL MY WORK IS GONE

I attempted to add my existing index (which was 95% complete) using CSV and now the build is empty...PLEASE HELP...I test in a few days and this is awful

all items lost on index after hibernation

Hi!
I prepared an index for Sec560 and after break and pc hibernation all index items were gone, but the index itself obviously persisted...
Is it possible to recover?

best
kasper

Error when trying to open index

I keep getting this error when trying to open my DOC formatted index. If I select PDF, the file does not download at all.

Screenshot 2024-05-07 175316

Can't login using Gmail Authentication

Hello, I'm trying to login and have selected my gmail account, but it doesn't authenticate and allow me access. After I select the Login button, it prompts me to select my Gmail account. I select my account, the page reloads and brings me back to the previous page which shows the Login and Export Button. The button shown in the video, Create New Index does not appear. If I select Login again, it goes back to the page to select a gmail account.

Hope this helps for a resolution.

Thanks.

Resorting and dropping lines

I am having an issue when running xenocrates with my 508 index, the output htm file rearranges the fields moving descriptions from their title and page/book reference. I have attached my index tab delimited file for reference.

508Index1.txt

Import Broken

I attempted to test this out but appears to be broken.

  1. Uploaded CSV index == didn't work
  2. Created simple two line CSV, to test == didn't work
  3. Download the testdata.csv == didn't work

Please provide an updated demo/example CSV and/or instructions that work.

Build Index Orders Items Incorrectly

There is an issue with Voltaire where not all indexed words are under the correct headings. At the moment all letters must be represented as "Title" somewhere.

A fix for this issue is incoming. An interim solution is to create an entry for every letter ie "A,B,C..."

Requirements for local install

I'm running
node --version
v12.16.3
firebase --version
3.16.0
npm --version
6.14.4

trying to do firebase serve but getting:
Error: Server Error. certificate has expired
looking here firebase/firebase-tools#1901
It seems need to update versions because old version are pointing to
https://admin.firebase.com/ that has cert expired on Jan 2020
With latest firebase it should point to *.firebase.google.com where cert is ok.

import csv

I'm having trouble importing csv. When I import a file to create an index the index is empty. I tried an existing file that worked before and new index is blank.

FOR500 Voltaire Index Does not populate when opening

Hello,
I was just working with my FOR500 index within Voltaire yesterday (11/2/2023), but today it will not open. I just get a empty index? A bit distressing; --any possibility on getting this recovered?

Thanks
/Dave

Missing xenocrates-gse.py

xenocrates-gse.py is referenced in the README, but doesn't exist in the repo. Care to include it, for a hopeful GSE-to-be? :)

login infinite loop

whenever i try to login ... i choose an account and then i get redirected to the home page (Not logged in)

Generated Index no Z words

I've noticed that any word starting with a Z does not show up in my generated index. I did have few letters that didn't have entries, so I created blank entries for them hoping that would fix the issue, it didn't.

The import was of a XLSX spreadsheet and I tested with an xls version.
I tried manually adding an entry with a Z in Voltaire but that didn't seem to work either.

Thanks in advance and thanks for the tool.
No Z.docx

Invalid Syntax

Hello, I keep getting an error that the file has invalid systax when I try to run the file xenocrates.py in the Python IDLE. Any help would be greatly appreciated.

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.