CSA obsessive-compulsive disorder

2024-04-29T21:59:08Z

Raccoondad:

'''Child sexual abuse obsessive-compulsive disorder''', more commonly referred to as "pedophilia obsessive-compulsive disorder" or "POCD", is a type of OCD, centered around intrusive thoughts and compulsions about sexual or mostly sexual harm to children.

__TOC__

= OCD Overview =
OCD is a neurological disorder, associated with genetic and environmental factors. A mutation in a human serotonin transporter gene (hSERT) has been pointed out as one of its possible causes<ref>[https://beyondocd.org/ocd-facts/what-causes-ocd What Causes OCD?] BeyondOCD.org.</ref>, that’s why most of the medication, frequently prescribed for this disorder, belongs to a class of antidepressants called selective serotonin reuptake inhibitors (SSRIs). Other methods of treatment for OCD include cognitive-behavioral therapy, specifically its subtype, exposure and response prevention (ERP) therapy<ref>[https://www.verywellmind.com/ocd-treatments-2510626 Treatments for Obsessive-Compulsive Disorder], Verywellmind.</ref>.
OCD most commonly manifests as a combination of obsessive intrusive thoughts (unwanted ideas or images, appearing in one's mind) and compulsions (actions one feels an urge to perform in order to soothe the intrusive thoughts).
OCD is sometimes classified by the nature and topic of obsessions and compulsions:
cleaning (contamination obsessions and cleaning compulsions);
doubt (compulsive checking and self reassurance);
symmetry (symmetry obsessions and repeating, ordering, and counting compulsions);
forbidden or taboo thoughts (aggressive, sexual, and religious obsessions)<ref>[https://icd.who.int/browse11/l-m/en%23/http://id.who.int/icd/entity/1582741816 6B20 Obsessive-compulsive disorder], ICD-11.</ref>.
It is important to know that OCD can present differently throughout one's life, and it is possible to have obsessions and compulsions from several categories, subsequently or at the same time. OCD subtypes are not independent diagnoses.

= Child Sexual Abuse Obsessive-Compulsive Disorder Overview =
CSA OCD/POCD belongs to the fourth category of OCD.

=== Typical Obsessions ===

* thoughts about sexual abuse of a child;
* thoughts about a naked child;
* thoughts of having sexually abused or molested a child in the past and fear that one may be in denial or has forgotten, blacked out and erased the memory;
* unwanted arousal sensations even with mere thoughts of a child's company.

=== Typical Compulsions ===

* avoidance of children;
* avoidance of activities that may include interactions with children;
* avoidance of reading articles or watching shows that mention child sexual abuse or minor attraction;
* doubt and suspicion towards one's own behavior around children;
* constantly asking for advice and reassurance from trusted loved ones regarding self-doubt and guilt<ref>[https://archive.ph/o/Fa8Va/https://www.gatewayocd.com/pedophilia-ocd-symptoms-and-treatment/ Pedophilia OCD – Symptoms and Treatment], The Gateway Institute.</ref>.

Some people suffer additional intrusive thoughts about bringing nonsexual harm to children. This type of OCD is treated by the same methods as any other type of OCD.
It is also important to note that OCD-induced fears do not necessarily reflect what one considers to be harmful to children. For instance, a person can be afraid of experiencing arousal in presence of a child without actually believing this arousal would be noticeable/harmful. OCD is irrational at its core, and the mind fixates on worst case scenarios.

= Alternative Terminology =
Since typical intrusive thoughts, characterizing this disorder, do not concern pedophilia as a type of attraction, but CSA, renaming from "pedophilia obsessive-compulsive disorder" to "child sexual abuse obsessive-compulsive disorder" makes most sense. However, it is possible that some people suffer from genuine intrusive thoughts about pedophilia as an identity, without any thoughts about CSA (even though such cases are not yet recorded). It is possible to reserve the term "POCD" for this situation, bringing its meaning closer to homosexual OCD and other sexual orientation OCD types<ref>[https://www.sheppardpratt.org/news-views/story/sexual-orientation-ocd-a-k-a-so-ocd-or-hocd/ Sexual Orientation OCD (a.k.a. SO-OCD or HOCD)], Sheppard Pratt.</ref>.

= CSA OCD And The Map Community =
=== Mapmisia Of People With CSA OCD ===
As the more common name of this disorder, "POCD", might hint, many people experiencing it equate their thoughts of child abuse with pedophilia. "You are not a pedophile" is a common affirmation<ref>[https://www.tumblr.com/pocdvivor/622001988501159936/you-are-not-a-pedophile-you-will-not-become-a?source=share pocdsurvivor], Tumblr.</ref>, and articles, written by and for people with this OCD type often claim that maps groom and sexually abuse children<ref>[https://www.ocdtypes.com/pocd-ocd.php Pedophilic OCD], OCD Types, New England OCD Institute.</ref>.

Multiple people with CSA OCD choose to relieve their stress by verbal violence towards maps and accuse maps of worsening their symptoms.

=== Ableism Of Maps ===
After negative interactions, some maps adopt ableist attitudes towards people with CSA OCD:

* Mistrust and suspicion towards everyone with this disorder. Some maps automatically consider any person with CAOCD to be a mapmisiac.
* Denial of CSA OCD's existence, equating it to internalized mapmisia. Poor understanding of OCD leads maps to believe this condition is just sexual fantasies about children.

{| style="width:300px; border:5px;"
|[[Image:POCD.png|100px|]]
|}
An anti-POCD graphic from Newgon

=== Map/CSA OCD Unity ===
Many on both sides also choose to become allies. Both are extremely stigmatized groups and both may need access to the same mental health resources, because actual maps with internalized mapmisia might need to hear that they are not doomed to rape, and, according to anecdotal evidence, people with CSAOCD experience milder symptoms in an environment where attraction to children is not seen as scary and scandalous.
In addition to that, contrary to popular belief, a map can experience CSA OCD. Maps who already have OCD are an underreported risk group for this disorder. OCD intrusive thoughts and compulsions can include both children outside of a map's age of attraction and inside.

= References =

File:POCD.png

2024-04-29T21:41:17Z

Raccoondad:

CSA obsessive-compulsive disorder

2024-04-29T21:33:07Z

Raccoondad: Created page with "'''Child sexual abuse obsessive-compulsive disorder''', more commonly referred to as "pedophilia obsessive-compulsive disorder" or "POCD", is a type of OCD, centered around intrusive thoughts and compulsions about sexual or mostly sexual harm to children. __TOC__ = OCD Overview = OCD is a neurological disorder, associated with genetic and environmental factors. A mutation in a human serotonin transporter gene (hSERT) has been pointed out as one of its possible causes<r..."

Psychopathia sexualis by Dr. Friedrich S. Krauss (German text)

2024-04-29T21:17:11Z

Raccoondad: Created page with "This is the original German text of Psychopathia sexualis by Dr. Friedrich S. Krauss, which contains the first known mention of the word "paraphilia" that he coined. The original article was published in Wiener Klinische Rundschau, Volume 17, on August 2, 1903 and can be accessed through multiple archives of varying quality<ref>[https://babel.hathitrust.org/cgi/pt?id=mdp.39015012313329&view=1up&seq=716 Psychopathia sexualis by Dr. Friedrich S. Krauss] via HathiTrust.</re..."

This is the original German text of Psychopathia sexualis by Dr. Friedrich S. Krauss, which contains the first known mention of the word "paraphilia" that he coined. The original article was published in Wiener Klinische Rundschau, Volume 17, on August 2, 1903 and can be accessed through multiple archives of varying quality<ref>[https://babel.hathitrust.org/cgi/pt?id=mdp.39015012313329&view=1up&seq=716 Psychopathia sexualis by Dr. Friedrich S. Krauss] via HathiTrust.</ref><ref>[https://archive.org/details/wiener-klinische-rundschau17/page/1660/mode/2up Psychopathia sexualis by Dr. Friedrich S. Krauss] via Archive.org.</ref>.
For an English translation, see [[Psychopathia sexualis by Dr. Friedrich S. Krauss (English text)]].

= Psychopathia sexualis. =

=== Ein Bericht von Dr. Friedrich S. Krauss. ===

Wir Menschen unterscheiden uns von den anderen Geschöpfen gar sehr zu unserem Nachteile durch einen Hang zum Mystizismus. Unsere Wissenschaft steckt noch arg im Glauben, oder vielmehr, wo uns der innere Zusammenhang zwischen Ursache und Wirkung nicht klar wird, schaffen wir gern einen Glauben, geben ihn für Erkenntnis und Wissenschaft aus und identifizieren uns mitunter damit so stark, daß wir jeden, der unseren Glauben nicht für bare Münze annimmt, als einen Beleidiger unserer Größe, als einen Lästerer und unwissenschaftlichen Menschen betrachten.
Die Anhänger v. Krafft-Ebings und des verworrenen Cesare Lombroso dürften leicht geneigt sein, z. B. einen Dr. Iwan Bloch zu verketzern. Das ist wieder so einer, der an keine Autoritäten glaubt und bei dem der Schwur kein Beweismittel ist. Er begnügt sich bloß damit, die Erscheinungswelt nach allen Richtungen hin zu durchforschen, um ein möglichst großes Tatsachenmaterial aufzusammeln und es so zu ordnen, daß die Dinge einander von selber erklären. Er zählt zu jenen, die überzeugt sind, daß wir nicht mehr wissen können, als uns die Natur selber lehrt, und daß es schon etwas Großes ist, die Natur zu begreifen. Nach dieser Methode es ist die der Ethnologen und Folkloristen mußte er zu einem Umstürzler werden. Er räumt mit Köhlerglauben auf und schafft keinen neuen dazu. Auf diese Weise brachte er ein Werk(1) zustande, das der Ethnologie gewaltigen Vorschub leistet und wohl geeignet ist, auch den Aerzten ungemein viel zu nützen, indem es ihre Perspektive für die Betrachtung allgemein menschlicher Triebe und Neigungen aufs höchste erweitert. Bloch ist einer von jenen Aerzten, die in einem Atem mit einem Max Bartels und Max Höfler zu nennen sind. Sie fassen nicht bloß den kranken oder erkrankenden Menschen, sondern den Menschen als Menschen ins Auge und sie wissen, daß das Licht das Wesentliche ist, nicht der Schatten. Ist einmal die Scheu vor dem Neuerer überwunden, so wird Dr. Blochs Werk in der Bibliothek eines jeden Arztes sowie eines jeden Folkloristen zu finden sein; denn der Gegenstand, den es behandelt, ist der wichtigste im Menschendasein, der Geschlechtstrieb nämlich.
Die Bezeichnung “Psychopathia sexualis” enthält schon ein fertiges Urteil in sich, und darum taugt sie nicht gut für wissenschaftliche Arbeiten. Richtig wäre dagegen eine Wendung wie: Der die Zeugung ausschließende geschlechtliche Verkehr. v. Krafft-Ebing nannte bald einen, der nicht aufs Kindermachen ausging und seine Wollust auf dem nicht alltäglichen Begattungswege befriedigte, pervers, so wie Lombroso für jeden, der nicht nach dem italienischen Strafgesetze tadellos sein Leben abwickelt, den entehrenden Namen eines Verbrechers bereithält. Ins Triviale übersetzt, ist dies der Standpunkt einer gewissen Wiener “Schriftstellerin”, einer glücklicherweise ziemlich unbekannten Schwätzerin. Stolpert mal ein Kolporteur mit seiner Bürde in ein verrufenes Nachtcafé hinein, so sind die Schriftsteller, deren Bücher er feilbietet, unmoralische Gesellen, die sie, die Frau X. Y. Z., aus der Literatur hinausbugsieren möchte. Liest man das Gewäsche dieses oder gleichgearteter Weiber, so begreift man es, daß so viele Männer die Frau nur als ein Sexualwesen betrachten mögen, und endlich versteht man auch die bei manchen feinfühligen Männern krankhaft gesteigerte Abneigung gegen jeden Verkehr mit dem Weibe. Dieses gewiß nicht nebensächliche Moment übersah Dr. Bloch in seiner Aetiologie.
Das Werk gliedert sich in zwei einander stilistisch nicht ganz gleiche Teile, von denen der zweite sorgfältiger als der erste ausgefeilt ist. So wenig bei rein wissenschaftlichen Werken das Literarische in die Wagschale fällt, so muß ich doch hier darauf hinweisen; denn Bloch ist auch ein Meister der Darstellungskunst gleich einem Hyrt und die Lektüre seiner Schriften, z. B. des Werkes über den Ursprung der Syphilis (2), gewährt einem auch eine ästhetische Befriedigung.
In der Aetiologie wuchs der riesige Stoff dem Autor förmlich über den Kopf. Vermochte er ihn auch wissenschaftlich aufzuarbeiten, formell bezwang er ihn nicht ganz befriedigend. In Wirklichkeit bildet jeder Band für sich nur je ein Kapitel, das fast willkürlich durch Sternchen in Unterabteilungen getrennt ist, deren Anordnung vielleicht nicht immer einwandfrei ist. Doch darauf fällt bei einem mit so trefflichen Registern versehenen Werke gewiß kein Schwergewicht. Die schöne Einleitung Professor Eulenburgs ist für den Protektor ebenso ehrenvoll als für den Schützling, das Buch, dem sie als Empfehlung dienen soll; denn sie enthält das Einbekenntnis eines durch seine soziale Stellung ausgezeichneten Forschers, “daß (Dr. Bloch) nicht von dem einseitigen oder voreingenommenen Standpunkte des Mediziners und Medizinhistorikers, sondern mit dem freieren und weiteren Blicke des Anthropologen und Ethnologen und auch mit dem ganzen dazugehörigen gelehrten Rüstzeug ausgestattet an die Sache herantrat”.
Der erste Band behandelt das graue Altertum und die Ubiquität der sexuellen Perversionen und deren Abhängigkeit. von Kultur, Nervosität und Degeneration, gibt eine Kritik der Anschauungen über die Aetiologie der sexuellen Anomalien (Heredität und Erworbensein), eine Kritik der Lehre von den angeborenen sexuellen Perversionen. Der Hauptteil des Bandes ist der Aetiologie der Geschlechtsverirrungen bei gesunden Menschen und der speziellen Aetiologie der Homosexualität gewidmet, der zweite Band der speziellen Aetiologie der sadistischen und masochistischen Phänomene und der speziellen Aetiologie der komplizierten sexuellen Perversitäten und Perversionen.
Bei einem Werke, worin es sich um die Mannigfaltigkeit des stärksten Naturtriebes in der Spiegelung des Völkergedankens handelt, kann man bei der Fülle der dargebotenen Mitteilungen unmöglich auf Einzelheiten des Tatsachenmaterials eingehen; denn jeder Leser dieser Fachzeitschrift ist wohl in der Lage, sowohl aus der ihm bekannten Literatur, als auch aus seinen Erfahrungen heraus den Stoff zu vermehren und im besonderen zu ergänzen. Es ist förderlicher, die Gesichtspunkte der Betrachtung und die Forschungsergebnisse des Verf. hier in nuce zu wiederholen, um zur Weiterarbeit anzuregen. Erlangt Dr. Blochs Arbeit die ihr nach meinem Dafürhalten gebührende Würdigung in ärztlichen Kreisen sowie unter Volksforschern, so leitet sie gewiß eine neue Epoche auf dem behandelten Sondergebiete ein.
Von prinzipieller Wichtigkeit ist Blochs Bemerkung: “Im großen und ganzen besteht der Satz zu Recht, daß der Geschlechtstrieb als rein physische Funktion weder ein Vergleiehungsobjekt, noch ein Unterscheidungsmerkmal zwischen primitiven und zivilisierten Menschen bilden kann.” Das ist insofern richtig, als dem Ethnologen nirgends in der Welt wirklich primitive Menschen in gesellschaftlichen Gruppen begegnen. Alle Menschentribus der Oekumene sind bereits nach der einen Richtung hin zivilisiert und wir müssen gegebenenfalls die Vergleiehungsobjekte in der nichtmenschlichen Tierwelt suchen. Das Wort “Kultur” ist daher in der nachfolgenden Ausführung Blochs störend und der Gedanke wäre anders klarer und bestimmter auszudrücken: “Das Wesen des Geschlechtstriebes und seiner Anomalien ist eben unabhängig von aller Kultur und weist bei primitiven und zivilisierten Völkern dieselben Züge auf; es ist unabhängig von den mit der Kultur verknüpften körperlichen und geistigen Schädigungen, von der Degeneration im anthropologischen und pathologischen Sinne. Kultur und Degeneration kommen. nur als begünstigende, frequenzvermehrende Einflüsse in Betracht.” Unanfechtbar ist die Feststellung Blochs: “Daneben gibt es eine große Zahl von äußeren Faktoren, welche mit der Kultur, der Degeneration, der degenerativen Vererbung nichts zu tun haben, deren Einflüsse aber für die Entstehung sexueller Anomalien bei primitiven und hochstehenden Völkern von größter Bedeutung sind.”
Dr. Bloch unterscheidet im ganzen zwei Gruppen sexueller Perversionen, die angeborenen, bezw. die seit frühester Kindheit bestehenden, und die im späteren Leben erworbenen. Letztere zerfallen wiederum in diejenigen geschlechtlichen Verirrungen, die durch Krankheiten bedingt sind, und jene, die bei Gesunden vorkommen. Bloch stellt in seiner Schrift nur die ätiologischen Verhältnisse der letztgenannten Gruppe dar, d. h. die Ursachen der Entwicklung sexueller Perversionen bei sonst gesunden Menschen. An dem Ausdrucke “sexuelle Perversion” setze ich das Gleiche aus wie an “Psychopathia sexualis”. Auch hier verbirgt das Wort von vornherein eine Verurteilung, die zumindest in wissenschaftlicher Diskussion nicht vorangestellt werden soll, um das Urteil nicht zu beeinflussen. Ich möchte als Ersatz für beide Termini einen anderen vorschlagen, u. zw, wieder einen griechischen, Paraphilie (παράφιλία), für den ich zwar keinen Beleg aus dem alten griechischen Sprachgebrauche kenne, der aber analog dem Worte παράνοια (Unverstand, Torheit, Wahnsinn) gebildet ist und schlicht eine von der gewöhnlichen Liebe abweichende Form andeutet, die dem Wesen der wahren Liebe nicht entspricht, deren Zweck die Befruchtung des Weibes am Ende sein muß. Das Beiwort lautete darnach paraphiletisch (παραφιλητος). Ich will mich im folgenden dieser Neubildungen bedienen, die auch den Vorzug haben, daß sie uns jedesmal ein Wort ersparen.
In der großen Mehrzahl der Fälle, sagt Bloch, ergibt die ärztliche Untersuchung keinerlei Indizien für das Vorhandensein einer krankhaften Grundlage der geschlechtlichen Abnormität. Einzelne geringfügige Symptome oder gar bloße “Nervosität”, die ja heute so überaus in allen Schichten des Volkes verbreitet ist, genügen gewiß nicht, um paraphiletische Akte oder Zustände als “krankhaft” hinzustellen. Es besteht vielmehr kein Zweifel, daß alle Paraphilien auch bei geistig und körperlich gesunden. Menschen auftreten können, die in jeder Beziehung als “zurechnungsfähig” betrachtet werden müssen.
Es steht damit wie mit der Ekstase im Verhältnisse zur klaren Vernunft, worüber uns Thomas Achelis auch vom Standpunkte der Ethnologie dankenswerteste Aufklärungen gewährt (3). Auch die Paraphilic zeigt sich als eine besondere Art von Ekstase in geschlechtlicher Beziehung, und der Zusammenhang beider Erscheinungen, die zwar von verschiedenen Geistesrichtungen ausgehen, ist klar erweislich, wofür sich Andeutungen auch bei Bloch finden.
Nach seiner Auffassung liegt die Erklärung für das häufigere Vorkommen der Homosexualität und anderer Paraphilien der Vita sexualis in südlichen Gegenden einzig und allein in dem Umstande, daß in diesen Regionen das frühere Auftreten und die größere Intensität der Libido häufiger das Bedürfnis nach Reizsteigerungen in deren Befriedigung zur Folge haben muß. Als Ethnolog kann ich ihm hierin nicht unbedingt beipflichten. Weil sich in südlichen Ländern unter milderen Klimaten die Paraphilien mehr in der Oeffentlichkeit abspielen und augenfälliger sind, erwecken sie den Anschein häufigeren Vorkommens, während dem Nordländer erstens die Gelegenheiten zur Stillung seiner paraphiletischen Wünsche nicht so günstig sind, wobei noch in Rechnung zu ziehen ist, daß die stark bekleideten Nordländer an ihrem Gewande auch ein nicht zu unterschätzendes Schutzmittel gegen die Unternehmungen der Paraphiletiker besitzen. Die sinnliche Begier ist bei allen Menschengruppen gleichmäßig vorhanden, nur machen die einen aus der Not eine Tugend und die Tugend wird zur Gewohnheit, zur Sitte und endlich zum Rechtsbrauch, doch nicht überall. Das lehrt uns das Volksleben der Burjäten. Diese Leutchen haben nur nicht das unendliche Glück gehabt, in ihrer Mitte die höchste Blüte der Kultur, d. h. gelehrttuende Skribenten gedeihen zu sehen, sonst wären auf sie dieselben Worte anwendbar, die Bloch für die Inder hat, wie folgt: “Aus dem näheren Studium des indischen Liebeslebens ergibt sich mit Evidenz, daß von den Indern das Raffinement und die Unzucht im Geschlechtsverkehre planmäßig ausgebildet und als ein religiöses Gebot bezeichnet wurden, ohne daß von irgendwelchen angeborenen oder krankhaften Zuständen, sogenannter ‘Psychopathia sexualis’ im Sinne Krafft-Ebings, die Rede sein kann. Zahlreiche, in ihrer Art einzig dastehende Lehrbücher der Liebeskunst lehren mit der Begründung der Notwendigkeit alle Arten der geschlechtlichen Verirrungen, Sadismus in Form von Kratzen, Beißen und Flagellieren (inklusive Morsus genitalium!), Anwendung von Stimulantien zur Vergrößerung des Penis, zur Erweiterung oder Verengerung der Vulva” u. s. w.
Eulenburg hat die von Lombroso und Ferrero aufgestellte Theorie von der geringeren Sensibilität des Weibes gründlich widerlegt. Wenn man R. Günther und Ed. Carpenter (dessen Gewäsch wir nun auch deutsch zu genießen bekamen) anhört, wäre das Weib sogar nahezu geschlechtlich indifferent. Bloch meint dagegen, es wäre “doch nicht zu leugnen, daß im allgemeinen der Mann ein mächtigeres sexuales Triebleben besitzt als das Weib. Das sinnliche Verlangen äußert sich früher und kräftiger beim Manne, während das unberührte mannbare Weib viel leichter dem sich regenden dunklen Drange nach geschlechtlicher Vereinigung mit dem Manne Widerstand leisten kann.” Nein, sie kann es nicht! Was sie in unserer Kulturgesellschaft im Zaume hält, ist lediglich die Angst vor den Folgen einer Hingabe an den Mann. Die Folklore lehrt uns ja unwiderleglich, daß das Weib den Mann verführt. Wenn ich irgend etwas mit meinem Buche “Streifzüge im Bereiche der Frauenschönheit” (Leipzig 1903) erwiesen habe, so ist es, wie ich glaube, die größere Schlauheit und Uebermächtigkeit des Weibes über den Mann in geschlechtlichen Dingen. O. Effertz’ Auslassung über Venerie und Erotik, die Bloch zu seinen Gunsten zitiert, hält einer Prüfung nicht Stich, weil Wortspielereien folkloristischen Tatsachen gegenüber ohne Beweiskraft sind. Zehn Seiten später sieht dies Bloch in einer Anmerkung selber richtig ein: “Man verkenne auch nicht, daß häufig nur eine scheinbare sexuelle Anästhesie vorhanden ist, vielmehr die dem Weibe eigentümliche Zurückhaltung im Geschlechtsverkehre als solche gedeutet wird.” Gerade diese “Zurückhaltung” ist dem Weibe nicht eigentümlich, sondern nur die Wirkung eines auf das Weib ausgeübten gesellschaftlichen Zwanges innerhalb unseres Kulturkreises, und selbst da darf man nicht ohneweiters verallgemeinern.
Einen grundlegenden Gedanken spricht Bloch (auf Seite 69 f.) aus, wo er auf den Kulturmenschen zu reden kommt: “Eine reichere soziale Gliederung, ein komplizierteres Geistesleben, eine bestimmtere Gestaltung ethischer Auffassungen reflektieren stets auch auf die Sexualphantasie, können diese in einem bestimmten Sinne verändern und auf Abwege führen. Es gibt keine physische Aeußerung des Sexualtriebes, die nicht unter Umständen allein einer sehr lebhaften oder irregeleiteten Phantasie entsprungen sein könnte.” Das ist wahr, doch nicht allein auf die Kulturmenschen anwendbar. Wir haben noch einige andere Sorgen und Aufgaben im Leben, als bloß den Geschlechtstrieb zu befriedigen, während sich die Phantasie kulturarmer Menschen mehr auf das Punctum puncti konzentrieren kann. Wäre der Geschlechtsgenuß das höchste Menschenglück, wir wären dank unserer Kultur stark im Nachteile. In Bezug auf Phantasie sind wir es auch tatsächlich, und darum ist unser Maß an Lebensglück geringer, aber an Unglück größer.
Nur in einer Hinsicht sind wir Kulturmenschen mit unserer Phantasie auf gleicher Stufe mit den kulturärmsten Menschengruppen verblieben, dort nämlich, wo Sexualleben mit Religion verknüpft ist. “So allein können wir uns,” sagt Bloch, “die Entwicklung einer riesenhaften sexuell kasuistischen Literatur in der Theologie und ihrem Zweige, der Pastoralmedizin, erklären. Das Verständnis für diese Tatsachen ermöglichen nicht die erbitterten, von konfessionellem Vorurteile diktierten Tiraden der Kulturhistoriker, sondern nur die Darlegungen des Arztes und Anthropologen, der diese Dinge im großen Zusammenhange betrachtet und die Beziehungen zwischen Religion und Geschlechtsleben als allgemein menschliche erkannt hat und nicht als künstliche Produkte irgendeiner bestimmten Geistesrichtung auffaßt.”
Im zweiten Teile verficht Bloch im Anschlusse an die Ethnologie die Meinung, daß die meisten geschlechtlichen Verirrungen gar nicht in den Bereich des Arztes fallen; den Kern der algolagnistischen Erscheinungen bilde die Freude am fremden oder eigenen Schmerze, d. h. die gegen andere oder gegen sich selbst gerichtete Grausamkeit. Er findet es auffällig, daß schwache, zarte Personen, besonders Frauen, häufig grausame Neigungen bekunden, die man von ihnen nicht erwartet hätte. Seine Erklärung, die Grausamkeit entspränge vorübergehend der Idee einer Superiorität, damit die den schwachen Individuen eigene Furcht dadurch überwunden werde, ist hübsch, doch nicht ausreichend. Er vergaß dabei hervorzuheben, daß unsere Erziehung leider hauptsächlich auf der Pflege und Ausbildung grausamer Anlagen beruht und daß wir Europäer unter allen Menschengruppen dieses Planeten die Ehre, die allergrausamsten zu sein, für uns in Anspruch nehmen können, und daß man uns fortwährend lehrt, darin unseren Stolz und unsere Ueberlegenheit zu suchen. Was Wunder, wenn dann auch schwache, zarte Personen ihren Anteil an der vermeintlichen Lust und Kraft genießen wollen?! Unsere herrliche, prächtig gefügte gesellschaftliche Ordnung fußt auf Stärkung des Starken und Schwächung des Schwachen. Wenn sich die Weiber organisieren, entsteht eine Gynäkokratie im großen Stile, die Geschichte im kleinen heißt man Masochismus. Einer muß den anderen knechten; knechtet der Mann die Frau, so stoßen wir daran nicht an; wenn sich aber das Weib zu fühlen beginnt, schreien wir wehvoll auf; denn die Welt steht sonst nimmer lang.
Die Möglichkeit einer Verkörperung der gesamten Paraphilie in einem einzigen Individuum gilt Bloch als der beste Beweis für das Erworhensein der Paraphilien, da ja eine Annahme des “Angeborenseins” sämtlicher geschlechtlicher Abnormitäten bei derselben Person unhaltbar wäre.
Angeboren ist die Anlage oder das Talent , den Paraphiletiker macht erst die Gelegenheit . Man sollte es kaum für möglich halten - wieviel Schlechtigkeit wenn dieser Ausdruck statthaft ist - dem Menschenkinde angeboren worden . Darüber gibt uns reichen Aufschluß die Pädologie, deren Vertreter (z. B. O. Chrishman, der Amerikaner) so weit gehen, die Kinder als eine besondere Menschentierart zu bezeichnen. wird kaum fehlgehen, die Kinder als die ersten Urheber von Paraphilien hinzustellen, oder zumindest, die Erwachsenen können von Kindern noch zulernen. Man muß sich Blochs Kernsatz merken: “Die Ungeheuerlichkeit des Aktes ist durchaus kein Kriterium für seinen psychopathischen Ursprung”; ferner: “Man darf aus der Tatsache, daß Kranke eine Paraphilie haben, nicht den Schluß ziehen, daß Paraphilie immer mit Krankheit verknüpft sein muß, zumal wenn man sich an die unzweifelhaft feststehende Tatsache erinnert, daß sich der gesunde Mensch an geschlechtliche Verirrungen derart gewöhnen kann, daß sie als Paraphilien imponieren, ohne deshalb die geistige Gesundheit des Betreffenden im geringsten zu tangieren.”
Als endgiltige, letzte Ursache aller Paraphilien betrachtet Bloch zum Schlusse seines Werkes “das dem Genus Homo eigentümliche geschlechtliche Variations bedürfnis, das als eine physiologische Erscheinung aufzufassen ist und dessen Steigerung zum geschlechtlichen Reizhunger die schwersten Paraphilien erzeugen kann”. Dieses Gesetz bilde die Grundlage einer jeden Philosophie des Geschlechtslebens. Aus ihm gehe mit Deutlichkeit hervor, daß die Prostitution als ein bloßes Produkt dieses sexuellen Variationsbedürfnisses und als Ersatz der ursprünglich aus letzterem hervorgegangenen Promiskuität unausrottbar sei, falls man nicht eine andere Möglichkeit der Befriedigung dieses Variationsbedürfnisses finde, welche die Gefahren der Prostitution beseitigen und doch jener immer wieder durchbrechenden Neigung Befriedigung gewähren könne.
Hier ist der Ausdruck “Prostitution” in einer sehr engen oder konventionellen Bedeutung aufzufassen. Ist doch im Durchschnitte die bei uns übliche Ehe auch nur eine Form der Prostitution des Weibes oder des Mannes oder beider gleichzeitig. Für das Variationsbedürfnis ist durch die Institution der Ehe mit ihrer unausrottbaren Verlogenheit genügend vorgesorgt. Die Prostitution ist kein wirklicher Gegensatz zur Ehe, sondern nur eine Zeitehe mit kurzer, gegenüber der Dauerehe mit endloser Reue. Es gibt zwar auch glückliche Ehen, wie es ja auch Leute gibt, die in der Lotterie große Summen gewonnen haben wollten.
In einer Ermahnung zur Mäßigung in Liebessachen klingt Blochs Werk aus. Das liest sich wie eine Predigt, die weder schadet, noch nützt; an der Philie und Paraphilie ändert dies nichts. Der Leser wird sich dabei auch nicht aufhalten, sondern lieber das Werk von neuem vornehmen; denn es bietet soviel an kostbaren Anregungen, daß man damit innerhalb des Rahmens eines Berichtes nicht fertig werden kann. Mit Nachdruck aufmerksam machen wollte ich die Aerzte auf eine Leistung, aus deren Studium sich ihnen erweiterte Perspektiven eröffnen, und ich hoffe, daß sie in nicht zu ferner Zukunft das Zusammengehen mit den Folkloristen und Ethnologen zur Förderung der Wissenschaft freudig begrüßen werden. Der jährlich tagende Naturforscher- und Aerztekongreß hat bereits eine eigene Sektion für Ethnologie eingeführt, nur melden sich die Ethnologen nicht zu Vorträgen. Es genügt nicht, die Zulassung von Ethnologen zu erklären, als ob sich die Ethnologen um eine solche Ehre reißen würden. Sie sind nicht so ehrgeizig und halten sich darum ferne.

(1) Beiträge zur Aetiologie der Psychopathia sexualis. Von Dr. med. Iwan Bloch , Arzt für Haut- und Sexualleiden in Berlin . Mit einer Vorrede von Prof. Dr. Albert Eulenburg in Berlin . Erster Teil , Dresden . H. R. Dohrn 1902. Zweiter Teil , ebenda 1903.
(2) Der Ursprung der Syphilis . Eine medizinische und kulturgeschichtliche Untersuchung von Dr. med. Iwan Bloch Erste Abteilung. Jena, Gustav Fischer 1901 .
(3) Die Ekstase Von Prof. Dr. Thomas Achelis. I. B. der Kulturprobleme der Gegenwart. Herausgegeben von Leo Berg, Berlin, Johannes Räde, 1902.

= References =

Psychopathia sexualis by Dr. Friedrich S. Krauss (English text)

2024-04-29T21:05:53Z

Raccoondad: Created page with "This is a translation of Psychopathia sexualis by Dr. Friedrich S. Krauss, which contains the first known mention of the word "paraphilia" that he coined. The original article was published in Wiener Klinische Rundschau, Volume 17, on August 2, 1903. The translation was made by Death. = Psychopathia sexualis. = === A report by Dr. Friedrich S Krauss. === We humans differ from other creatures by a tendency towards mysticism, very much to our detriment. Our science is s..."

This is a translation of Psychopathia sexualis by Dr. Friedrich S. Krauss, which contains the first known mention of the word "paraphilia" that he coined. The original article was published in Wiener Klinische Rundschau, Volume 17, on August 2, 1903. The translation was made by Death.

= Psychopathia sexualis. =

=== A report by Dr. Friedrich S Krauss. ===

We humans differ from other creatures by a tendency towards mysticism, very much to our detriment. Our science is still badly stuck in belief. Or rather, where the inner connection between cause and effect is not clear to us, we like to create a belief, pass it off as knowledge and science and sometimes identify ourselves with it so strongly that we regard anyone who doesn’t take our faith at face value as insulting our greatness, as a blasphemer and an unscientific man.
The followers of Krafft-Ebings and the confused Cesare Lombroso could easily be inclined to slander someone like Iwan Bloch, for example. He’s one of those people who don’t believe in authority and for whom an oath isn’t evidence. He is content merely to research the phenomenal world in all directions in order to collect as much factual material as possible and to arrange it in such a way that things explain one another of their own accord. He is one of those who are convinced that we cannot know more than nature teaches us and that understanding nature is already a big deal. According to this method, which is that of the ethnologists and folklorists, he had to become a revolutionary. He does away with Köhler-esque beliefs and does not create new ones in their place. In this way he brought about a work(1) that gives enormous advances to ethnology and is well suited to being of immense use to doctors as well, as it broadens their perspective for the consideration of general human instincts and inclinations to the highest degree. Bloch is one of those doctors who can be mentioned in the same breath as Max Bartels and Max Höfler. They don't just focus on the sick or infected person, but on the person as a person, and they know that the essential thing is the light, not the shadow. Once the fear of the innovator has been overcome, Dr. Bloch's work will be found in the library of every doctor and folklorist; for the subject which it treats is the most important in human existence, namely the sexual impulse.
The term "psychopathia sexualis" already contains a ready judgment in itself, and therefore isn’t suitable for scientific work. On the other hand, a phrase like “sexual intercourse that excludes procreation” would be correct. Von Krafft-Ebing soon called someone who did not set out to make children and satisfied his lust in uncommon ways of copulation perverse, just as Lombroso has the dishonorable name of a criminal ready for anyone who does not conduct his life impeccably according to Italian law. Translated into the trivial, this is the point of view of a certain Viennese “author”, a fortunately relatively unknown chatterbox. If a book seller stumbles into a notorious night café with his burden, the writers whose books he is selling are immoral fellows whom she, Mrs. X.Y.Z., would like to steer out of literature <ref>What or who is meant by the previous two sentences is unclear.</ref>. If one reads the gossip of this or similar women, one understands that so many men like to regard the woman only as a sex object, and finally one also understands the morbidly increased aversion of many sensitive men to any intercourse with women. This certainly not incidental element was overlooked by Dr. Bloch in his Aetiology.
The work is divided into two stylistically not entirely identical parts, the second of which is more carefully polished than the first. Even though the literary isn’t of much importance in purely scientific works, I must point this out here; for Bloch is also a master of the art of depiction similar to Hyrt and the reading of his writings, e.g. the work on the origin of syphilis(2), also gives one an aesthetic satisfaction.
In regard to etiology, the huge amount of material positively outgrew the author. Even if he was able to work on it scientifically, he did not stylistically conquer it in a completely satisfactory manner. In reality, each volume constitutes only one chapter, separated almost arbitrarily by asterisks into subsections, the ordering of which may not always be perfect. But in a work provided with such excellent registers, this is certainly not very important. Professor Eulenburg's beautiful introduction is just as honorable for the mentor as it is for the protégé, the book to which it is intended to serve as a recommendation; because it contains the admission of a researcher distinguished by his social position, “that (Dr. Bloch) approached the topic not from the one-sided or biased point of view of the physician or medical historian, but with the freer and broader view of the anthropologist and ethnologist, equipped with all of the tools related to this position”.
The first volume deals with the antiquity and the ubiquity of sexual perversions and their dependence on culture, nervousness, and degeneration. It also gives a critique of the views on the etiology of sexual anomalies (heredity and acquisition) and a critique of the doctrine of innate sexual perversions. The main part of the volume is devoted to the etiology of sexual aberrations in healthy people and the special etiology of homosexuality, the second volume to the special etiology of sadistic and masochistic phenomena and the special etiology of complicated sexual perversities and perversions.
In a work dealing with the diversity of the strongest instincts of nature in the reflection of national thought, it is impossible to go into the details of the factual material given the wealth of information presented; because every reader of this specialist journal is in a position to increase and in particular to supplement the material both from the literature known to them and from their own experiences. It is more beneficial to summarize the author's points of view and research here in order to stimulate further work. Should Dr. Bloch's work get the recognition I think it deserves in medical circles and among folk researchers, it will certainly herald a new epoch in the special area it deals with.
Of principal importance is Bloch's remark: "On the whole it is correct to say that the sex drive, as a purely physical function, can constitute neither an object of comparison nor a distinguishing feature between primitive and civilized man." This is correct insofar as the ethnologist does not encounter truly primitive people in social groups anywhere in the world. All human tribes of ecumenism are already civilized in one direction and we may have to look for objects of comparison in the non-human animal world. Therefore, the word "culture" is troublesome in Bloch's subsequent explanation and the thought could be expressed differently and more clearly: "The nature of the sexual drive and its anomalies is independent of all culture and shows the same traits in primitive and civilized peoples; it is independent of the physical and mental damage associated with culture, of degeneration in the anthropological and pathological sense. Culture and degeneration can only be considered as facilitating, frequency-increasing influences.” Bloch's statement is indisputable: "In addition, there are a large number of external factors which have nothing to do with culture, degeneration and degenerative heredity, but whose influences are of the greatest importance for the development of sexual anomalies in primitive and civilized peoples.
In general, Dr Bloch distinguishes between two groups of sexual perversions, the ones that are inborn or exist from infancy and those developed later in life. The latter, in turn, are divided into those sexual aberrations which are caused by diseases and those which occur in healthy people. In his work, Bloch presents only the etiological conditions of the latter group, i. e. the causes of the development of sexual perversions in otherwise healthy people. I have the same objection to the expression “sexual perversion” as to “psychopathia sexualis”. Here, too, the word conceals a condemnation from the outset, which should not be put in front of scientific discussions at least, so as not to influence the conclusion. As a replacement for both terms I would like to suggest another, again a Greek one, paraphilia (παράφιλία), for which I know of no evidence from the old Greek usage, but which is formed similar to the word παράνοια (ignorance, foolishness, madness) and simply indicates a form deviating from ordinary love and not corresponding to the nature of correct love, the purpose of which must be the fertilization of the woman. The epithet would then be paraphiletic (παραφιλητος). In the following I want to make use of this new term, which has the additional advantage of saving us a word each time.
In the great majority of cases, says Bloch, medical examination yields no evidence whatsoever of the existence of a pathological basis for sexual abnormality. Individual minor symptoms or even mere "nervousness", which is so widespread today in all classes of the population, are certainly not enough to describe paraphiletic acts or conditions as "morbid". Rather, there is no doubt that all paraphilias can also occur in mentally and physically healthy people who must be considered to be of "sound mind" in every respect.
As with ecstasy, it stands in relation to clear reason, about which Thomas Achelis thankfully gives us explanations from the standpoint of ethnology as well(3). Paraphilia also shows itself to be a special kind of ecstasy in sexual relations, and the connection between the two phenomena, which indeed emanate from different schools of thought, is clearly demonstrable, which Bloch also hints at.
In his opinion, the explanation for the more frequent occurrence of homosexuality and other paraphilias of the vita sexualis in southern regions lies solely in the fact that in these regions, the earlier occurrence and the greater intensity of the libido has to lead to a more frequent need for increased stimulation in its gratification. As an ethnologist, I cannot necessarily agree with him on this point. Because of the warmer climate in southern countries, paraphilias more often take place in public and are more conspicuous, making it seem like they occur more frequently, while the northerner has less opportunities to satisfy his paraphiletic desires, bearing in mind that the heavily clad northerners also have a means of protection against the activities of paraphiletics, the protection that should not be underestimated. The sensual desire is equally present in all groups of people, only some make a virtue out of necessity and this virtue becomes habit, custom, and finally a tradition - but not everywhere. This is what the Buryat folk life teaches us. These people simply weren’t in the infinitely lucky position to have in their midst the peak of culture, i. e. to see scholarly scribes thrive, otherwise the same words that Bloch has for the Indians would apply to them, as follows: “A closer study of the Indian love life shows with evidence that refinement and fornication in sexual intercourse were systematically developed by the Indians and were described as a religious commandment, with no indication of any congenital or pathological conditions, so-called 'psychopathia sexualis' in the sense of Krafft-Ebing. Numerous, one of a kind textbooks on the art of love teach, on the grounds of necessity, all kinds of sexual aberrations, sadism in the form of scratching, biting and flagellating (including morsus genitalium!), use of stimulants to enlarge the penis, to widen or narrow the vagina” etc.
Eulenburg has thoroughly refuted the theory put forward by Lombroso and Ferrero that women are less sensitive. If you listen to R. Günther and Ed. Carpenter (whose twaddle we now also get to enjoy in German), the woman would even be almost sexually indifferent. Bloch, on the other hand, thinks that “it cannot be denied that in general, men have more powerful sexual drives than women. The sensual desire expresses itself earlier and more vigorously in the man, while the untouched nubile woman can much more easily resist the stirring dark urge for sexual union with the man.” No, she can't! The only thing that restrains her in our cultural society is the fear of the consequences of giving herself to men. Folklore irrefutably teaches us that it’s woman who seduces man. If I have proved anything with my book "Streifzüge im Bereiche der Frauenschönheit" (Leipzig 1903), then that it is, I believe, the greater intelligence and superiority of woman over man in sexual matters. O. Effertz's disquisition on venerie and eroticism, which Bloch quotes in his favour, does not stand up to scrutiny because wordplay is irrelevant to folkloric facts. Ten pages later, Bloch himself admits to this in a comment: "One should also not fail to recognize that there is often only an apparent sexual anesthesia, which is an interpretation based on woman’s typical reluctance to engage in coitus." Precisely this “reluctance” is not typical to women, but only the effect of social compulsion exerted on women within our culture, and even here one should not generalize without further ado.
Bloch expresses a fundamental thought (on page 69 f.), where he speaks on the topic of civilization: “A richer social structure, a more complicated spiritual life, a more specific formation of ethical views always also reflect on the sexual fantasy and can, in a certain sense, change it and lead it astray. There is no physical manifestation of the sexual impulse that could not possibly have sprung from a very vivid or misguided imagination alone.” This is true, but not only applicable to civilized people. We have plenty of other concerns and responsibilities in life than just satisfying the sex drive, while the imagination of uncultured people can focus more on the punctum puncti. If the pleasure of sex was the peak of human happiness, we would be at a great disadvantage thanks to our culture. Which we indeed are in terms of imagination, and that’s why we have a lesser degree of happiness, and a higher one of unhappiness.
Us cultured people with our imagination have remained on the same level as the poorest cultured groups of people only in one respect, namely where sex life is connected to religion. “Only in this way can we,” says Bloch, “explain the development of a gigantic literature on sexual casuistics in theology and its branch, pastoral medicine. These facts can not be understood by the bitter tirades of cultural historians, dictated by religious prejudices, but only by the explanations of doctors and anthropologists, who consider these things in the broader context and have recognized the relations between religion and sex life as universally human and not as artificial products of any particular school of thought."
In the second part, following the ethnology, Bloch defends the opinion that most sexual aberrations do not fall within the area of responsibility of the doctor; the core of the algolagnistic phenomena is the joy in someone else's or one's own pain, i.e. cruelty directed at others or at oneself. He finds it notable that weak, delicate people, especially women, often display cruel tendencies which one would not have expected of them. His explanation that cruelty springs temporarily from the idea of superiority, so that the fear inherent in weak individuals may thereby be overcome, is nice, but not sufficient. He forgot to point out that unfortunately our upbringing is mainly based on the cultivation and training of cruel tendencies and that we Europeans can claim the honor of being the most cruel of all groups of people on this planet, and that we are constantly being taught to find pride and superiority in this. No wonder then that weak, delicate people also want to enjoy their share of the supposed pleasure and strength. Our glorious, magnificently constructed social order is based on strengthening the strong and weakening the weak. If women were to organize themselves, a gynecocracy would arise on a grand scale, on a small scale it is called masochism. One must enslave the other; if man enslaves woman, we do not stumble; but when woman begins to feel herself, we cry out in sorrow; because otherwise the world wouldn’t stand for long.
The possibility of the entire spectrum of paraphilias being embodied in a single individual is considered by Bloch to be the best proof of the existence of the development of paraphilias, since it would be untenable to assume that all sexual abnormalities were "congenital" in the same person.
What’s innate is the disposition or the aptitude, but only opportunity creates a paraphiletic. One would hardly think it possible -- how much wickedness, if that expression is permissible -- has been innate in the human child. Pedology gives us plenty of information about this; its representatives (e.g. O. Chrishman, the American) go so far as to describe children as a special kind of human-animal species. It would hardly be wrong to portray children as the first originators of paraphilias, or at least adults can still learn from children. One must keep Bloch's core thesis in mind: "The monstrosity of the act is by no means a criterion for its psychopathic origin"; Furthermore: “The fact that sick people have paraphilias must not lead one to the conclusion that paraphilia always has to be related to sickness, especially when one remembers the undoubted fact that healthy people can become so accustomed to sexual aberrations that they appear like paraphilias without affecting the mental health of the person in the slightest."
At the end of his work, Bloch considers “the sexual need for variation peculiar to the genus homo, which is to be understood as a physiological phenomenon and the increase of which to a hunger for sexual stimulus can produce the most severe paraphilias” as the final, definite cause of all paraphilias. This law forms the basis of every philosophy of sexual life. It clearly shows that prostitution, as a mere product of this need for sexual variety and as a substitute for the promiscuity that originally arose from the latter, is ineradicable if one does not find another way of satisfying this need for variation, which eliminates the dangers of prostitution and could still grant satisfaction to these tendencies that break through again and again.
Here the term "prostitution" is to be taken in a very narrow or conventional sense. On the average, the marriage that is customary among us is also just a kind of prostitution of the woman or the man or both at the same time. The institution of marriage, with its ineradicable mendacity, sufficiently provides for the need for variation. Prostitution and marriage aren’t opposed to each other, as prostitution is just a temporary marriage with short regrets, as opposed to permanent marriages with endless regrets. Of course there are also happy marriages, just as there are people who have supposedly won large sums of money in the lottery.
Bloch's work ends in an exhortation to moderation in matters of love. This comes off as moralizing which neither harms nor helps; it does not change anything about philia and paraphilia. Nor will the reader linger, but would rather go back to reread the work; for it offers so many valuable suggestions that it cannot be dealt with within the framework of one report. I empathetically wanted to draw the doctors' attention to an achievement whose study will open up broader perspectives for them, and I hope that in the not too distant future they will happily welcome collaboration with folklorists and ethnologists in order to advance science. The annual congress of natural scientists and physicians has already introduced its own section for ethnology, only the ethnologists do not register for lectures. It is not enough to declare the admission of ethnologists, as if ethnologists would vie for such an honor. They are not that ambitious and therefore keep their distance.
(1) Beiträge zur Aetiologie der Psychopathia sexualis. By Dr. med. Iwan Bloch, doctor for skin and sexual diseases in Berlin. With a preface by Prof. Dr. Albert Eulenburg in Berlin. First part, Dresden. H. R. Dohrn 1902. Second part, ibid. 1903.
(2) Der Ursprung der Syphilis. A medical and cultural-historical study by Dr. med. Iwan Bloch. First Part. Jena, Gustav Fischer 1901.
3) Die Ekstase by Prof. Dr. Thomas Achelis. I. B. the cultural problems of the present. Edited by Leo Berg, Berlin, Johannes Räde, 1902.

= References =

File:CL sun symbol.png

2024-04-24T23:38:37Z

Raccoondad:

Module:Documentation/i18n

2024-04-24T23:23:19Z

Raccoondad: 1 revision imported

local format = require('Module:TNT').format
local i18n = {}

i18n['cfg-error-msg-type'] = format('I18n/Documentation', 'cfg-error-msg-type')
i18n['cfg-error-msg-empty'] = format('I18n/Documentation', 'cfg-error-msg-empty')

-- cfg['template-namespace-heading']
-- The heading shown in the template namespace.
i18n['template-namespace-heading'] = format('I18n/Documentation', 'template-namespace-heading')

-- cfg['module-namespace-heading']
-- The heading shown in the module namespace.
i18n['module-namespace-heading'] = format('I18n/Documentation', 'module-namespace-heading')

-- cfg['file-namespace-heading']
-- The heading shown in the file namespace.
i18n['file-namespace-heading'] = format('I18n/Documentation', 'file-namespace-heading')

-- cfg['other-namespaces-heading']
-- The heading shown in other namespaces.
i18n['other-namespaces-heading'] = format('I18n/Documentation', 'other-namespaces-heading')

-- cfg['view-link-display']
-- The text to display for "view" links.
i18n['view-link-display'] = format('I18n/Documentation', 'view-link-display')

-- cfg['edit-link-display']
-- The text to display for "edit" links.
i18n['edit-link-display'] = format('I18n/Documentation', 'edit-link-display')

-- cfg['history-link-display']
-- The text to display for "history" links.
i18n['history-link-display'] = format('I18n/Documentation', 'history-link-display')

-- cfg['purge-link-display']
-- The text to display for "purge" links.
i18n['purge-link-display'] = format('I18n/Documentation', 'purge-link-display')

-- cfg['create-link-display']
-- The text to display for "create" links.
i18n['create-link-display'] = format('I18n/Documentation', 'create-link-display')

return i18n

Module:TNT

2024-04-24T23:23:18Z

Raccoondad: 1 revision imported

--
-- INTRO: (!!! DO NOT RENAME THIS PAGE !!!)
-- This module allows any template or module to be copy/pasted between
-- wikis without any translation changes. All translation text is stored
-- in the global Data:*.tab pages on Commons, and used everywhere.
--
-- SEE: https://www.mediawiki.org/wiki/Multilingual_Templates_and_Modules
--
-- ATTENTION:
-- Please do NOT rename this module - it has to be identical on all wikis.
-- This code is maintained at https://www.mediawiki.org/wiki/Module:TNT
-- Please do not modify it anywhere else, as it may get copied and override your changes.
-- Suggestions can be made at https://www.mediawiki.org/wiki/Module_talk:TNT
--
-- DESCRIPTION:
-- The "msg" function uses a Commons dataset to translate a message
-- with a given key (e.g. source-table), plus optional arguments
-- to the wiki markup in the current content language.
-- Use lang=xx to set language. Example:
--
-- {{#invoke:TNT | msg
-- | I18n/Template:Graphs.tab 
-- | source-table 
-- | param1 }} 
--
--
-- The "doc" function will generate the <templatedata> parameter documentation for templates.
-- This way all template parameters can be stored and localized in a single Commons dataset.
-- NOTE: "doc" assumes that all documentation is located in Data:Templatedata/* on Commons.
--
-- {{#invoke:TNT | doc | Graph:Lines }}
-- uses https://commons.wikimedia.org/wiki/Data:Templatedata/Graph:Lines.tab
-- if the current page is Template:Graph:Lines/doc
--

local p = {}
local i18nDataset = 'I18n/Module:TNT.tab'

-- Forward declaration of the local functions
local sanitizeDataset, loadData, link, formatMessage

function p.msg(frame)
local dataset, id
local params = {}
local lang = nil
for k, v in pairs(frame.args) do
if k == 1 then
dataset = mw.text.trim(v)
elseif k == 2 then
id = mw.text.trim(v)
elseif type(k) == 'number' then
params[k - 2] = mw.text.trim(v)
elseif k == 'lang' and v ~= '_' then
lang = mw.text.trim(v)
end
end
return formatMessage(dataset, id, params, lang)
end

-- Identical to p.msg() above, but used from other lua modules
-- Parameters: name of dataset, message key, optional arguments
-- Example with 2 params: format('I18n/Module:TNT', 'error_bad_msgkey', 'my-key', 'my-dataset')
function p.format(dataset, key, ...)
local checkType = require('libraryUtil').checkType
checkType('format', 1, dataset, 'string')
checkType('format', 2, key, 'string')
return formatMessage(dataset, key, {...})
end

-- Identical to p.msg() above, but used from other lua modules with the language param
-- Parameters: language code, name of dataset, message key, optional arguments
-- Example with 2 params: formatInLanguage('es', I18n/Module:TNT', 'error_bad_msgkey', 'my-key', 'my-dataset')
function p.formatInLanguage(lang, dataset, key, ...)
local checkType = require('libraryUtil').checkType
checkType('formatInLanguage', 1, lang, 'string')
checkType('formatInLanguage', 2, dataset, 'string')
checkType('formatInLanguage', 3, key, 'string')
return formatMessage(dataset, key, {...}, lang)
end

-- Obsolete function that adds a 'c:' prefix to the first param.
-- "Sandbox/Sample.tab" -> 'c:Data:Sandbox/Sample.tab'
function p.link(frame)
return link(frame.args[1])
end

function p.doc(frame)
local dataset = 'Templatedata/' .. sanitizeDataset(frame.args[1])
return frame:extensionTag('templatedata', p.getTemplateData(dataset)) ..
formatMessage(i18nDataset, 'edit_doc', {link(dataset)})
end

function p.getTemplateData(dataset)
-- TODO: add '_' parameter once lua starts reindexing properly for "all" languages
local data = loadData(dataset)
local names = {}
for _, field in ipairs(data.schema.fields) do
table.insert(names, field.name)
end

local numOnly = true
local params = {}
local paramOrder = {}
for _, row in ipairs(data.data) do
local newVal = {}
local name = nil
for pos, columnName in ipairs(names) do
if columnName == 'name' then
name = row[pos]
else
newVal[columnName] = row[pos]
end
end
if name then
if (
(type(name) ~= "number")
and (
(type(name) ~= "string")
or not string.match(name, "^%d+$")
)
) then
numOnly = false
end
params[name] = newVal
table.insert(paramOrder, name)
end
end

-- Work around json encoding treating {"1":{...}} as an [{...}]
if numOnly then
params['zzz123']=''
end

local json = mw.text.jsonEncode({
params=params,
paramOrder=paramOrder,
description=data.description,
})

if numOnly then
json = string.gsub(json,'"zzz123":"",?', "")
end

return json
end

-- Local functions

sanitizeDataset = function(dataset)
if not dataset then
return nil
end
dataset = mw.text.trim(dataset)
if dataset == '' then
return nil
elseif string.sub(dataset,-4) ~= '.tab' then
return dataset .. '.tab'
else
return dataset
end
end

loadData = function(dataset, lang)
dataset = sanitizeDataset(dataset)
if not dataset then
error(formatMessage(i18nDataset, 'error_no_dataset', {}))
end

-- Give helpful error to thirdparties who try and copy this module.
if not mw.ext or not mw.ext.data or not mw.ext.data.get then
error(string.format([['''Missing JsonConfig extension, or not properly configured;
Cannot load https://commons.wikimedia.org/wiki/Data:%s.
See https://www.mediawiki.org/wiki/Extension:JsonConfig#Supporting_Wikimedia_templates''']], dataset))
end

local data = mw.ext.data.get(dataset, lang)

if data == false then
if dataset == i18nDataset then
-- Prevent cyclical calls
error('Missing Commons dataset ' .. i18nDataset)
else
error(formatMessage(i18nDataset, 'error_bad_dataset', {link(dataset)}))
end
end
return data
end

-- Given a dataset name, convert it to a title with the 'commons:data:' prefix
link = function(dataset)
return 'c:Data:' .. mw.text.trim(dataset or '')
end

formatMessage = function(dataset, key, params, lang)
for _, row in pairs(loadData(dataset, lang).data) do
local id, msg = unpack(row)
if id == key then
local result = mw.message.newRawMessage(msg, unpack(params or {}))
return result:plain()
end
end
if dataset == i18nDataset then
-- Prevent cyclical calls
error('Invalid message key "' .. key .. '"')
else
error(formatMessage(i18nDataset, 'error_bad_msgkey', {key, link(dataset)}))
end
end

return p

Module:Documentation/config

2024-04-24T23:23:17Z

Raccoondad: 1 revision imported

----------------------------------------------------------------------------------------------------
--
-- Configuration for Module:Documentation
--
-- Here you can set the values of the parameters and messages used in Module:Documentation to
-- localise it to your wiki and your language. Unless specified otherwise, values given here
-- should be string values.
----------------------------------------------------------------------------------------------------

local _format = require('Module:TNT').format
local function format(id)
return _format('I18n/Documentation', id)
end

local cfg = {} -- Do not edit this line.

cfg['templatestyles-scr'] = 'Module:Documentation/styles.css'

----------------------------------------------------------------------------------------------------
-- Protection template configuration
----------------------------------------------------------------------------------------------------

-- cfg['protection-template']
-- The name of the template that displays the protection icon (a padlock on enwiki).
cfg['protection-template'] = 'pp-template'

-- cfg['protection-reason-edit']
-- The protection reason for edit-protected templates to pass to
-- [[Module:Protection banner]].
cfg['protection-reason-edit'] = 'template'

--[[
-- cfg['protection-template-args']
-- Any arguments to send to the protection template. This should be a Lua table.
-- For example, if the protection template is "pp-template", and the wikitext template invocation
-- looks like "{{pp-template|docusage=yes}}", then this table should look like "{docusage = 'yes'}".
--]]
cfg['protection-template-args'] = {docusage = 'yes'}

--[[
----------------------------------------------------------------------------------------------------
-- Sandbox notice configuration
--
-- On sandbox pages the module can display a template notifying users that the current page is a
-- sandbox, and the location of test cases pages, etc. The module decides whether the page is a
-- sandbox or not based on the value of cfg['sandbox-subpage']. The following settings configure the
-- messages that the notices contains.
----------------------------------------------------------------------------------------------------
--]]

-- cfg['sandbox-notice-image']
-- The image displayed in the sandbox notice.
cfg['sandbox-notice-image'] = '[[File:Edit In Sandbox Icon - Color.svg|40px|alt=|link=]]'

--[[
-- cfg['sandbox-notice-pagetype-template']
-- cfg['sandbox-notice-pagetype-module']
-- cfg['sandbox-notice-pagetype-other']
-- The page type of the sandbox page. The message that is displayed depends on the current subject
-- namespace. This message is used in either cfg['sandbox-notice-blurb'] or
-- cfg['sandbox-notice-diff-blurb'].
--]]
cfg['sandbox-notice-pagetype-template'] = format('sandbox-notice-pagetype-template')
cfg['sandbox-notice-pagetype-module'] = format('sandbox-notice-pagetype-module')
cfg['sandbox-notice-pagetype-other'] = format('sandbox-notice-pagetype-other')

--[[
-- cfg['sandbox-notice-blurb']
-- cfg['sandbox-notice-diff-blurb']
-- cfg['sandbox-notice-diff-display']
-- Either cfg['sandbox-notice-blurb'] or cfg['sandbox-notice-diff-blurb'] is the opening sentence
-- of the sandbox notice. The latter has a diff link, but the former does not. $1 is the page
-- type, which is either cfg['sandbox-notice-pagetype-template'],
-- cfg['sandbox-notice-pagetype-module'] or cfg['sandbox-notice-pagetype-other'] depending what
-- namespace we are in. $2 is a link to the main template page, and $3 is a diff link between
-- the sandbox and the main template. The display value of the diff link is set by
-- cfg['sandbox-notice-compare-link-display'].
--]]
cfg['sandbox-notice-blurb'] = format('sandbox-notice-blurb')
cfg['sandbox-notice-diff-blurb'] = format('sandbox-notice-diff-blurb')
cfg['sandbox-notice-compare-link-display'] = format('sandbox-notice-compare-link-display')

--[[
-- cfg['sandbox-notice-testcases-blurb']
-- cfg['sandbox-notice-testcases-link-display']
-- cfg['sandbox-notice-testcases-run-blurb']
-- cfg['sandbox-notice-testcases-run-link-display']
-- cfg['sandbox-notice-testcases-blurb'] is a sentence notifying the user that there is a test cases page
-- corresponding to this sandbox that they can edit. $1 is a link to the test cases page.
-- cfg['sandbox-notice-testcases-link-display'] is the display value for that link.
-- cfg['sandbox-notice-testcases-run-blurb'] is a sentence notifying the user that there is a test cases page
-- corresponding to this sandbox that they can edit, along with a link to run it. $1 is a link to the test
-- cases page, and $2 is a link to the page to run it.
-- cfg['sandbox-notice-testcases-run-link-display'] is the display value for the link to run the test
-- cases.
--]]
cfg['sandbox-notice-testcases-blurb'] = format('sandbox-notice-testcases-blurb')
cfg['sandbox-notice-testcases-link-display'] = format('sandbox-notice-testcases-link-display')
cfg['sandbox-notice-testcases-run-blurb'] = format('sandbox-notice-testcases-run-blurb')
cfg['sandbox-notice-testcases-run-link-display'] = format('sandbox-notice-testcases-run-link-display')

-- cfg['sandbox-category']
-- A category to add to all template sandboxes.
cfg['sandbox-category'] = 'Template sandboxes'

----------------------------------------------------------------------------------------------------
-- Start box configuration
----------------------------------------------------------------------------------------------------

-- cfg['documentation-icon-wikitext']
-- The wikitext for the icon shown at the top of the template.
cfg['documentation-icon-wikitext'] = '[[File:Test Template Info-Icon - Version (2).svg|50px|link=|alt=Documentation icon]]'

----------------------------------------------------------------------------------------------------
-- Link box (end box) configuration
----------------------------------------------------------------------------------------------------

-- cfg['transcluded-from-blurb']
-- Notice displayed when the docs are transcluded from another page. $1 is a wikilink to that page.
cfg['transcluded-from-blurb'] = format('transcluded-from-blurb')

--[[
-- cfg['create-module-doc-blurb']
-- Notice displayed in the module namespace when the documentation subpage does not exist.
-- $1 is a link to create the documentation page with the preload cfg['module-preload'] and the
-- display cfg['create-link-display'].
--]]
cfg['create-module-doc-blurb'] = format('create-module-doc-blurb')

----------------------------------------------------------------------------------------------------
-- Experiment blurb configuration
----------------------------------------------------------------------------------------------------

--[[
-- cfg['experiment-blurb-template']
-- cfg['experiment-blurb-module']
-- The experiment blurb is the text inviting editors to experiment in sandbox and test cases pages.
-- It is only shown in the template and module namespaces. With the default English settings, it
-- might look like this:
--
-- Editors can experiment in this template's sandbox (edit | diff) and testcases (edit) pages.
--
-- In this example, "sandbox", "edit", "diff", "testcases", and "edit" would all be links.
--
-- There are two versions, cfg['experiment-blurb-template'] and cfg['experiment-blurb-module'], depending
-- on what namespace we are in.
--
-- Parameters:
--
-- $1 is a link to the sandbox page. If the sandbox exists, it is in the following format:
--
-- cfg['sandbox-link-display'] (cfg['sandbox-edit-link-display'] | cfg['compare-link-display'])
--
-- If the sandbox doesn't exist, it is in the format:
--
-- cfg['sandbox-link-display'] (cfg['sandbox-create-link-display'] | cfg['mirror-link-display'])
--
-- The link for cfg['sandbox-create-link-display'] link preloads the page with cfg['template-sandbox-preload']
-- or cfg['module-sandbox-preload'], depending on the current namespace. The link for cfg['mirror-link-display']
-- loads a default edit summary of cfg['mirror-edit-summary'].
--
-- $2 is a link to the test cases page. If the test cases page exists, it is in the following format:
--
-- cfg['testcases-link-display'] (cfg['testcases-edit-link-display'])
--
-- If the test cases page doesn't exist, it is in the format:
--
-- cfg['testcases-link-display'] (cfg['testcases-create-link-display'])
--
-- If the test cases page doesn't exist, the link for cfg['testcases-create-link-display'] preloads the
-- page with cfg['template-testcases-preload'] or cfg['module-testcases-preload'], depending on the current
-- namespace.
--]]
cfg['experiment-blurb-template'] = format('experiment-blurb-template')
cfg['experiment-blurb-module'] = format('experiment-blurb-module')

----------------------------------------------------------------------------------------------------
-- Sandbox link configuration
----------------------------------------------------------------------------------------------------

-- cfg['sandbox-subpage']
-- The name of the template subpage typically used for sandboxes.
cfg['sandbox-subpage'] = 'sandbox'

-- cfg['template-sandbox-preload']
-- Preload file for template sandbox pages.
cfg['template-sandbox-preload'] = 'Template:Documentation/preload-sandbox'

-- cfg['module-sandbox-preload']
-- Preload file for Lua module sandbox pages.
cfg['module-sandbox-preload'] = 'Template:Documentation/preload-module-sandbox'

-- cfg['sandbox-link-display']
-- The text to display for "sandbox" links.
cfg['sandbox-link-display'] = format('sandbox-link-display')

-- cfg['sandbox-edit-link-display']
-- The text to display for sandbox "edit" links.
cfg['sandbox-edit-link-display'] = format('sandbox-edit-link-display')

-- cfg['sandbox-create-link-display']
-- The text to display for sandbox "create" links.
cfg['sandbox-create-link-display'] = format('sandbox-create-link-display')

-- cfg['compare-link-display']
-- The text to display for "compare" links.
cfg['compare-link-display'] = format('compare-link-display')

-- cfg['mirror-edit-summary']
-- The default edit summary to use when a user clicks the "mirror" link. $1 is a wikilink to the
-- template page.
cfg['mirror-edit-summary'] = 'Create sandbox version of $1'

-- cfg['mirror-link-display']
-- The text to display for "mirror" links.
cfg['mirror-link-display'] = format('mirror-link-display')

-- cfg['mirror-link-preload']
-- The page to preload when a user clicks the "mirror" link.
cfg['mirror-link-preload'] = 'Template:Documentation/mirror'

----------------------------------------------------------------------------------------------------
-- Test cases link configuration
----------------------------------------------------------------------------------------------------

-- cfg['testcases-subpage']
-- The name of the template subpage typically used for test cases.
cfg['testcases-subpage'] = 'testcases'

-- cfg['template-testcases-preload']
-- Preload file for template test cases pages.
cfg['template-testcases-preload'] = 'Template:Documentation/preload-testcases'

-- cfg['module-testcases-preload']
-- Preload file for Lua module test cases pages.
cfg['module-testcases-preload'] = 'Template:Documentation/preload-module-testcases'

-- cfg['testcases-link-display']
-- The text to display for "testcases" links.
cfg['testcases-link-display'] = format('testcases-link-display')

-- cfg['testcases-edit-link-display']
-- The text to display for test cases "edit" links.
cfg['testcases-edit-link-display'] = format('testcases-edit-link-display')

-- cfg['testcases-create-link-display']
-- The text to display for test cases "create" links.
cfg['testcases-create-link-display'] = format('testcases-create-link-display')

----------------------------------------------------------------------------------------------------
-- Add categories blurb configuration
----------------------------------------------------------------------------------------------------

--[[
-- cfg['add-categories-blurb']
-- Text to direct users to add categories to the /doc subpage. Not used if the "content" or
-- "docname fed" arguments are set, as then it is not clear where to add the categories. $1 is a
-- link to the /doc subpage with a display value of cfg['doc-link-display'].
--]]
cfg['add-categories-blurb'] = format('add-categories-blurb')

-- cfg['doc-link-display']
-- The text to display when linking to the /doc subpage.
cfg['doc-link-display'] = '/doc'

----------------------------------------------------------------------------------------------------
-- Subpages link configuration
----------------------------------------------------------------------------------------------------

--[[
-- cfg['subpages-blurb']
-- The "Subpages of this template" blurb. $1 is a link to the main template's subpages with a
-- display value of cfg['subpages-link-display']. In the English version this blurb is simply
-- the link followed by a period, and the link display provides the actual text.
--]]
cfg['subpages-blurb'] = format('subpages-blurb')

--[[
-- cfg['subpages-link-display']
-- The text to display for the "subpages of this page" link. $1 is cfg['template-pagetype'],
-- cfg['module-pagetype'] or cfg['default-pagetype'], depending on whether the current page is in
-- the template namespace, the module namespace, or another namespace.
--]]
cfg['subpages-link-display'] = format('subpages-link-display')

-- cfg['template-pagetype']
-- The pagetype to display for template pages.
cfg['template-pagetype'] = format('template-pagetype')

-- cfg['module-pagetype']
-- The pagetype to display for Lua module pages.
cfg['module-pagetype'] = format('module-pagetype')

-- cfg['default-pagetype']
-- The pagetype to display for pages other than templates or Lua modules.
cfg['default-pagetype'] = format('default-pagetype')

----------------------------------------------------------------------------------------------------
-- Doc link configuration
----------------------------------------------------------------------------------------------------

-- cfg['doc-subpage']
-- The name of the subpage typically used for documentation pages.
cfg['doc-subpage'] = 'doc'

-- cfg['file-docpage-preload']
-- Preload file for documentation page in the file namespace.
cfg['file-docpage-preload'] = 'Template:Documentation/preload-filespace'

-- cfg['docpage-preload']
-- Preload file for template documentation pages in all namespaces.
cfg['docpage-preload'] = 'Template:Documentation/preload'

-- cfg['module-preload']
-- Preload file for Lua module documentation pages.
cfg['module-preload'] = 'Template:Documentation/preload-module-doc'

----------------------------------------------------------------------------------------------------
-- Print version configuration
----------------------------------------------------------------------------------------------------

-- cfg['print-subpage']
-- The name of the template subpage used for print versions.
cfg['print-subpage'] = 'Print'

-- cfg['print-link-display']
-- The text to display when linking to the /Print subpage.
cfg['print-link-display'] = '/Print'

-- cfg['print-blurb']
-- Text to display if a /Print subpage exists. $1 is a link to the subpage with a display value of cfg['print-link-display'].
cfg['print-blurb'] = format('print-blurb')

-- cfg['display-print-category']
-- Set to true to enable output of cfg['print-category'] if a /Print subpage exists.
-- This should be a boolean value (either true or false).
cfg['display-print-category'] = true

-- cfg['print-category']
-- Category to output if cfg['display-print-category'] is set to true, and a /Print subpage exists.
cfg['print-category'] = 'Templates with print versions'

----------------------------------------------------------------------------------------------------
-- HTML and CSS configuration
----------------------------------------------------------------------------------------------------

-- cfg['main-div-id']
-- The "id" attribute of the main HTML "div" tag.
cfg['main-div-id'] = 'template-documentation'

-- cfg['main-div-classes']
-- The CSS classes added to the main HTML "div" tag.
cfg['main-div-class'] = 'ts-doc-doc'
cfg['header-div-class'] = 'ts-doc-header'
cfg['heading-div-class'] = 'ts-doc-heading'
cfg['content-div-class'] = 'ts-doc-content'
cfg['footer-div-class'] = 'ts-doc-footer plainlinks'

cfg['sandbox-class'] = 'ts-doc-sandbox'

-- cfg['start-box-linkclasses']
-- The CSS classes used for the [view][edit][history] or [create] links in the start box.
cfg['start-box-linkclasses'] = 'ts-tlinks-tlinks mw-editsection-like plainlinks'

-- cfg['start-box-link-id']
-- The HTML "id" attribute for the links in the start box.
cfg['start-box-link-id'] = 'doc_editlinks'

----------------------------------------------------------------------------------------------------
-- Tracking category configuration
----------------------------------------------------------------------------------------------------

-- cfg['display-strange-usage-category']
-- Set to true to enable output of cfg['strange-usage-category'] if the module is used on a /doc subpage
-- or a /testcases subpage. This should be a boolean value (either true or false).
cfg['display-strange-usage-category'] = false

-- cfg['strange-usage-category']
-- Category to output if cfg['display-strange-usage-category'] is set to true and the module is used on a
-- /doc subpage or a /testcases subpage.
cfg['strange-usage-category'] = 'Pages with strange ((documentation)) usage'

--[[
----------------------------------------------------------------------------------------------------
-- End configuration
--
-- Don't edit anything below this line.
----------------------------------------------------------------------------------------------------
--]]

return cfg

Module:Documentation

2024-04-24T23:23:17Z

Raccoondad: 1 revision imported

-- This module implements {{documentation}}.

-- Get required modules.
local getArgs = require('Module:Arguments').getArgs
local messageBox = require('Module:Message box')

-- Get the config table.
local cfg = mw.loadData('Module:Documentation/config')
local i18n = mw.loadData('Module:Documentation/i18n')
local p = {}

-- Often-used functions.
local ugsub = mw.ustring.gsub

----------------------------------------------------------------------------
-- Helper functions
--
-- These are defined as local functions, but are made available in the p
-- table for testing purposes.
----------------------------------------------------------------------------

local function message(cfgKey, valArray, expectType)
--[[
-- Gets a message from the cfg table and formats it if appropriate.
-- The function raises an error if the value from the cfg table is not
-- of the type expectType. The default type for expectType is 'string'.
-- If the table valArray is present, strings such as $1, $2 etc. in the
-- message are substituted with values from the table keys [1], [2] etc.
-- For example, if the message "foo-message" had the value 'Foo $2 bar $1.',
-- message('foo-message', {'baz', 'qux'}) would return "Foo qux bar baz."
--]]
local msg = cfg[cfgKey]
expectType = expectType or 'string'
if type(msg) ~= expectType then
error(require('Module:TNT').format('I18n/Documentation', 'cfg-error-msg-type', cfgKey, expectType, type(msg)), 2)
end
if not valArray then
return msg
end

local function getMessageVal(match)
match = tonumber(match)
return valArray[match] or error(require('Module:TNT').format('I18n/Documentation', 'cfg-error-msg-empty', '$' .. match, cfgKey), 4)
end

local ret = ugsub(msg, '$([1-9][0-9]*)', getMessageVal)
return ret
end

p.message = message

local function makeWikilink(page, display)
if display then
return mw.ustring.format('[[%s|%s]]', page, display)
else
return mw.ustring.format('[[%s]]', page)
end
end

p.makeWikilink = makeWikilink

local function makeCategoryLink(cat, sort)
local catns = mw.site.namespaces[14].name
return makeWikilink(catns .. ':' .. cat, sort)
end

p.makeCategoryLink = makeCategoryLink

local function makeUrlLink(url, display)
return mw.ustring.format('[%s %s]', url, display)
end

p.makeUrlLink = makeUrlLink

local function makeToolbar(...)
local ret = {}
local lim = select('#', ...)
if lim < 1 then
return nil
end
for i = 1, lim do
ret[#ret + 1] = select(i, ...)
end
return '(' .. table.concat(ret, ' | ') .. ')'
end

p.makeToolbar = makeToolbar

----------------------------------------------------------------------------
-- Argument processing
----------------------------------------------------------------------------

local function makeInvokeFunc(funcName)
return function (frame)
local args = getArgs(frame, {
valueFunc = function (key, value)
if type(value) == 'string' then
value = value:match('^%s*(.-)%s*$') -- Remove whitespace.
if key == 'heading' or value ~= '' then
return value
else
return nil
end
else
return value
end
end
})
return p[funcName](args)
end
end

----------------------------------------------------------------------------
-- Load TemplateStyles
----------------------------------------------------------------------------

p.main = function(frame)
local parent = frame.getParent(frame)
local output = p._main(parent.args)
return frame:extensionTag{ name='templatestyles', args = { src= message('templatestyles-scr') } } .. output
end

----------------------------------------------------------------------------
-- Main function
----------------------------------------------------------------------------

function p._main(args)
--[[
-- This function defines logic flow for the module.
-- @args - table of arguments passed by the user
--
-- Messages:
-- 'main-div-id' --> 'template-documentation'
-- 'main-div-classes' --> 'template-documentation iezoomfix'
--]]
local env = p.getEnvironment(args)
local root = mw.html.create()
root
:wikitext(p._getModuleWikitext(args, env))
:wikitext(p.protectionTemplate(env))
:wikitext(p.sandboxNotice(args, env))
-- This div tag is from {{documentation/start box}}, but moving it here
-- so that we don't have to worry about unclosed tags.
:tag('div')
:attr('id', message('main-div-id'))
:addClass(message('main-div-class'))
:wikitext(p._startBox(args, env))
:wikitext(p._content(args, env))
:done()
:wikitext(p._endBox(args, env))
:wikitext(p.addTrackingCategories(env))
return tostring(root)
end

----------------------------------------------------------------------------
-- Environment settings
----------------------------------------------------------------------------

function p.getEnvironment(args)
--[[
-- Returns a table with information about the environment, including title objects and other namespace- or
-- path-related data.
-- @args - table of arguments passed by the user
--
-- Title objects include:
-- env.title - the page we are making documentation for (usually the current title)
-- env.templateTitle - the template (or module, file, etc.)
-- env.docTitle - the /doc subpage.
-- env.sandboxTitle - the /sandbox subpage.
-- env.testcasesTitle - the /testcases subpage.
-- env.printTitle - the print version of the template, located at the /Print subpage.
--
-- Data includes:
-- env.protectionLevels - the protection levels table of the title object.
-- env.subjectSpace - the number of the title's subject namespace.
-- env.docSpace - the number of the namespace the title puts its documentation in.
-- env.docpageBase - the text of the base page of the /doc, /sandbox and /testcases pages, with namespace.
-- env.compareUrl - URL of the Special:ComparePages page comparing the sandbox with the template.
--
-- All table lookups are passed through pcall so that errors are caught. If an error occurs, the value
-- returned will be nil.
--]]

local env, envFuncs = {}, {}

-- Set up the metatable. If triggered we call the corresponding function in the envFuncs table. The value
-- returned by that function is memoized in the env table so that we don't call any of the functions
-- more than once. (Nils won't be memoized.)
setmetatable(env, {
__index = function (t, key)
local envFunc = envFuncs[key]
if envFunc then
local success, val = pcall(envFunc)
if success then
env[key] = val -- Memoise the value.
return val
end
end
return nil
end
})

function envFuncs.title()
-- The title object for the current page, or a test page passed with args.page.
local title
local titleArg = args.page
if titleArg then
title = mw.title.new(titleArg)
else
title = mw.title.getCurrentTitle()
end
return title
end

function envFuncs.templateTitle()
--[[
-- The template (or module, etc.) title object.
-- Messages:
-- 'sandbox-subpage' --> 'sandbox'
-- 'testcases-subpage' --> 'testcases'
--]]
local subjectSpace = env.subjectSpace
local title = env.title
local subpage = title.subpageText
if subpage == message('sandbox-subpage') or subpage == message('testcases-subpage') then
return mw.title.makeTitle(subjectSpace, title.baseText)
else
return mw.title.makeTitle(subjectSpace, title.text)
end
end

function envFuncs.docTitle()
--[[
-- Title object of the /doc subpage.
-- Messages:
-- 'doc-subpage' --> 'doc'
--]]
local title = env.title
local docname = args[1] -- User-specified doc page.
local docpage
if docname then
docpage = docname
else
docpage = env.docpageBase .. '/' .. message('doc-subpage')
end
return mw.title.new(docpage)
end

function envFuncs.sandboxTitle()
--[[
-- Title object for the /sandbox subpage.
-- Messages:
-- 'sandbox-subpage' --> 'sandbox'
--]]
return mw.title.new(env.docpageBase .. '/' .. message('sandbox-subpage'))
end

function envFuncs.testcasesTitle()
--[[
-- Title object for the /testcases subpage.
-- Messages:
-- 'testcases-subpage' --> 'testcases'
--]]
return mw.title.new(env.docpageBase .. '/' .. message('testcases-subpage'))
end

function envFuncs.printTitle()
--[[
-- Title object for the /Print subpage.
-- Messages:
-- 'print-subpage' --> 'Print'
--]]
return env.templateTitle:subPageTitle(message('print-subpage'))
end

function envFuncs.protectionLevels()
-- The protection levels table of the title object.
return env.title.protectionLevels
end

function envFuncs.subjectSpace()
-- The subject namespace number.
return mw.site.namespaces[env.title.namespace].subject.id
end

function envFuncs.docSpace()
-- The documentation namespace number. For most namespaces this is the same as the
-- subject namespace. However, pages in the Article, File, MediaWiki or Category
-- namespaces must have their /doc, /sandbox and /testcases pages in talk space.
local subjectSpace = env.subjectSpace
if subjectSpace == 0 or subjectSpace == 6 or subjectSpace == 8 or subjectSpace == 14 then
return subjectSpace + 1
else
return subjectSpace
end
end

function envFuncs.docpageBase()
-- The base page of the /doc, /sandbox, and /testcases subpages.
-- For some namespaces this is the talk page, rather than the template page.
local templateTitle = env.templateTitle
local docSpace = env.docSpace
local docSpaceText = mw.site.namespaces[docSpace].name
-- Assemble the link. docSpace is never the main namespace, so we can hardcode the colon.
return docSpaceText .. ':' .. templateTitle.text
end

function envFuncs.compareUrl()
-- Diff link between the sandbox and the main template using [[Special:ComparePages]].
local templateTitle = env.templateTitle
local sandboxTitle = env.sandboxTitle
if templateTitle.exists and sandboxTitle.exists then
local compareUrl = mw.uri.fullUrl(
'Special:ComparePages',
{page1 = templateTitle.prefixedText, page2 = sandboxTitle.prefixedText}
)
return tostring(compareUrl)
else
return nil
end
end

return env
end

----------------------------------------------------------------------------
-- Auxiliary templates
----------------------------------------------------------------------------

p.getModuleWikitext = makeInvokeFunc('_getModuleWikitext')

function p._getModuleWikitext(args, env)
local currentTitle = mw.title.getCurrentTitle()
if currentTitle.contentModel ~= 'Scribunto' then return end
pcall(require, currentTitle.prefixedText) -- if it fails, we don't care
local moduleWikitext = package.loaded["Module:Module wikitext"]
if moduleWikitext then
return moduleWikitext.main()
end
end

function p.sandboxNotice(args, env)
--[=[
-- Generates a sandbox notice for display above sandbox pages.
-- @args - a table of arguments passed by the user
-- @env - environment table containing title objects, etc., generated with p.getEnvironment
--
-- Messages:
-- 'sandbox-notice-image' --> '[[Image:Sandbox.svg|50px|alt=|link=]]'
-- 'sandbox-notice-blurb' --> 'This is the $1 for $2.'
-- 'sandbox-notice-diff-blurb' --> 'This is the $1 for $2 ($3).'
-- 'sandbox-notice-pagetype-template' --> '[[w:Wikipedia:Template test cases|template sandbox]] page'
-- 'sandbox-notice-pagetype-module' --> '[[w:Wikipedia:Template test cases|module sandbox]] page'
-- 'sandbox-notice-pagetype-other' --> 'sandbox page'
-- 'sandbox-notice-compare-link-display' --> 'diff'
-- 'sandbox-notice-testcases-blurb' --> 'See also the companion subpage for $1.'
-- 'sandbox-notice-testcases-link-display' --> 'test cases'
-- 'sandbox-category' --> 'Template sandboxes'
--]=]
local title = env.title
local sandboxTitle = env.sandboxTitle
local templateTitle = env.templateTitle
local subjectSpace = env.subjectSpace
if not (subjectSpace and title and sandboxTitle and templateTitle and mw.title.equals(title, sandboxTitle)) then
return nil
end
-- Build the table of arguments to pass to {{ombox}}. We need just two fields, "image" and "text".
local omargs = {}
omargs.image = message('sandbox-notice-image')
-- Get the text. We start with the opening blurb, which is something like
-- "This is the template sandbox for [[Template:Foo]] (diff)."
local text = ''
local frame = mw.getCurrentFrame()
local isPreviewing = frame:preprocess('{{REVISIONID}}') == '' -- True if the page is being previewed.
local pagetype
if subjectSpace == 10 then
pagetype = message('sandbox-notice-pagetype-template')
elseif subjectSpace == 828 then
pagetype = message('sandbox-notice-pagetype-module')
else
pagetype = message('sandbox-notice-pagetype-other')
end
local templateLink = makeWikilink(templateTitle.prefixedText)
local compareUrl = env.compareUrl
if isPreviewing or not compareUrl then
text = text .. message('sandbox-notice-blurb', {pagetype, templateLink})
else
local compareDisplay = message('sandbox-notice-compare-link-display')
local compareLink = makeUrlLink(compareUrl, compareDisplay)
text = text .. message('sandbox-notice-diff-blurb', {pagetype, templateLink, compareLink})
end
-- Get the test cases page blurb if the page exists. This is something like
-- "See also the companion subpage for [[Template:Foo/testcases|test cases]]."
local testcasesTitle = env.testcasesTitle
if testcasesTitle and testcasesTitle.exists then
if testcasesTitle.contentModel == "Scribunto" then
local testcasesLinkDisplay = message('sandbox-notice-testcases-link-display')
local testcasesRunLinkDisplay = message('sandbox-notice-testcases-run-link-display')
local testcasesLink = makeWikilink(testcasesTitle.prefixedText, testcasesLinkDisplay)
local testcasesRunLink = makeWikilink(testcasesTitle.talkPageTitle.prefixedText, testcasesRunLinkDisplay)
text = text .. ' ' .. message('sandbox-notice-testcases-run-blurb', {testcasesLink, testcasesRunLink})
else
local testcasesLinkDisplay = message('sandbox-notice-testcases-link-display')
local testcasesLink = makeWikilink(testcasesTitle.prefixedText, testcasesLinkDisplay)
text = text .. ' ' .. message('sandbox-notice-testcases-blurb', {testcasesLink})
end
end
-- Add the sandbox to the sandbox category.
text = text .. makeCategoryLink(message('sandbox-category'))
omargs.text = text
omargs.class = message('sandbox-class')
local ret = '<div style="clear: both;"></div>'
ret = ret .. messageBox.main('ombox', omargs)
return ret
end

function p.protectionTemplate(env)
-- Generates the padlock icon in the top right.
-- @env - environment table containing title objects, etc., generated with p.getEnvironment
-- Messages:
-- 'protection-template' --> 'pp-template'
-- 'protection-template-args' --> {docusage = 'yes'}
local title = env.title
local protectionLevels
local protectionTemplate = message('protection-template')
local namespace = title.namespace
if not (protectionTemplate and (namespace == 10 or namespace == 828)) then
-- Don't display the protection template if we are not in the template or module namespaces.
return nil
end
protectionLevels = env.protectionLevels
if not protectionLevels then
return nil
end
local editLevels = protectionLevels.edit
local moveLevels = protectionLevels.move
if moveLevels and moveLevels[1] == 'sysop' or editLevels and editLevels[1] then
-- The page is full-move protected, or full, template, or semi-protected.
local frame = mw.getCurrentFrame()
return frame:expandTemplate{title = protectionTemplate, args = message('protection-template-args', nil, 'table')}
else
return nil
end
end

----------------------------------------------------------------------------
-- Start box
----------------------------------------------------------------------------

p.startBox = makeInvokeFunc('_startBox')

function p._startBox(args, env)
--[[
-- This function generates the start box.
-- @args - a table of arguments passed by the user
-- @env - environment table containing title objects, etc., generated with p.getEnvironment
--
-- The actual work is done by p.makeStartBoxLinksData and p.renderStartBoxLinks which make
-- the [view] [edit] [history] [purge] links, and by p.makeStartBoxData and p.renderStartBox
-- which generate the box HTML.
--]]
env = env or p.getEnvironment(args)
local links
local content = args.content
if not content then
-- No need to include the links if the documentation is on the template page itself.
local linksData = p.makeStartBoxLinksData(args, env)
if linksData then
links = p.renderStartBoxLinks(linksData)
end
end
-- Generate the start box html.
local data = p.makeStartBoxData(args, env, links)
if data then
return p.renderStartBox(data)
else
-- User specified no heading.
return nil
end
end

function p.makeStartBoxLinksData(args, env)
--[[
-- Does initial processing of data to make the [view] [edit] [history] [purge] links.
-- @args - a table of arguments passed by the user
-- @env - environment table containing title objects, etc., generated with p.getEnvironment
--
-- Messages:
-- 'view-link-display' --> 'view'
-- 'edit-link-display' --> 'edit'
-- 'history-link-display' --> 'history'
-- 'purge-link-display' --> 'purge'
-- 'file-docpage-preload' --> 'Template:Documentation/preload-filespace'
-- 'module-preload' --> 'Template:Documentation/preload-module-doc'
-- 'docpage-preload' --> 'Template:Documentation/preload'
-- 'create-link-display' --> 'create'
--]]
local subjectSpace = env.subjectSpace
local title = env.title
local docTitle = env.docTitle
if not title or not docTitle then
return nil
end
if docTitle.isRedirect then
docTitle = docTitle.redirectTarget
end

local data = {}
data.title = title
data.docTitle = docTitle
-- View, display, edit, and purge links if /doc exists.
data.viewLinkDisplay = i18n['view-link-display']
data.editLinkDisplay = i18n['edit-link-display']
data.historyLinkDisplay = i18n['history-link-display']
data.purgeLinkDisplay = i18n['purge-link-display']
-- Create link if /doc doesn't exist.
local preload = args.preload
if not preload then
if subjectSpace == 6 then -- File namespace
preload = message('file-docpage-preload')
elseif subjectSpace == 828 then -- Module namespace
preload = message('module-preload')
else
preload = message('docpage-preload')
end
end
data.preload = preload
data.createLinkDisplay = i18n['create-link-display']
return data
end

function p.renderStartBoxLinks(data)
--[[
-- Generates the [view][edit][history][purge] or [create] links from the data table.
-- @data - a table of data generated by p.makeStartBoxLinksData
--]]

local function escapeBrackets(s)
-- Escapes square brackets with HTML entities.
s = s:gsub('%[', '[') -- Replace square brackets with HTML entities.
s = s:gsub('%]', ']')
return s
end

local ret
local docTitle = data.docTitle
local title = data.title
if docTitle.exists then
local viewLink = makeWikilink(docTitle.prefixedText, data.viewLinkDisplay)
local editLink = makeUrlLink(docTitle:fullUrl{action = 'edit'}, data.editLinkDisplay)
local historyLink = makeUrlLink(docTitle:fullUrl{action = 'history'}, data.historyLinkDisplay)
local purgeLink = makeUrlLink(title:fullUrl{action = 'purge'}, data.purgeLinkDisplay)
ret = '[%s] [%s] [%s] [%s]'
ret = escapeBrackets(ret)
ret = mw.ustring.format(ret, viewLink, editLink, historyLink, purgeLink)
else
local createLink = makeUrlLink(docTitle:fullUrl{action = 'edit', preload = data.preload}, data.createLinkDisplay)
ret = '[%s]'
ret = escapeBrackets(ret)
ret = mw.ustring.format(ret, createLink)
end
return ret
end

function p.makeStartBoxData(args, env, links)
--[=[
-- Does initial processing of data to pass to the start-box render function, p.renderStartBox.
-- @args - a table of arguments passed by the user
-- @env - environment table containing title objects, etc., generated with p.getEnvironment
-- @links - a string containing the [view][edit][history][purge] links - could be nil if there's an error.
--
-- Messages:
-- 'documentation-icon-wikitext' --> '[[File:Test Template Info-Icon - Version (2).svg|50px|link=|alt=Documentation icon]]'
-- 'template-namespace-heading' --> 'Template documentation'
-- 'module-namespace-heading' --> 'Module documentation'
-- 'file-namespace-heading' --> 'Summary'
-- 'other-namespaces-heading' --> 'Documentation'
-- 'start-box-linkclasses' --> 'mw-editsection-like plainlinks'
-- 'start-box-link-id' --> 'doc_editlinks'
-- 'testcases-create-link-display' --> 'create'
--]=]
local subjectSpace = env.subjectSpace
if not subjectSpace then
-- Default to an "other namespaces" namespace, so that we get at least some output
-- if an error occurs.
subjectSpace = 2
end
local data = {}

-- Heading
local heading = args.heading -- Blank values are not removed.
if heading == '' then
-- Don't display the start box if the heading arg is defined but blank.
return nil
end
if heading then
data.heading = heading
elseif subjectSpace == 10 then -- Template namespace
data.heading = i18n['template-namespace-heading']
elseif subjectSpace == 828 then -- Module namespace
data.heading = i18n['module-namespace-heading']
elseif subjectSpace == 6 then -- File namespace
data.heading = i18n['file-namespace-heading']
else
data.heading = i18n['other-namespaces-heading']
end

-- Data for the [view][edit][history][purge] or [create] links.
if links then
data.linksClass = message('start-box-linkclasses')
data.linksId = message('start-box-link-id')
data.links = links
end

return data
end

function p.renderStartBox(data)
-- Renders the start box html.
-- @data - a table of data generated by p.makeStartBoxData.
local sbox = mw.html.create('div')
sbox
:addClass(message('header-div-class'))
:tag('div')
:addClass(message('heading-div-class'))
:wikitext(data.heading)
local links = data.links
if links then
sbox
:tag('div')
:addClass(data.linksClass)
:attr('id', data.linksId)
:wikitext(links)
end
return tostring(sbox)
end

----------------------------------------------------------------------------
-- Documentation content
----------------------------------------------------------------------------

p.content = makeInvokeFunc('_content')

function p._content(args, env)
-- Displays the documentation contents
-- @args - a table of arguments passed by the user
-- @env - environment table containing title objects, etc., generated with p.getEnvironment
env = env or p.getEnvironment(args)
local docTitle = env.docTitle
local content = args.content
if not content and docTitle and docTitle.exists then
content = args._content or mw.getCurrentFrame():expandTemplate{title = docTitle}
end
-- The line breaks below are necessary so that "=== Headings ===" at the start and end
-- of docs are interpreted correctly.
local cbox = mw.html.create('div')
cbox
:addClass(message('content-div-class'))
:wikitext('\n' .. (content or '') .. '\n')
return tostring(cbox)
end

p.contentTitle = makeInvokeFunc('_contentTitle')

function p._contentTitle(args, env)
env = env or p.getEnvironment(args)
local docTitle = env.docTitle
if not args.content and docTitle and docTitle.exists then
return docTitle.prefixedText
else
return ''
end
end

----------------------------------------------------------------------------
-- End box
----------------------------------------------------------------------------

p.endBox = makeInvokeFunc('_endBox')

function p._endBox(args, env)
--[=[
-- This function generates the end box (also known as the link box).
-- @args - a table of arguments passed by the user
-- @env - environment table containing title objects, etc., generated with p.getEnvironment
--]=]

-- Get environment data.
env = env or p.getEnvironment(args)
local subjectSpace = env.subjectSpace
local docTitle = env.docTitle
if not subjectSpace or not docTitle then
return nil
end

-- Check whether we should output the end box at all. Add the end
-- box by default if the documentation exists or if we are in the
-- user, module or template namespaces.
local linkBox = args['link box']
if linkBox == 'off'
or not (
docTitle.exists
or subjectSpace == 2
or subjectSpace == 828
or subjectSpace == 10
)
then
return nil
end

-- Assemble the footer text field.
local text = ''
if linkBox then
text = text .. linkBox
else
text = text .. (p.makeDocPageBlurb(args, env) or '') -- "This documentation is transcluded from [[Foo]]."
if subjectSpace == 2 or subjectSpace == 10 or subjectSpace == 828 then
-- We are in the user, template or module namespaces.
-- Add sandbox and testcases links.
-- "Editors can experiment in this template's sandbox and testcases pages."
text = text .. (p.makeExperimentBlurb(args, env) or '')
text = text .. ' '
if not args.content and not args[1] then
-- "Please add categories to the /doc subpage."
-- Don't show this message with inline docs or with an explicitly specified doc page,
-- as then it is unclear where to add the categories.
text = text .. (p.makeCategoriesBlurb(args, env) or '')
end
text = text .. ' ' .. (p.makeSubpagesBlurb(args, env) or '') --"Subpages of this template"
local printBlurb = p.makePrintBlurb(args, env) -- Two-line blurb about print versions of templates.
if printBlurb then
text = text .. ' ' .. printBlurb
end
end
end

local ebox = mw.html.create('div')
ebox
:addClass(message('footer-div-class'))
:wikitext(text)
return tostring(ebox)
end

function p.makeDocPageBlurb(args, env)
--[=[
-- Makes the blurb "This documentation is transcluded from [[Template:Foo]] (edit, history)".
-- @args - a table of arguments passed by the user
-- @env - environment table containing title objects, etc., generated with p.getEnvironment
--
-- Messages:
-- 'edit-link-display' --> 'edit'
-- 'history-link-display' --> 'history'
-- 'transcluded-from-blurb' -->
-- 'The above [[w:Wikipedia:Template documentation|documentation]]
-- is [[w:Wikipedia:Transclusion|transcluded]] from $1.'
-- 'module-preload' --> 'Template:Documentation/preload-module-doc'
-- 'create-link-display' --> 'create'
-- 'create-module-doc-blurb' -->
-- 'You might want to $1 a documentation page for this [[w:Wikipedia:Lua|Scribunto module]].'
--]=]
local docTitle = env.docTitle
if not docTitle or args.content then
return nil
end
local ret
if docTitle.exists then
-- /doc exists; link to it.
local docLink = makeWikilink(docTitle.prefixedText)
local editUrl = docTitle:fullUrl{action = 'edit'}
local editDisplay = i18n['edit-link-display']
local editLink = makeUrlLink(editUrl, editDisplay)
local historyUrl = docTitle:fullUrl{action = 'history'}
local historyDisplay = i18n['history-link-display']
local historyLink = makeUrlLink(historyUrl, historyDisplay)
ret = message('transcluded-from-blurb', {docLink})
.. ' '
.. makeToolbar(editLink, historyLink)
.. ' '
elseif env.subjectSpace == 828 then
-- /doc does not exist; ask to create it.
local createUrl = docTitle:fullUrl{action = 'edit', preload = message('module-preload')}
local createDisplay = i18n['create-link-display']
local createLink = makeUrlLink(createUrl, createDisplay)
ret = message('create-module-doc-blurb', {createLink})
.. ' '
end
return ret
end

function p.makeExperimentBlurb(args, env)
--[[
-- Renders the text "Editors can experiment in this template's sandbox (edit | diff) and testcases (edit) pages."
-- @args - a table of arguments passed by the user
-- @env - environment table containing title objects, etc., generated with p.getEnvironment
--
-- Messages:
-- 'sandbox-link-display' --> 'sandbox'
-- 'sandbox-edit-link-display' --> 'edit'
-- 'compare-link-display' --> 'diff'
-- 'module-sandbox-preload' --> 'Template:Documentation/preload-module-sandbox'
-- 'template-sandbox-preload' --> 'Template:Documentation/preload-sandbox'
-- 'sandbox-create-link-display' --> 'create'
-- 'mirror-edit-summary' --> 'Create sandbox version of $1'
-- 'mirror-link-display' --> 'mirror'
-- 'mirror-link-preload' --> 'Template:Documentation/mirror'
-- 'sandbox-link-display' --> 'sandbox'
-- 'testcases-link-display' --> 'testcases'
-- 'testcases-edit-link-display'--> 'edit'
-- 'template-sandbox-preload' --> 'Template:Documentation/preload-sandbox'
-- 'testcases-create-link-display' --> 'create'
-- 'testcases-link-display' --> 'testcases'
-- 'testcases-edit-link-display' --> 'edit'
-- 'module-testcases-preload' --> 'Template:Documentation/preload-module-testcases'
-- 'template-testcases-preload' --> 'Template:Documentation/preload-testcases'
-- 'experiment-blurb-module' --> 'Editors can experiment in this module's $1 and $2 pages.'
-- 'experiment-blurb-template' --> 'Editors can experiment in this template's $1 and $2 pages.'
--]]
local subjectSpace = env.subjectSpace
local templateTitle = env.templateTitle
local sandboxTitle = env.sandboxTitle
local testcasesTitle = env.testcasesTitle
local templatePage = templateTitle.prefixedText
if not subjectSpace or not templateTitle or not sandboxTitle or not testcasesTitle then
return nil
end
-- Make links.
local sandboxLinks, testcasesLinks
if sandboxTitle.exists then
local sandboxPage = sandboxTitle.prefixedText
local sandboxDisplay = message('sandbox-link-display')
local sandboxLink = makeWikilink(sandboxPage, sandboxDisplay)
local sandboxEditUrl = sandboxTitle:fullUrl{action = 'edit'}
local sandboxEditDisplay = message('sandbox-edit-link-display')
local sandboxEditLink = makeUrlLink(sandboxEditUrl, sandboxEditDisplay)
local compareUrl = env.compareUrl
local compareLink
if compareUrl then
local compareDisplay = message('compare-link-display')
compareLink = makeUrlLink(compareUrl, compareDisplay)
end
sandboxLinks = sandboxLink .. ' ' .. makeToolbar(sandboxEditLink, compareLink)
else
local sandboxPreload
if subjectSpace == 828 then
sandboxPreload = message('module-sandbox-preload')
else
sandboxPreload = message('template-sandbox-preload')
end
local sandboxCreateUrl = sandboxTitle:fullUrl{action = 'edit', preload = sandboxPreload}
local sandboxCreateDisplay = message('sandbox-create-link-display')
local sandboxCreateLink = makeUrlLink(sandboxCreateUrl, sandboxCreateDisplay)
local mirrorSummary = message('mirror-edit-summary', {makeWikilink(templatePage)})
local mirrorPreload = message('mirror-link-preload')
local mirrorUrl = sandboxTitle:fullUrl{action = 'edit', preload = mirrorPreload, summary = mirrorSummary}
local mirrorDisplay = message('mirror-link-display')
local mirrorLink = makeUrlLink(mirrorUrl, mirrorDisplay)
sandboxLinks = message('sandbox-link-display') .. ' ' .. makeToolbar(sandboxCreateLink, mirrorLink)
end
if testcasesTitle.exists then
local testcasesPage = testcasesTitle.prefixedText
local testcasesDisplay = message('testcases-link-display')
local testcasesLink = makeWikilink(testcasesPage, testcasesDisplay)
local testcasesEditUrl = testcasesTitle:fullUrl{action = 'edit'}
local testcasesEditDisplay = message('testcases-edit-link-display')
local testcasesEditLink = makeUrlLink(testcasesEditUrl, testcasesEditDisplay)
testcasesLinks = testcasesLink .. ' ' .. makeToolbar(testcasesEditLink)
else
local testcasesPreload
if subjectSpace == 828 then
testcasesPreload = message('module-testcases-preload')
else
testcasesPreload = message('template-testcases-preload')
end
local testcasesCreateUrl = testcasesTitle:fullUrl{action = 'edit', preload = testcasesPreload}
local testcasesCreateDisplay = message('testcases-create-link-display')
local testcasesCreateLink = makeUrlLink(testcasesCreateUrl, testcasesCreateDisplay)
testcasesLinks = message('testcases-link-display') .. ' ' .. makeToolbar(testcasesCreateLink)
end
local messageName
if subjectSpace == 828 then
messageName = 'experiment-blurb-module'
else
messageName = 'experiment-blurb-template'
end
return message(messageName, {sandboxLinks, testcasesLinks})
end

function p.makeCategoriesBlurb(args, env)
--[[
-- Generates the text "Please add categories to the /doc subpage."
-- @args - a table of arguments passed by the user
-- @env - environment table containing title objects, etc., generated with p.getEnvironment
-- Messages:
-- 'doc-link-display' --> '/doc'
-- 'add-categories-blurb' --> 'Please add categories to the $1 subpage.'
--]]
local docTitle = env.docTitle
if not docTitle then
return nil
end
local docPathLink = makeWikilink(docTitle.prefixedText, message('doc-link-display'))
return message('add-categories-blurb', {docPathLink})
end

function p.makeSubpagesBlurb(args, env)
--[[
-- Generates the "Subpages of this template" link.
-- @args - a table of arguments passed by the user
-- @env - environment table containing title objects, etc., generated with p.getEnvironment

-- Messages:
-- 'template-pagetype' --> 'template'
-- 'module-pagetype' --> 'module'
-- 'default-pagetype' --> 'page'
-- 'subpages-link-display' --> 'Subpages of this $1'
--]]
local subjectSpace = env.subjectSpace
local templateTitle = env.templateTitle
if not subjectSpace or not templateTitle then
return nil
end
local pagetype
if subjectSpace == 10 then
pagetype = message('template-pagetype')
elseif subjectSpace == 828 then
pagetype = message('module-pagetype')
else
pagetype = message('default-pagetype')
end
local subpagesLink = makeWikilink(
'Special:PrefixIndex/' .. templateTitle.prefixedText .. '/',
message('subpages-link-display', {pagetype})
)
return message('subpages-blurb', {subpagesLink})
end

function p.makePrintBlurb(args, env)
--[=[
-- Generates the blurb displayed when there is a print version of the template available.
-- @args - a table of arguments passed by the user
-- @env - environment table containing title objects, etc., generated with p.getEnvironment
--
-- Messages:
-- 'print-link-display' --> '/Print'
-- 'print-blurb' --> 'A [[Help:Books/for experts#Improving the book layout|print version]]'
-- .. ' of this template exists at $1.'
-- .. ' If you make a change to this template, please update the print version as well.'
-- 'display-print-category' --> true
-- 'print-category' --> 'Templates with print versions'
--]=]
local printTitle = env.printTitle
if not printTitle then
return nil
end
local ret
if printTitle.exists then
local printLink = makeWikilink(printTitle.prefixedText, message('print-link-display'))
ret = message('print-blurb', {printLink})
local displayPrintCategory = message('display-print-category', nil, 'boolean')
if displayPrintCategory then
ret = ret .. makeCategoryLink(message('print-category'))
end
end
return ret
end

----------------------------------------------------------------------------
-- Tracking categories
----------------------------------------------------------------------------

function p.addTrackingCategories(env)
--[[
-- Check if {{documentation}} is transcluded on a /doc or /testcases page.
-- @env - environment table containing title objects, etc., generated with p.getEnvironment

-- Messages:
-- 'display-strange-usage-category' --> true
-- 'doc-subpage' --> 'doc'
-- 'testcases-subpage' --> 'testcases'
-- 'strange-usage-category' --> 'Wikipedia pages with strange ((documentation)) usage'
--
-- /testcases pages in the module namespace are not categorised, as they may have
-- {{documentation}} transcluded automatically.
--]]
local title = env.title
local subjectSpace = env.subjectSpace
if not title or not subjectSpace then
return nil
end
local subpage = title.subpageText
local ret = ''
if message('display-strange-usage-category', nil, 'boolean')
and (
subpage == message('doc-subpage')
or subjectSpace ~= 828 and subpage == message('testcases-subpage')
)
then
ret = ret .. makeCategoryLink(message('strange-usage-category'))
end
return ret
end

return p

2024-04-24T23:23:12Z

Raccoondad: 1 revision imported

-- This module provides easy processing of arguments passed to Scribunto from
-- #invoke. It is intended for use by other Lua modules, and should not be
-- called from #invoke directly.

local libraryUtil = require('libraryUtil')
local checkType = libraryUtil.checkType

local arguments = {}

-- Generate four different tidyVal functions, so that we don't have to check the
-- options every time we call it.

local function tidyValDefault(key, val)
if type(val) == 'string' then
val = val:match('^%s*(.-)%s*$')
if val == '' then
return nil
else
return val
end
else
return val
end
end

local function tidyValTrimOnly(key, val)
if type(val) == 'string' then
return val:match('^%s*(.-)%s*$')
else
return val
end
end

local function tidyValRemoveBlanksOnly(key, val)
if type(val) == 'string' then
if val:find('%S') then
return val
else
return nil
end
else
return val
end
end

local function tidyValNoChange(key, val)
return val
end

local function matchesTitle(given, title)
local tp = type( given )
return (tp == 'string' or tp == 'number') and mw.title.new( given ).prefixedText == title
end

local translate_mt = { __index = function(t, k) return k end }

function arguments.getArgs(frame, options)
checkType('getArgs', 1, frame, 'table', true)
checkType('getArgs', 2, options, 'table', true)
frame = frame or {}
options = options or {}

--[[
-- Set up argument translation.
--]]
options.translate = options.translate or {}
if getmetatable(options.translate) == nil then
setmetatable(options.translate, translate_mt)
end
if options.backtranslate == nil then
options.backtranslate = {}
for k,v in pairs(options.translate) do
options.backtranslate[v] = k
end
end
if options.backtranslate and getmetatable(options.backtranslate) == nil then
setmetatable(options.backtranslate, {
__index = function(t, k)
if options.translate[k] ~= k then
return nil
else
return k
end
end
})
end

--[[
-- Get the argument tables. If we were passed a valid frame object, get the
-- frame arguments (fargs) and the parent frame arguments (pargs), depending
-- on the options set and on the parent frame's availability. If we weren't
-- passed a valid frame object, we are being called from another Lua module
-- or from the debug console, so assume that we were passed a table of args
-- directly, and assign it to a new variable (luaArgs).
--]]
local fargs, pargs, luaArgs
if type(frame.args) == 'table' and type(frame.getParent) == 'function' then
if options.wrappers then
--[[
-- The wrappers option makes Module:Arguments look up arguments in
-- either the frame argument table or the parent argument table, but
-- not both. This means that users can use either the #invoke syntax
-- or a wrapper template without the loss of performance associated
-- with looking arguments up in both the frame and the parent frame.
-- Module:Arguments will look up arguments in the parent frame
-- if it finds the parent frame's title in options.wrapper;
-- otherwise it will look up arguments in the frame object passed
-- to getArgs.
--]]
local parent = frame:getParent()
if not parent then
fargs = frame.args
else
local title = parent:getTitle():gsub('/sandbox$', '')
local found = false
if matchesTitle(options.wrappers, title) then
found = true
elseif type(options.wrappers) == 'table' then
for _,v in pairs(options.wrappers) do
if matchesTitle(v, title) then
found = true
break
end
end
end

-- We test for false specifically here so that nil (the default) acts like true.
if found or options.frameOnly == false then
pargs = parent.args
end
if not found or options.parentOnly == false then
fargs = frame.args
end
end
else
-- options.wrapper isn't set, so check the other options.
if not options.parentOnly then
fargs = frame.args
end
if not options.frameOnly then
local parent = frame:getParent()
pargs = parent and parent.args or nil
end
end
if options.parentFirst then
fargs, pargs = pargs, fargs
end
else
luaArgs = frame
end

-- Set the order of precedence of the argument tables. If the variables are
-- nil, nothing will be added to the table, which is how we avoid clashes
-- between the frame/parent args and the Lua args.
local argTables = {fargs}
argTables[#argTables + 1] = pargs
argTables[#argTables + 1] = luaArgs

--[[
-- Generate the tidyVal function. If it has been specified by the user, we
-- use that; if not, we choose one of four functions depending on the
-- options chosen. This is so that we don't have to call the options table
-- every time the function is called.
--]]
local tidyVal = options.valueFunc
if tidyVal then
if type(tidyVal) ~= 'function' then
error(
"bad value assigned to option 'valueFunc'"
.. '(function expected, got '
.. type(tidyVal)
.. ')',
2
)
end
elseif options.trim ~= false then
if options.removeBlanks ~= false then
tidyVal = tidyValDefault
else
tidyVal = tidyValTrimOnly
end
else
if options.removeBlanks ~= false then
tidyVal = tidyValRemoveBlanksOnly
else
tidyVal = tidyValNoChange
end
end

--[[
-- Set up the args, metaArgs and nilArgs tables. args will be the one
-- accessed from functions, and metaArgs will hold the actual arguments. Nil
-- arguments are memoized in nilArgs, and the metatable connects all of them
-- together.
--]]
local args, metaArgs, nilArgs, metatable = {}, {}, {}, {}
setmetatable(args, metatable)

local function mergeArgs(tables)
--[[
-- Accepts multiple tables as input and merges their keys and values
-- into one table. If a value is already present it is not overwritten;
-- tables listed earlier have precedence. We are also memoizing nil
-- values, which can be overwritten if they are 's' (soft).
--]]
for _, t in ipairs(tables) do
for key, val in pairs(t) do
if metaArgs[key] == nil and nilArgs[key] ~= 'h' then
local tidiedVal = tidyVal(key, val)
if tidiedVal == nil then
nilArgs[key] = 's'
else
metaArgs[key] = tidiedVal
end
end
end
end
end

--[[
-- Define metatable behaviour. Arguments are memoized in the metaArgs table,
-- and are only fetched from the argument tables once. Fetching arguments
-- from the argument tables is the most resource-intensive step in this
-- module, so we try and avoid it where possible. For this reason, nil
-- arguments are also memoized, in the nilArgs table. Also, we keep a record
-- in the metatable of when pairs and ipairs have been called, so we do not
-- run pairs and ipairs on the argument tables more than once. We also do
-- not run ipairs on fargs and pargs if pairs has already been run, as all
-- the arguments will already have been copied over.
--]]

metatable.__index = function (t, key)
--[[
-- Fetches an argument when the args table is indexed. First we check
-- to see if the value is memoized, and if not we try and fetch it from
-- the argument tables. When we check memoization, we need to check
-- metaArgs before nilArgs, as both can be non-nil at the same time.
-- If the argument is not present in metaArgs, we also check whether
-- pairs has been run yet. If pairs has already been run, we return nil.
-- This is because all the arguments will have already been copied into
-- metaArgs by the mergeArgs function, meaning that any other arguments
-- must be nil.
--]]
if type(key) == 'string' then
key = options.translate[key]
end
local val = metaArgs[key]
if val ~= nil then
return val
elseif metatable.donePairs or nilArgs[key] then
return nil
end
for _, argTable in ipairs(argTables) do
local argTableVal = tidyVal(key, argTable[key])
if argTableVal ~= nil then
metaArgs[key] = argTableVal
return argTableVal
end
end
nilArgs[key] = 'h'
return nil
end

metatable.__newindex = function (t, key, val)
-- This function is called when a module tries to add a new value to the
-- args table, or tries to change an existing value.
if type(key) == 'string' then
key = options.translate[key]
end
if options.readOnly then
error(
'could not write to argument table key "'
.. tostring(key)
.. '"; the table is read-only',
2
)
elseif options.noOverwrite and args[key] ~= nil then
error(
'could not write to argument table key "'
.. tostring(key)
.. '"; overwriting existing arguments is not permitted',
2
)
elseif val == nil then
--[[
-- If the argument is to be overwritten with nil, we need to erase
-- the value in metaArgs, so that __index, __pairs and __ipairs do
-- not use a previous existing value, if present; and we also need
-- to memoize the nil in nilArgs, so that the value isn't looked
-- up in the argument tables if it is accessed again.
--]]
metaArgs[key] = nil
nilArgs[key] = 'h'
else
metaArgs[key] = val
end
end

local function translatenext(invariant)
local k, v = next(invariant.t, invariant.k)
invariant.k = k
if k == nil then
return nil
elseif type(k) ~= 'string' or not options.backtranslate then
return k, v
else
local backtranslate = options.backtranslate[k]
if backtranslate == nil then
-- Skip this one. This is a tail call, so this won't cause stack overflow
return translatenext(invariant)
else
return backtranslate, v
end
end
end

metatable.__pairs = function ()
-- Called when pairs is run on the args table.
if not metatable.donePairs then
mergeArgs(argTables)
metatable.donePairs = true
end
return translatenext, { t = metaArgs }
end

local function inext(t, i)
-- This uses our __index metamethod
local v = t[i + 1]
if v ~= nil then
return i + 1, v
end
end

metatable.__ipairs = function (t)
-- Called when ipairs is run on the args table.
return inext, t, 0
end

return args
end

return arguments