Menu

#13 MangaCatTag terminal interface

Beta Testing
open
All
New feature request
Core
2013-09-20
2013-09-05
Jason Ely
No

1. Description

Currently, MangaCatTag launches with a default UI where a user can edit tag information. But in many instances, we might want to automate certain processes such as checking if the file is MangaCatTg supported or just getting tag information out of a file. We'll most probably also want to do this from other programming languages.

For MangaCatTag 1.3, create a terminal interface with the following basic functionality:

  1. Query if file is MangaCatFile - return true or false.
  2. List known MangaCatTag frame names. This will give a list of the 4 character frame identifiers that MangaCat supports (35 frame names since version 1.2).
  3. List frames on file - return a list of 4 character frame identifiers that the file has (if is MangaCatTag file type).
  4. Get string frame value - if the file has a tag, then return a string value for the frame (if the frame exists) e.g.
  5. Return String representing all the frame present and their values.

As a practical example, we can work on the command line like so:

//checking if MangaCatTag exists on file
MangaCatTag.jar -e c:/path/to/some/zip/file.zip (returns true if tag available or false if not)

//get the manga name from the tag
MangaCatTag.jar -f c:/path/to/some/zip/file.zip "MNME" (would return the manga name associated with the frame or zero length string if no frame can be found by that name.)

//get all the frames and their values.
MangaCatTag.jar /f /a c:/path/to/some/zip/file.zip

would return a semi colon string something like this:

TNME=Naruto;MAUN=Manga Author;TDEM=Shonen;TGEN=Action,Martial Arts,Romance

2. Target MangaCat Release

MangaCat BETA

3. Target MangaCat Module or Plugin

N/A

4. What need of the MangaCat community will be addressed

Developers can now work on the command line instead of interacting through UI or writing java code.

5. Estimated Development Time

40 hours.

6. Does the new development have OS restrictions, IO devices, OS Architecture types?

No.

7. Are there any code changes that must be made to core/MangaCat to accommodate this change request?

No.

8. Explain how the functionality should be delivered e.g., through new plugin, as part of core code, etc.

The functionality should ship as part of the Default MangaCatTag functionality.

9. Priority

High

Discussion

  • Jason Ely

    Jason Ely - 2013-09-18
    • Description has changed:

    Diff:

    --- old
    +++ new
    @@ -1,8 +1,10 @@
    -MangaCatTag will launch with a default UI where a user can edit tag information. But in many instances, we might want to automate certain processes such as checking if the file is MangaCatTg supported or just getting tag information out of a file. In many instances, we'll want to do this from other programming languages. 
    +**1. Description**
    +
    +Currently, MangaCatTag launches with a default UI where a user can edit tag information. But in many instances, we might want to automate certain processes such as checking if the file is MangaCatTg supported or just getting tag information out of a file. We'll most probably also want to do this from other programming languages. 
    
     For MangaCatTag 1.3, create a terminal interface with the following basic functionality:
    
    -1. Is MangaCatFile - return true or false.
    +1. Query if file is MangaCatFile - return true or false.
     2. List known MangaCatTag frame names. This will give a list of the 4 character frame identifiers that MangaCat supports (35 frame names since version 1.2). 
     3. List frames on file - return a list of 4 character frame identifiers that the file has (if is MangaCatTag file type).
     4. Get string frame value - if the file has a tag, then return a string value for the frame (if the frame exists) e.g.
    @@ -11,10 +13,10 @@
     As a practical example, we can work on the command line like so: 
    
     //checking if MangaCatTag exists on file
    -MangaCatTag.jar /e c:/path/to/some/zip/file.zip (returns true if tag available or false if not)
    +MangaCatTag.jar -e c:/path/to/some/zip/file.zip (returns true if tag available or false if not)
    
     //get the manga name from the tag
    -MangaCatTag.jar /f c:/path/to/some/zip/file.zip "MNME" (would return the manga name associated with the frame or zero length string if no frame can be found by that name.)
    +MangaCatTag.jar -f c:/path/to/some/zip/file.zip "MNME" (would return the manga name associated with the frame or zero length string if no frame can be found by that name.)
    
     //get all the frames and their values.
    @@ -24,6 +26,36 @@
    
     TNME=Naruto;MAUN=Manga Author;TDEM=Shonen;TGEN=Action,Martial Arts,Romance
    
    +**2. Target MangaCat Release**
    +
    +MangaCat BETA
    +
    +**3. Target MangaCat Module or Plugin**
    +
    +N/A
    +
    +**4. What need of the MangaCat community will be addressed**
    +
    +Developers can now work on the command line instead of interacting through UI or writing java code.
    
    +**5. Estimated Development Time**
    
    +
    +40 hours.
    +
    +**6. Does the new development have OS restrictions, IO devices, OS Architecture types?**
    +
    +No.
    +
    +**7. Are there any code changes that must be made to core/MangaCat to accommodate this change request?**
    +
    +No.
    +
    +**8. Explain how the functionality should be delivered e.g., through new plugin, as part of core code, etc.**
    +
    +The functionality should ship as part of the Default MangaCatTag functionality.
    +
    +**9. Priority**
    +
    +High
    
     
  • Jason Ely

    Jason Ely - 2013-09-20
    • summary: MangaCat terminal interface --> MangaCatTag terminal interface
    • OS: --> All
     

Log in to post a comment.