diff --git a/ChangeLog.md b/ChangeLog.md --- a/ChangeLog.md +++ b/ChangeLog.md @@ -31,4 +31,7 @@ * First version revised F. Changed dependency bounds so that it can now be compiled for GHC 8.8.1. +## 0.1.6.0 -- 2020-01-31 + +* First version revised G. Changed README to README.markdown diff --git a/LICENSE b/LICENSE --- a/LICENSE +++ b/LICENSE @@ -1,4 +1,4 @@ -Copyright (c) 2019 OleksandrZhabenko +Copyright (c) 2019-2020 OleksandrZhabenko Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the diff --git a/Main.hs b/Main.hs --- a/Main.hs +++ b/Main.hs @@ -1,10 +1,10 @@ {-| Module : Main Description : The "glue" between electronic tables and GraphViz -Copyright : (c) OleksandrZhabenko, 2017-2019 +Copyright : (c) OleksandrZhabenko, 2017-2020 License : MIT Maintainer : olexandr543@yahoo.com -Stability : experimental +Stability : Experimental The program @mmsyn4@ converts a specially formated @.csv@ file with a colon as a field separator obtained from the electronic teble into a visualized by GraphViz graph in the @.svg@ format. The proper GraphViz installation is required. diff --git a/README b/README deleted file mode 100644 --- a/README +++ /dev/null @@ -1,51 +0,0 @@ - Usage - -1. After installation the executable mmsyn4 is created. - Afterwards, it is used to process files. So, open an - office spreadsheet program, e. g. LibreOffice Calc. -2. Begin to enter the text in the cells. You can use - Unicode characters. No quotation marks should be used, - instead use some special delimiter except '@' sign. -3. Do not use colons, instead when needed switch to the - nearest cell to the right. -4. To make a text visually highlighted (yellowish), start - the cell with an ’@’ sign. -5. Lines in the table create different chains in the - resulting graph. To produce an arrow to the text in the - cell, enter it in the next cell in the row to the right. -6. To make several arrows from the cell, switch to the - next cell to the right for this parent one (the cell that - will be a parent for several other cells), enter needed - new texts there and in the located below cells. -7. Usually, you can search the needed text with Ctrl+F if - needed. -8. Empty lines in the table do not influence the resulting - visualization. Above each line, except the first one, - there must be at least one filled cell. It must be - located above the text on the new line or even further - to the right above. Otherwise, the program will - produce no reasonably useful output. -9. After entering all the text, export the sheet as an - 1.csv file using colons (':') as separator in the working - directory. Otherwise, the program won’t work. -10. Run the appropriate executable mmsyn4 in the terminal - or from the command line while being in the directory - with the 1.csv file. Enter a word name of the .csv file - to be saved. DO use alphanumeric symbols and dashes if - needed. Then specify the needed splines and visualization - schemes by specifying the appropriate characters in the - terminal. You will specify additionally whether you - would like to remove '@' sign from the resulting .gv - file and from the vizualization itself. Please, note - that if entered 'y' the program automatically - removes all the '@' from the .gv and visualization. - For more information, see the GraphViz - documentation. -11. Your first visualization is then created. -12. Save the spreadsheet document as a spreadsheet file. -13. Repeat the steps from 2 to 12 as needed to produce - more visualizations. -14. Afterwards, you have a list of svg files, a list of .gv - files as source files for Graphviz, and a list of csv - files, and a saved spreadsheet file. Then you can use - the produced visualizations for some other documents. diff --git a/README.markdown b/README.markdown new file mode 100644 --- /dev/null +++ b/README.markdown @@ -0,0 +1,66 @@ + ***** Usage ***** + ----------------- + +1. After installation the executable mmsyn4 is created. + Afterwards, it is used to process files. So, open an + office spreadsheet program, e. g. + [LibreOffice Calc](https://libreoffice.org). + +2. Begin to enter the text in the cells. You can use + Unicode characters. No quotation marks should be used, + instead use some special delimiter except '@' sign. + +3. Do not use colons, instead when needed switch to the + nearest cell to the right. + +4. To make a text visually highlighted (yellowish), start + the cell with an ’@’ sign. + +5. Lines in the table create different chains in the + resulting graph. To produce an arrow to the text in the + cell, enter it in the next cell in the row to the right. + +6. To make several arrows from the cell, switch to the + next cell to the right for this parent one (the cell that + will be a parent for several other cells), enter needed + new texts there and in the located below cells. + +7. Usually, you can search the needed text with Ctrl+F if + needed. + +8. Empty lines in the table do not influence the resulting + visualization. Above each line, except the first one, + there must be at least one filled cell. It must be + located above the text on the new line or even further + to the right above. Otherwise, the program will + produce no reasonably useful output. + +9. After entering all the text, export the sheet as an + 1.csv file using colons (':') as separator in the working + directory. Otherwise, the program won’t work. + +10. Run the appropriate executable mmsyn4 in the terminal + or from the command line while being in the directory + with the 1.csv file. Enter a word name of the .csv file + to be saved. DO use alphanumeric symbols and dashes if + needed. Then specify the needed splines and visualization + schemes by specifying the appropriate characters in the + terminal. You will specify additionally whether you + would like to remove '@' sign from the resulting .gv + file and from the vizualization itself. Please, note + that if entered 'y' the program automatically + removes all the '@' from the .gv and visualization. + For more information, see the + [GraphViz documentation](https://www.graphviz.org/documentation/). + +11. Your first visualization is then created. + +12. Save the spreadsheet document as a spreadsheet file. + +13. Repeat the steps from 2 to 12 as needed to produce + more visualizations. + +14. Afterwards, you have a list of svg files, a list of .gv + files as source files for Graphviz, and a list of csv + files, and a saved spreadsheet file. Then you can use + the produced visualizations for some other documents. diff --git a/mmsyn4.cabal b/mmsyn4.cabal --- a/mmsyn4.cabal +++ b/mmsyn4.cabal @@ -2,7 +2,7 @@ -- documentation, see http://haskell.org/cabal/users-guide/ name: mmsyn4 -version: 0.1.5.0 +version: 0.1.6.0 synopsis: The "glue" between electronic tables and GraphViz description: The program mmsyn4 converts a specially formated .csv file with a colon as a field separator obtained from the electronic table into a visualized by GraphViz graph. homepage: https://hackage.haskell.org/package/mmsyn4 @@ -13,7 +13,7 @@ -- copyright: category: Graphics build-type: Simple -extra-source-files: ChangeLog.md, README +extra-source-files: ChangeLog.md, README.markdown cabal-version: >=1.10 executable mmsyn4