# maxicard

**Repository Path**: mirrors_chromium_gitlab_gnome/maxicard

## Basic Information

- **Project Name**: maxicard
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: GPL-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2021-08-09
- **Last Updated**: 2025-10-24

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

 -----------
| MAXI CARD |
 ----------


INTRODUCTION
------------

Maxi Card let you browse a kind of knowledge database composed of
LaTeX files. You have to provide your own data of course:)

It was first written to order math. exercices I gave to my students.
The first version was written with the mode forms of Emacs.  The
Python version can compile on the fly a preview of a LaTeX card and
display it in a GnomePixmap.



FEATURES LIST
-------------

1. Browsing the cards

   a. From the tree at the left

   b. With the next and previous buttons

   c. Query a reasearch then browse in the resulting list


2. Adding data

   a. a card

   b. a category

      From the tree at the left, right clicking over a directory gives
      the possibility to add a category (directory)

      When adding a new card and then the categories in its ID don't
      exist yet, then create all the intermediate categories. This
      should come with a confirmation from the user.


On the card view, we display the field of the selected card plus some
buttons: 

	 Next :		to go to the next one in the database

	 Previous :	to go to the previous one in the database

	 Toggle 1 :	to keep the card in a list

	 Ok :		: button for general use



DATABASE FORMAT
---------------

Each record is a line which fields are separated by tab (\t).
                                                    --------

EMPLACEMENT:NIVEAU1:DIFFICULT1:NIVEAU2:DIFFICULT2:NIVEAU3:DIFFICULT3:MOTS-CLS:COMMENTAIRE:HEADER:SOUMISSIONNAIRE:MAIL

The card are localized individually in a folder with eventually a
sub-folder correction.

A card is constituted of one LaTeX file named card.tex and possibly
several .tex, .eps file plus a bitmap preview can be present. The
LaTex card are not directly compilable. Instead they need to be
included (or concatenate) in a master document. The field HEADER
contains the necessary LaTeX code to include at the beginning of a
master document to get compiled the card. The eventual sub-folder
correction contains the same kind of data.

------BEGINNING OF LAZY------------- 

NOTE: in fact there is not fixed value for the field, it depends on
what kind of card you want to order.


Les comptences sont codifies en utilisant l'arborescence du systme
de fichier. La comptence et les surcomptences mises en jeu sont donc
dductibles  partir du champs EMPLACEMENT. Le champs MOTS-CLS permet
ventuellement d'affiner le classement de la carte

Les champs NIVEAU?, DIFFICULT? reprsentent des paires de niveau
scolaire et d'un difficult associes. Les valeurs possibles sont :

pour NIVEAU :
Sixime, Cinquime, Quatrime, Troisime, Seconde, PremireX, TerminaleX
X est un modificateur pour prciser la filire.

pour DIFFICULT :
Facile, Moyen, Difficile

Le champs COMMENTAIRES permet d'insrer des commentaires sur
la carte.


SOUMISSIONNAIRE et MAIL contiennent les informations sur le
soumissionnaire de la carte


------END OF LAZY-------------

INTERNAL CODE
-------------

1. Database implementation

   A class DBCard

   Methods:

      . __init__ Get the database location, may use URL

      . searchCard Return a list ID card (just a path)

      . insertCard Insert a card and return a boolean

      . delCard Delete a card from the database

      . nextCard Return next card in the database

      . previousCard Return previous card in the database


2. Card implementation

   A class card

      . updateView Eventually update the view then return the path
      name to the view


3. Virtual GUI implementation

   a. The class cardUI

   Pure virtual class.

   Methods:

	. changeMode Change the mode (browsing, browsingSelect,
	findMode, insertMode)

	. pushCard Push a card in the UI

	. fetchCard Fetch the card currently in the UI

	. nextCard Push next card of the database in the UI

	. previousCard Push previous card of the database in the UI

	. keepCard Keep/Unkeep visited card in the selectedCard list

	. delCard Delete the card currently in the UI

	. insertCard Insert in the database the card currently in the UI

	. newCard Prepare the UI for a new card

	. searchCard Prepare the UI to search a card

	. buildTree Build the UI tree from the database

	. delTree Delete the UI tree

   b. Class cardModeUI
       
       Specify the behavior of the UI - button, category tree -
	according to the current mode.

        . __init__ Connect the handlers, hide/show widget...

	. __del__ Disconnect the handlers

	. nextPressed Action of the Next button

	. previousPressed Action of the Previous button

	. OkPressed Action of the Ok button

	. keepItPressed

   i. Subclass browseModeUI of cardModeUI

   ii. Subclass browseFindModeUI of cardModeUI

   iii.	Subclass browseSelectedModeUI of cardModeUI

   iv. Subclass insertModeUI of cardModeUI

   v. Subclass editModeUI of cardModeUI

   c. Class findCardUI

4. Gnome implementation

   Subclasses of the various *ModeUI

   a. Subclass cardGnome if cardUI

   b. Subclass browseModeGnome of browseModeUI

   c. Subclass browseFindModeGnome of browseFindModeUI

   d. Subclass browseSelectedModeGnome of browseSelectedModeUI

   e. Subclass insertModeGnome of insertModeUI

   f. Subclass editModeGnome of editModeUI

   g. Subclass findCardGnome of findCardUI