Contribute to Cryptology City: Difference between revisions

From Cryptology City
Jump to navigation Jump to search
No edit summary
No edit summary
Line 24: Line 24:




== Creating a new primitive ==
== What to put in a primitive ==




== Creating a new assumption ==
== What to put in an assumption ==




== Adding citations ==
== Adding citations ==
The best way to add a citation is to add a reference to the [[References]] page using the [[Template:Reference]] which is made to be used as in the following example:
<nowiki>{{Reference
    |id=cdh20 |tag=CDH20
    |title=A Lower Bound for One-Round Oblivious RAM
    |authors=D. Cash, A. Drucker, and A. Hoover
    |journal=TCC
    |srcdetail=2020
    |link=https://eprint.iacr.org/2020/1195
}}</nowiki>


I try to keep the list in [[References]] alphabetized by the '''author abbreviation''', but as long as the first author initial is in the right place it should be easy to fix later on.
To then add the citation to the page in question, you can use (for example) "<nowiki>[[ccref#cdh20 | [CDH20]]]</nowiki>" which renders as [[ccref#cdh20 | [CDH20]]]. Make sure to use the lower case id after the ccref# to that it creates a direct link to the citation on the [[References]] page.


== Adding a new result ==
== Adding a new result ==

Revision as of 02:18, 28 June 2024

Cryptology City is a large project and requires many people to work together to create something useful. One reason that it is so difficult to systematize cryptology is that there are a variety of definitions, notations, variations, and colliding terms throughout a lot of the literature. It's very easy to get confused or lost in the details.

This flexibility is often useful! It allows authors to tailor their presentation for their paper, but here we want to try to bring everything under similar(ish) notation and standards where possible. This page should hopefully serve as a guide for contributors who are not sure what to include in their contributions or how to format them.

For people are more interested in the broader direction of the website or would like to help beyond adding to the knowledge base, I have also started a Keybase team to discuss the project in more detail. Feel free to join me there!

For those who are more keen to pattern match, here are some prototypical examples of Cryptology City pages.

Primitives:

Assumptions:


What to put in a primitive

What to put in an assumption

Adding citations

The best way to add a citation is to add a reference to the References page using the Template:Reference which is made to be used as in the following example:

{{Reference
    |id=cdh20 |tag=CDH20
    |title=A Lower Bound for One-Round Oblivious RAM
    |authors=D. Cash, A. Drucker, and A. Hoover
    |journal=TCC
    |srcdetail=2020
    |link=https://eprint.iacr.org/2020/1195
}}

I try to keep the list in References alphabetized by the author abbreviation, but as long as the first author initial is in the right place it should be easy to fix later on.

To then add the citation to the page in question, you can use (for example) "[[ccref#cdh20 | [CDH20]]]" which renders as [CDH20]. Make sure to use the lower case id after the ccref# to that it creates a direct link to the citation on the References page.

Adding a new result