Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Migrate content #2

Open
smortex opened this issue May 13, 2015 · 7 comments
Open

Migrate content #2

smortex opened this issue May 13, 2015 · 7 comments
Assignees
Labels

Comments

@smortex
Copy link
Contributor

smortex commented May 13, 2015

The nfc-tools wiki has a number of informational pages that are not that easy to find with the current flat layout and would benefit from a move to Jekyll with a hierarchical organization.

  • Documentation
    • Chips
      • PN51x
      • PN53x
    • Initiators
      • ACR122
      • Arygon
      • OpenPCD 2
      • RC-S360
      • RDR608
      • SCL3711
      • StickID
    • Targets
      • FeliCa
      • Innovatron
      • Jewel/Topaz
      • MIFARE Classic
      • MIFARE DESFire
      • MIFARE DESFire EV1
      • MIFARE Plus
      • MIFARE Ultralight
      • MIFARE Ultralight C
    • Standards
      • ISO14443
      • ISO14443A
      • ISO14443B
      • ISO14443B'
      • ISO15693

Open questions:

  • Documentation (root element) is probably not the right name. Any better idea?
  • How to name / group initiators ?
  • Separating Targets / Standards is maybe not a good idea ?
  • Any point you would like to see discussed ?
@smortex smortex self-assigned this May 13, 2015
@smortex smortex added this to the nfc-tools reloaded milestone May 13, 2015
@doegox
Copy link
Member

doegox commented May 15, 2015

Hi Romain
Documentation: sounds fine to me, or "Resources"?
Initiators/targets: I'm not fan of that. initiator/target is just a role any NFC device can hold.
=> NFC devices and Tags?
BTW "NFC tags (type1/2/3/4/5)" are missing in your hierarchy.
Sth like this?

  • NFC devices
    • ACR122...
  • NFC tags
    • NFC tag type 1...
  • RFID tags
    • FeliCa...
  • Standards
    • ISO14443

knowing that some RFID tags can be NFC tags if properly formatted...

separating standards is ok for me because they are somehow orthogonal and deserve their own page.

If you're familiar with github markdown/jekyll, go ahead, I can fix technical details later if needed.

Thanks!

Phil

@smortex
Copy link
Contributor Author

smortex commented May 17, 2015

👍 for Resources (when I read Documentation I think I will find the software documentation while here we have general information about NFC).

I am updating my code to have devices and tags as you suggest. I only have difficulties to see how to split the content for RFID Tags and NFC Tags. The wiki currently redirects from NFC Tag Type 3 to FeliCa for example, and I guess you have a plan to split the information a better way.

I'll finish cleaning up the structure, commit and check that Github's version of Jekyll is fine with it, so that you can adjust all this :-)

@doegox
Copy link
Member

doegox commented May 21, 2015

RFID tags <> NFC tags:
They are referring to different things.
RFID tags = products implementing "old" standards/proprietary_standards such as FeliCa (japanese standard), ISO14443-4, Mifare Classic, Mifare Ultralight, Jewel,...
NFC tags = products implementing the 4 (soon 5) NFC tag types. Usually a NFC tag is a RFID tag properly configured/formatted to accept a NDEF content. And under this scheme, usually only a subset of the original RFID tag features is used, the rest is ignored (e.g. FeliCa crypto or DesFire features).

Today there is more or less a 1-to-1 mapping between NFC tag and RFID tag (modulo the proper formatting of the tag) but tomorrow you could have several products implementing the same NFC tag "API". First one will be probably the tag type 4, if not yet the case, and you could have easily a non-NXP ISO14443-4B as basis for a NFC tag type 4.

What's a bit borderline is the configuration/formatting of a NFC tag because only the usage of a formatted tag is explained in NFC docs, not how to achieve such formatting, so where to put that info? in NFC tags or in RFID tags? ;-)

@smortex
Copy link
Contributor Author

smortex commented May 26, 2015

What's a bit borderline is the configuration/formatting of a NFC tag because only the usage of a formatted tag is explained in NFC docs, not how to achieve such formatting, so where to put that info? in NFC tags or in RFID tags? ;-)

What about telling that Tag X can be formatted as a NFC Forum type N tag on the Tag X page, that Tag X, Y and Z can be formatted as NFC Forum type N tags on the Type N page, and link to an example in the libfreefare for how to do this (the datasheets are supposed to already explain how to do this and we should have links to them from the RFID tag pages… this should be the primary source of information for developpers who want to use libnfc and not libfreefare)?

@doegox
Copy link
Member

doegox commented May 26, 2015

fine with me :)

@smortex
Copy link
Contributor Author

smortex commented Jun 1, 2015

I finally pushed a first draft:
http://nfc-tools.github.io/

@doegox
Copy link
Member

doegox commented Jun 1, 2015

Great!
Resources -> we land on a page with a big "Documentation" title :)
logo should be more contrasted, I'll send you an update

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants